APEX

Apex Distributors and Solution Providers can integrate their proprietary sales platforms with AT&T through the Ordering APIs.

These APIs support near real-time data exchange, helping improve efficiency for quotes, contracts, and complex orders, including multi-site and multi-product requests. As additional products are enabled through these APIs, partners can further enhance their sales tools and reduce the overall cost of doing business with AT&T.

The Ordering APIs streamline key stages of the sales lifecycle by automating functions such as:

• Quote Creation
• Credit Check
• Contract Creation
• Order Creation and Enrichment
• End Customer Lookup
• Order Handoff / Submission

ADI is currently the supported product for Ordering APIs.

This diagram goes over the cycle for APEX Ordering APIs.

Create Quote

The Create Quote API is the first step in the Ordering API workflow. It enables Solution Providers (SPs) to create both an Opportunity and a Quote. These identifiers serve as the foundational references for subsequent stages of the ordering process.

An Opportunity ID is generated when an SP identifies a potential engagement with an end customer. A Quote ID captures a specific product configuration, including pricing components such as access, port, installation, discount ranges, and promotions. This helps ensure alignment on products, pricing, discounts, and promotional terms.

Additional configuration details may also be captured, including product options, access and port speeds, billing preferences, site information, and other parameters required for downstream processing.

Credit Check

About the API:
This step enables the Solution Provider (SP) to confirm the end customer’s eligibility for credit approval.

Credit approval is a critical prerequisite for progressing through the ordering workflow. The credit check is performed only after the Quote ID has been validated and AVPS (Address Validation of Postal Service) validation has been successfully completed.

Contract

About the API:
The Contract Creation step formalizes the agreement between AT&T and the end customer. During this phase, key information such as customer details, contact information, contract effective date, and contract term is captured and incorporated into the contract.

All prerequisites, including successful credit approval, must be completed before contract creation can begin. Creating the contract at this stage helps ensure consistency between the agreed quote and the contractual terms.

Once the contract is electronically signed (eSigned), it becomes legally binding. After execution, changes to the associated quote are restricted to preserve consistency and stability throughout the contractual relationship.

Order Creation & Enrichment

About the API:
This API enables Solution Providers (SPs) to create new orders and enrich existing orders.

The order enrichment process captures fulfillment-related details, including:

1. Installation enrichment
   Additional installation details such as installation contact information, customer-requested start date, customer-requested due date, and premise notes.
2. Shipping address enrichment
   Shipping details such as email addresses, physical addresses, and related shipping notes.
3. Port reservation
   Port reservation information including the suborder ID, required RDS fields such as floor and room, and applicable codes such as the TSP code.
4. Product billing configuration enrichment
   Optional billing inputs for Quote IDs, ordered items, suborders, and invoice numbers.

Together, these enrichments help support a smoother and more efficient order fulfillment process.

End Customer Lookup

About the API:
During the End Customer Lookup stage, the API retrieves and updates end-customer information as needed using the details captured in the associated Opportunity and Quote.

Order Handoff

About the API:
During this stage, the Solution Provider (SP) submits the order. This action confirms and completes the order created during the order enrichment stage.

All applicable information, including the parent order, sub-orders, and installation details, is reviewed and finalized. Upon submission, the SP receives an acknowledgment confirming that the order has been successfully submitted.