AT&T DevEx

Omni APIs Central | Wireless Solutions | Add a Line | Digital PoS

Direct Fulfillment without Autopay Enrollment

Complete Package

1

Spec

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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
{
  "openapi": "3.0.0",
  "info": {
    "title": "API Specification",
    "version": "1.0.0"
  },
   "servers": [
    {
      "url": "https://eidp-test.att.com/msapi/order"
    }
  ],
  "tags": [
    {
      "name": "customer-order-management",
      "description": "Customer Order Management "
    }
  ],
  "paths": {
    "/v1/auth-methods": {
      "get": {
        "summary": "Get authentication methods",
        "responses": {
          "200": {
            "description": "Successful response"
          }
        }
      }
    },
    "/v1/auth/generateotp": {
      "post": {
        "summary": "Generate OTP",
        "responses": {
          "200": {
            "description": "OTP generated"
          }
        }
      }
    },
    "/v1/auth": {
      "post": {
        "summary": "Authenticate user",
        "responses": {
          "200": {
            "description": "Authentication successful"
          }
        }
      }
    },
    "/v1/customers": {
      "get": {
        "summary": "Lookup customer accounts",
        "responses": {
          "200": {
            "description": "Customer data retrieved"
          }
        }
      }
    },
    "/v1/offers": {
      "get": {
        "summary": "Get product offers",
        "responses": {
          "200": {
            "description": "Offers retrieved"
          }
        }
      }
    },
    "/v1/order/create": {
      "post": {
        "summary": "Create shopping cart order",
        "responses": {
          "200": {
            "description": "Order created"
          }
        }
      }
    },
    "/v1/order/{id}/credit.submit": {
      "post": {
        "summary": "Submit credit application",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Order ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Credit submitted"
          }
        }
      }
    },
    "/v1/order/{id}/credit.policy": {
      "get": {
        "summary": "Get credit policy",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Order ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Credit policy retrieved"
          }
        }
      }
    },
    "/v1/order/{id}/fulfillment": {
      "post": {
        "summary": "Create fulfillment",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Order ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Fulfillment created"
          }
        }
      },
      "patch": {
        "summary": "Update fulfillment",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Order ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Fulfillment updated"
          }
        }
      }
    },
    "/v1/order/{id}/number.available": {
      "post": {
        "summary": "Check number availability",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Order ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Number availability checked"
          }
        }
      }
    },
    "/v1/order/{id}/number.reserve": {
      "patch": {
        "summary": "Reserve number",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Order ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Number reserved"
          }
        }
      }
    },
    "/V1/order/{id}/validate": {
      "get": {
        "summary": "Validate order",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Order ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Order validated"
          }
        }
      }
    },
    "/v1/order/submit": {
      "post": {
        "summary": "Submit order",
        "responses": {
          "200": {
            "description": "Order submitted"
          }
        }
      }
    }
  }
}

Call Sequence

1

Authentication

This step handles user identity verification and access control. It includes:

  • GET /v1/auth-methods: Retrieves the available authentication methods (e.g., OTP, password, biometric).
  • POST /v1/auth/generateotp: Initiates the OTP generation process for user verification.
  • POST /v1/auth: Authenticates the user using credentials or OTP, establishing a session or issuing a token.
2

Account Lookup

This step is used to retrieve customer account information.

  • GET /v1/customers: Looks up customer details based on identifiers such as phone number, email, or customer ID.
3

Product and Offers

This step provides available products and promotional offers.

  • GET /v1/offers: Fetches a list of current offers and product bundles available to the customer.
4

Shopping Cart

This step initiates the order creation process.

  • POST /v1/order/create: Creates a new order instance, initializing the shopping cart with selected products or services.
5

Credit

This step manages credit checks and policy retrieval.

  • POST /v1/order/{id}/credit.submit: Submits customer information for credit evaluation.
  • GET /v1/order/{id}/credit.policy: Retrieves the credit policy applicable to the order.
6

Fulfillment

This step handles the logistics and delivery setup.

  • POST /v1/order/{id}/fulfillment: Initiates the fulfillment process for the order.
  • PATCH /v1/order/{id}/fulfillment: Updates fulfillment details such as delivery address or schedule.
7

Number Selection

This step allows customers to choose or reserve a phone number.

  • POST /v1/order/{id}/number.available: Checks the availability of a requested number.
  • PATCH /v1/order/{id}/number.reserve: Reserves a selected number for the order.
8

Terms and Conditions

This step ensures that the customer agrees to the necessary legal terms.

  • POST /v1/order/{id}/fulfillment and PATCH /v1/order/{id}/fulfillment: These endpoints may also be used to capture or update agreement to terms and conditions during the fulfillment process.

9

Order Processing

This final step validates and submits the order.

  • GET /V1/order/{id}/validate: Performs validation checks on the order before submission.
  • POST /v1/order/submit: Finalizes and submits the order for processing.