Order Status Summary
In this phase, the Solution Provider (SP) queries the order status details through the API.
This allows them to view the current status of an order, along with all relevant information such as channel and product details. The response also provides options to filter orders by ID and type.
The goal is to provide Distributors with a dedicated API endpoint to easily check the status of their order submissions.
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.
Endpoints and Headers
GET API Endpoints
Environment | Base URI |
UAT | https://uat-att-order-status-eapi.nprd-gw.cloud.att.com/api/v1/orders |
Production | https://att-order-status-eapi.gw.cloud.att.com/api/v1/orders |
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 that you pass the unique client header per Solution Provider.
API Headers
The following are the fields in the request headers of Contract API.
Field Name | Field Description | Mandatory/Optional |
content-type | Application/json | M |
accept | Specifies the format of the response message body. Structured text message payloads are required to support application/json. No other format is permitted. As they are the only supported format, the accept header is not relevant for those requests. | O |
x-trace-id | This field is used for passing a trace ID between API hops for end-to-end traceability. | M |
x-transaction-id | This field is used for passing a traceable Id to uniquely identify the transactions. | O |
client_id | This field represents the client id. | M |
client_secret | This field represents the client secret. | M |
source | This field should identify the calling system/application. | O |