Order Enrichment Status
Version v1
Endpoint
GET
Contact DL-APS_API_Services@att.com to get Endpoint details /order-enrichment/order-enrichment-status
Copy
This API allows users to retrieve the status of enrichment for an Apex ADI product.
Query Parameters
- subOrderIdstringRequiredUnique identifier for the sub-order.Example: 801dx00000Z8bayAAB
Header Parameters
- acceptstringSpecifies the format of the response message body. Structured text message payloads are required to support application/json.Example: application/json
- x-trace-idstringRequiredThis field is used for passing a trace ID between API hops for end-to-end traceability.Example: givingXTracing123456
- x-transaction-idstringThis field is used for passing a traceable Id to uniquely identify the transactions.Example: 1234
- client_idstringRequiredThis field represents the client id.
- client_secretstringRequiredThis field represents the client secret.
- sourcestringThis field should identify the calling system/application.
Body Parameters
Responses
Your request was processed successfully
Body
application/json
- objectRequired
- IdstringUnique identifier of the enrichment record.Example: 802dx00000IfgCTAAZ
- CreatedDatestringCreated date of the enrichment record.Example: 2026-03-05T09:04:51.000+0000
- Product2stringProduct identifier or label.Example: Product2
- Product2.NamestringProduct name.Example: Port
- Port SpeedstringPort speed value.Example: 10 Gbps