Apex Ordering API Overview
Section 1 – Ordering API
Apex Distributors and Solution Providers now have the opportunity to integrate their proprietary sales platforms with AT&T through Ordering APIs.
These APIs support near real-time data exchange, improving efficiency in processing quotes, contracts, and complex orders (including multi-site and multi-product requests). As AT&T continues to enable additional products through these APIs, partners can further enhance their sales tools and reduce the overall cost of doing business with AT&T.
The APIs streamline key stages of the sales lifecycle by automating tasks such as Quote Creation, Credit Checks, Contract Creation, Order Enrichment, End Customer Lookup and Order Submission. Once integrated, partners can digitally qualify, price, contract, and submit orders directly from their own platforms.
Below is the list of products currently supported through Ordering APIs:
Product Name |
ADI |
Ordering API Flow
Quote
About the API:
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 unique identifiers act as foundational references, supporting subsequent stages of the Ordering API process.
An Opportunity ID is generated when an SP identifies a potential engagement with an end customer. By associating a Quote ID with a specific product configuration—including pricing components such as Access, Port, Installation, discount ranges, and available promotions—SPs can capture the commercial terms agreed upon during discussions. This helps ensure both parties remain aligned on products, pricing, promotions, and discounts.
Additional configuration details (such as product options, access and port speeds, billing preferences, site information, and other parameters) are also captured to support accurate processing and seamless execution.
Credit Check
About the API:
This step enables the AT&T to confirm the end customer’s eligibility for credit approval. Credit Check approval is a critical prerequisite for progressing in the ordering workflow. The credit check is initiated only after the Quote ID has been validated
Contract
About the API:
The Contract Creation step formalizes the agreement between the AT&T and the end customer. During this phase, key information—such as customer details, end-customer contact information, the contract effective date, and the contract term—is captured and incorporated into the contract.
All prerequisites, including successful credit approval, must be satisfied before contract creation can begin. Creating the contract at this stage helps ensure the contract terms remain consistent with the agreed-upon quote.
Once the contract is electronically signed (eSigned), it becomes legally binding. After execution, changes to the associated quote are restricted to maintain consistency, stability, and clarity 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:
- Installation enrichment: Collects additional installation information, such as installation contact details, customer-requested start date, customer-requested due date, and premise notes.
- Shipping address enrichment: Captures and refines shipping details, including email addresses, physical addresses, and any relevant shipping notes associated with shipping.
- Port reservation : Updates port reservation information, including the suborder ID and required RDS fields (e.g., floor, room) as well as applicable codes such as the TSP code.
- Product billing configuration enrichment: Includes optional billing inputs for Quote IDs, ordered items, suborders, and invoice numbers.
Collectively, these enrichments help ensure 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.
Endpoints
Create Quote API Endpoints
Contract API Endpoints
Environment | Base URI |
UAT | https://uat-att-contract-eapi.nprd-gw.cloud.att.com/api/v1/contract-apex |
Production | https://att-contract-eapi.gw.cloud.att.com/api/v1/contract-apex |
Credit Check API Endpoints
Environment | Base URI |
UAT | https://uat-att-creditcheck-eapi.nprd-gw.cloud.att.com/api/v1/creditCheck-apex |
Order Enrichment API Endpoints
Environment | Base URI |
UAT | https://uat-att-order-eapi.nprd-gw.cloud.att.com/api/v1/order-apex |
Production |
End-Customer LookUp API Endpoint
Order Handoff API Endpoints
Environment | Base URI |
UAT | https://uat-att-order-handoff-eapi.nprd-gw.cloud.att.com/api/v1/order-apex |
Production | https://att-order-handoff-eapi.gw.cloud.att.com/api/v1/order-apex |
If you are a Connector—meaning you develop on behalf of multiple Solution Provider accounts to retrieve information for them, you will use the same URL, and ensure you include the unique client header for each Solution Provider.
Security
This RESTful service uses a client id enforcement policy as the authentication mechanism. Please work with the Client On-Boarding Team if you do not have the necessary credentials.
ATT Developer Experience
To learn and explore these APIs further, visit AT&T Developer Experience Portal