Order Status
Version v1
Endpoint
GET
https://att-order-status-eapi.gw.cloud.att.com/api/v1/orders
Copy
The purpose of this API endpoint is to fetch an order status for the submitted order.
Query Parameters
- externalIdentifierIdstringRequiredThis represents the number associated with the order.
- externalIdentifierTypestringRequiredEnum: [UberCartId, MasterOrderNumber, UverseBillingAccountNumber, LsOmsOrderNumber, PurchaseOrderNumber, OrderNumber, UsrpOrderNumber, ServiceOrderNumber, ServiceAccessOrderNumber, ServiceGroup, CircuitId, SaartSubAccountId, UniversalBillingAccountNumber, LeeCircuitId, SalesViewId, ServiceMcmTriplet, SolutionId, GpmId, UsoNumber, ContractNumber]This represents the type of the order.
- businessAccountNamestringRequiredThis represents the business account name.
- offsetintSpecifies the starting point for pagination. For example, Offset = 20 skips the first 20 records and begins returning results from the 21st record.
- limitintSets the maximum number of records to return per request. For example, Limit = 10 returns 10 records starting from the specified offset.
Header Parameters
- sourcestringThis field should identify the calling system/application.
- x-transaction-idstringThis field is used for passing a traceable ID to uniquely identify the transactions. This field should ALWAYS be used within MuleSoft APIs.Example: 73c427a4-2482-4e64-8cac-ea4ace577871
- client_idstringRequiredExample: 7b404180fbb84b099179a4126a9576ff
- client_secretstringRequiredExample: e241f4aa3eca4b2a8FA67A2FEF5754F8
- x-trace-idstringRequiredThis field is used for passing a trace ID between API hops for end to end traceability. This field should ALWAYS be used within MuleSoft APIs.Example: a49fd114-c14b-11ea-b3de-0242ac130004
Body Parameters
Responses
Success
Body
application/json
- objectResponse payload for order status.
- statusintRequiredThis field represents the status code.Example: 200
- responseDataobjectRequiredThis field represents the details of order status.
- timestampstringRequiredThis represents the timestamp.Example: 2026-02-19T15:04:05Z