Installation Shipping Enrichment
Version v1
Endpoint
POST
Contact DL-APS_API_Services@att.com to get Endpoint details /order-enrichment/installation-shipping-apex
Copy
This API allows users to enrich order details related to installation and shipping.
Header Parameters
- content-typestringRequiredapplication/jsonExample: application/json
- 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
- object
- orderIdstringRequiredUnique identifier for the order.Example: 801dx00000YC2M8AAL
- subOrderIdstringRequiredUnique identifier for the sub-order.Example: 801dx00000YCwPmAAL
- premiseNotesstringNotes related to the premise.Example: Test
- customerRequestedStartDatestringRequiredRequested start date by the customer.Example: 2024-01-16T20:00:00.000+0000
- customerRequestedDueDatestringRequiredRequested due date by the customer.Example: 2024-06-30T19:00:00.000+0000
- startBillingBeforeReqDueDatestringRequiredIndicates if billing should start before the requested due date.Example: true
- contactsobjectRequired
Responses
Your request was processed successfully
Body
application/json
- objectRequired
- orderIdstringUnique identifier for the order.Example: 801dx00000Gd00lAAB
- subOrderIdstringUnique identifier for the sub-order.Example: 801dx00000Gd81K
- statusstringIndicates the outcome of the request.Example: Success
- statusMessagestringHuman-readable message describing the status of the request.Example: Order Contacts & Installation info is saved