AT&T DevEx

Omni APIs Central | Wireless Solutions | Add a Line | Customer Own Device

Version 1.0.0 (latest)

GraphQL API to Retrieve Order Information

Version 1.0.0
download iconDownload spec

Endpoint

POST
https://partner-omni-apis.att.com/omni-svcs/v1/orders/query

Retreive Order information based on order Filter

arrowRequest

description

Header Parameters

          Body Parameters

          Responses

          Successful response with individual data

          arrowBody

          application/json

          REQUEST

          1
2
3
4
5
6
7
8
9
10
11
12
13
          curl --request POST \
     --url https://partner-omni-apis.att.com/omni-svcs/v1/orders/query \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'idp-trace-id: string' \
     --header 'idpctx-session-id: string' \
     --header 'serviceType: string' \
     --header 'topics: string' \
     --data '
{
  "query": "{ getOrders(filter:{ orderId: \"56-813000062156271\", accountNumber: \"mobileOffer\",orderDate: \"2024-10-15\", lineOfBusiness: \"ws\", limit: 50, offset: 0}) {orders {id orderId parentOrderId orderDate canceledDate orderStatus{status} customer{ firstName } fulfillments{ fulfillmentStatus{status}} products{ productStatus {status} lines{lineType name} items{deviceDetails{model IMEI}}} accounts{ accountNumber } returnOrderDetails{commonOrderId } orderPrice{total} pointOfNoReturnDate orderErrorInfoList{ errorInfo } }pageInfo{totalCount pageSize pageNumber} } }"
}
'

          RESPONSE

          1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
          {
  "orderId": "25-754322252600371",
  "revision": "2",
  "orderDate": "2025-08-04T16:09:32.101Z",
  "fulfillments": [
    {
      "fulfillmentSequence": "1",
      "fulfillmentType": "DF",
      "productSequenceNumber": [
        "1"
      ],
      "fulfillmentStatus": {}
    }
  ],
  "customer": {
    "individualId": "ffb2fdc0-4a9c-41bb-a3be-2df46ee51f0d"
  },
  "products": [
    {
      "action": "add",
      "name": "Wireless",
      "lines": [
        {
          "characteristics": [
            {
              "name": "Number_Management_Resource_Identifier",
              "value": "019875c3-ce4f-7598-a768-a899548cd2f9",
              "id": "1"
            }
          ],
          "id": "f29de683-b93f-41a2-9120-d8e0c6552bc7",
          "services": [
            {
              "name": "AT&T Unlimited Level Up"
            }
          ]
        },
        {
          "characteristics": [
            {
              "name": "Number_Management_Resource_Identifier",
              "value": "019875c3-f4ca-78b3-b4a8-b8e8d30e8b3a",
              "id": "1"
            }
          ],
          "id": "ea42f182-4a23-4f78-9587-aef5118ae355",
          "services": [
            {
              "name": "AT&T Unlimited Level Up"
            }
          ]
        }
      ],
      "items": [
        {
          "id": "618d7f13-2189-4282-836e-a9218c8a4d88",
          "lineSequence": "1",
          "itemAction": "add",
          "alternateItemProductIds": [],
          "itemSequence": "1",
          "fulfillmentSequence": "1",
          "itemProductId": {
            "value": "6453E",
            "type": "sku"
          },
          "itemDescription": "Samsung Galaxy A15 5G -  AT&T PREPAID - 64GB - Blue Black",
          "itemType": "P",
          "productOrderItemRelationship": [
            {
              "id": "9699a170-f72c-4437-8d70-a45c240bb3d5"
            }
          ]
        },
        {
          "id": "304a2f0a-149f-4e71-ba55-9c6aa7ffff15",
          "lineSequence": "1",
          "itemAction": "add",
          "alternateItemProductIds": [],
          "itemSequence": "2",
          "fulfillmentSequence": "1",
          "itemProductId": {
            "value": "73023",
            "type": "sku"
          },
          "itemDescription": "AT&T PREPAID pSIM Card",
          "itemType": "S",
          "productOrderItemRelationship": [
            {
              "id": "9699a170-f72c-4437-8d70-a45c240bb3d5"
            }
          ]
        },
        {
          "id": "657e166c-2bdd-44b8-82b1-017fcb7e78ec",
          "lineSequence": "2",
          "itemAction": "add",
          "alternateItemProductIds": [],
          "itemSequence": "3",
          "fulfillmentSequence": "1",
          "itemProductId": {
            "value": "6453E",
            "type": "sku"
          },
          "itemDescription": "Samsung Galaxy A15 5G -  AT&T PREPAID - 64GB - Blue Black",
          "itemType": "P",
          "productOrderItemRelationship": [
            {
              "id": "9699a170-f72c-4437-8d70-a45c240bb3d5"
            }
          ]
        },
        {
          "id": "e12b9748-dca5-4eea-924b-e886b3fbbc58",
          "lineSequence": "2",
          "itemAction": "add",
          "alternateItemProductIds": [],
          "itemSequence": "4",
          "fulfillmentSequence": "1",
          "itemProductId": {
            "value": "73023",
            "type": "sku"
          },
          "itemDescription": "AT&T PREPAID pSIM Card",
          "itemType": "S",
          "productOrderItemRelationship": [
            {
              "id": "9699a170-f72c-4437-8d70-a45c240bb3d5"
            }
          ]
        },
        {
          "id": "9699a170-f72c-4437-8d70-a45c240bb3d5",
          "lineSequence": "1",
          "itemAction": "add",
          "alternateItemProductIds": [],
          "itemSequence": "5",
          "fulfillmentSequence": "1",
          "itemProductId": {
            "value": "RS3",
            "type": "sku"
          },
          "itemDescription": "Standard Shipping",
          "itemType": "D",
          "productOrderItemRelationship": [
            {
              "id": "e12b9748-dca5-4eea-924b-e886b3fbbc58"
            },
            {
              "id": "657e166c-2bdd-44b8-82b1-017fcb7e78ec"
            },
            {
              "id": "618d7f13-2189-4282-836e-a9218c8a4d88"
            },
            {
              "id": "304a2f0a-149f-4e71-ba55-9c6aa7ffff15"
            }
          ]
        }
      ]
    }
  ],
  "accounts": [
    {
      "accountNumber": "557966159397"
    }
  ],
  "orderPrice": {
    "total": 340.11
  }
}