AT&T DevEx

Job AID for DSL

AIA Add to Cart for DSL Customers with new Service Qualification API

1

Functional background

As part of the Fiberkit OMS Swimlane Info Retirement project, the new BSSE Service Qualification API, POST https://partner-saraplus.att.com/omni-svcs/v1/service-qualification, will be used for Fiber and AIA service qualification.

In accordance with AT&T CSO guidelines and the 2026 compliance mandate, unauthenticated service-qualification transactions must not return or relay personal information of any kind. Consequently, the new BSSE API will not return the billingAccountNumber currently provided by the existing IDP Service Qualification API.

This API contract change requires an update to A2C functionality for DSL customers who are migrating to, or purchasing, a new AIA service. A2C must no longer depend on the billing account number being returned by the service-qualification response or support relaying that information through an unauthenticated transaction. The affected customer journey and downstream processing have been redesigned to operate without the billing account number while remaining compliant with AT&T CSO guidelines and the 2026 compliance mandate.

2

Introduction

New BSSE Service Qualification API - POST https://partner-saraplus.att.com/omni-svcs/v1/service-qualification is expected to be used for Fiber and AIA qualification with the Go-Live of OMS Swimlane Info project. As per CSO guidelines the new API does not return personal information of any type for unauthenticated transaction. The service qualification API will not be returning the "billingAccountNumber" like existing IDP Service QualificationAPI POST - https://eidp.att.com/msapi/salesapi/sales-business-process-layer-papi/v2/query-service-qualification. This will need change in A2C functionality for DSL customers migrating / purchasing new AIA.

3

Existing Add to Cart with IDP Service Qualification

Existing IDP Service QualificationAPI returns the existing DSL service inventory with billing account number. Endpoint - POST https://eidp.att.com/msapi/salesapi/sales-business-process-layer-papi/v2/query-service-qualification

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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
{
  "addressValidation": {
    "validationResult": "success",
    "validGeographicAddress": {
      "id": "00000NFRTB2",
      "streetNr": "3802",
      "streetDirection": "EAST",
      "streetName": "MAIN",
      "streetType": "ST",
      "city": "CHULA VISTA",
      "stateOrProvince": "CA",
      "postcode": "91911",
      "postcodeExtension": "6247",
      "geographicSubAddress": {
        "subUnitType": "STE",
        "subUnitNumber": "1"
      }
    },
    "taxAreaDetails": [
      {
        "productFamily": "Broadband-AIA",
        "taxAreaId": "441130760"
      },
      {
        "productFamily": "Mobility-Postpaid",
        "taxAreaId": "441130761"
      }
    ]
  },
  "serviceQualification": [
    {
      "externalId": "INLAP~APSQ~00012",
      "queryServiceQualificationDate": "2021-09-16T15:35:09.574Z",
      "relatedParty": [
        {
          "id": "456",
          "href": "http://serverlocation:port/partyManagement/v4/party/456",
          "name": "John Smith",
          "role": "Buyer contact",
          "@type": "RelatedParty",
          "@referredType": "Individual"
        }
      ],
      "searchCriteria": {
        "service": {
          "place": [
            {
              "id": "00ADDRESSID01",
              "role": "Installation Place",
              "@type": "GeographicAddress",
              "state": "WA",
              "city": "Bothell",
              "zipCode": 98011
            }
          ],
          "serviceCharacteristic": [
            {
              "name": "NetworkProvider",
              "valueType": "string",
              "value": "FiberCo"
            },
            {
              "name": "DwellingType",
              "valueType": "string",
              "value": "SFU General"
            },
            {
              "name": "AbfQualificationStatus",
              "valueType": "string",
              "value": "LG"
            },
            {
              "name": "LastTransport",
              "valueType": "string",
              "value": "FTTP-EGPON"
            },
            {
              "name": "RateZoneBandCode",
              "valueType": "string",
              "value": "807"
            },
            {
              "name": "TitanExistingIndicator",
              "valueType": "boolean",
              "value": false
            },
            {
              "name": "TitanPendingOrder",
              "valueType": "boolean",
              "value": false
            }
          ]
        }
      },
      "serviceQualificationItem": [
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "category": "WBB",
            "description": "Wireless BroadBand",
            "name": "WBB",
            "serviceType": "WBB",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": 1
              },
              {
                "name": "TransportTypes",
                "valueType": "object",
                "value": "WBB_5G,WBB_BASIC"
              },
              {
                "name": "NetworkTransportTypes",
                "valueType": "String",
                "value": "WBB_5G,WBB_BASIC"
              },
              {
                "name": "PreferredNetworkType",
                "valueType": "String",
                "value": "WBB_5G"
              },
              {
                "name": "LightGreenIndicator",
                "valueType": "boolean",
                "value": true
              }
            ],
            "state": "feasibilityChecked"
          }
        },
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "category": "HSIA",
            "description": "High Speed Internet Access",
            "name": "HSIA",
            "serviceType": "HSIA",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": 2
              },
              {
                "name": "TransportTypes",
                "valueType": "String",
                "value": "IT-RT,IP-RT_BP,FTTN,FTTN-BP"
              },
              {
                "name": "NetworkTransportTypes",
                "valueType": "String",
                "value": "IT-RT,IP-RT_BP,FTTN,FTTN-BP"
              },
              {
                "name": "PreferredNetworkType",
                "valueType": "String",
                "value": "FTTN"
              },
              {
                "name": "LightGreenIndicator",
                "valueType": "boolean",
                "value": true
              },
              {
                "name": "MaxDownloadSpeedMbps",
                "valueType": "number",
                "value": 50
              },
              {
                "name": "MaxUploadSpeedMbps",
                "valueType": "number",
                "value": 0
              },
              {
                "name": "LightSpeeedEligible",
                "valueType": "boolean",
                "value": true
              },
              {
                "name": "UverseEligible",
                "valueType": "boolean",
                "value": true
              },
              {
                "name": "GFastDeviceWireType",
                "valueType": "String",
                "value": "G.FAST.106.CX"
              },
              {
                "name": "GigaPowerAvailabilityIndicator",
                "valueType": "boolean",
                "value": true
              },
              {
                "name": "UversePendingOrder",
                "valueType": "String",
                "value": "Y"
              },
              {
                "name": "InternetBandwidthEligible",
                "valueType": "boolean",
                "value": true
              }
            ],
            "state": "feasibilityChecked"
          }
        },
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "category": "WLL",
            "description": "Wireless Local Loop",
            "name": "WLL",
            "serviceType": "WLL",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": 3
              },
              {
                "name": "WLLDataEligible",
                "valueType": "boolean",
                "value": true
              },
              {
                "name": "WLLVoiceligible",
                "valueType": "boolean",
                "value": true
              }
            ],
            "state": "feasibilityChecked"
          }
        },
        {
          "category": {
            "name": "TV"
          },
          "service": {
            "category": "DTV",
            "description": "DTV",
            "name": "DTV",
            "serviceType": "DTV",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": 1
              }
            ],
            "state": "feasibilityChecked"
          }
        },
        {
          "category": {
            "name": "PHONE"
          },
          "service": {
            "category": "VOIP",
            "description": "VOIP",
            "name": "VOIP",
            "serviceType": "VOIP",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": 1
              }
            ],
            "state": "feasibilityChecked"
          }
        },
        {
          "category": {
            "name": "WLS"
          },
          "service": {
            "category": "WIRELESS",
            "description": "WIRELESS",
            "name": "WIRELESS",
            "serviceType": "WIRELESS",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": 1
              }
            ],
            "state": "feasibilityChecked"
          }
        }
      ],
      "serviceInventory": [
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "category": "ADSL",
            "description": "ADSL",
            "name": "ADSL",
            "serviceType": "ADSL",
            "state": "feasibilityChecked",
            "available": true,
            "accountDetails": [
              {
                "billingAccountNumber": "8172950907478",
                "accountStatusCode": "A",
                "customerTypeCode": "R",
                "migrationIndicator": true
              }
            ]
          }
        },
        {
          "category": {
            "name": "WLS"
          },
          "service": {
            "category": "WIRELESS",
            "description": "WIRELESS",
            "name": "WIRELESS",
            "serviceType": "WIRELESS",
            "state": "feasibilityChecked",
            "available": true,
            "accountDetails": [
              {
                "billingAccountNumber": "302352016",
                "accountStatusCode": "O",
                "customerTypeCode": "R",
                "migrationIndicator": false
              }
            ]
          }
        },
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "category": "HSIA",
            "description": "High Speed Internet Access",
            "name": "HSIA",
            "serviceType": "HSIA",
            "state": "feasibilityChecked",
            "available": false
          }
        },
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "category": "WLL",
            "description": "Wireless Local Loop",
            "name": "WLL",
            "serviceType": "WLL",
            "state": "feasibilityChecked",
            "available": false
          }
        },
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "category": "WBB",
            "description": "Wireless BroadBand",
            "name": "WBB",
            "serviceType": "WBB",
            "state": "feasibilityChecked",
            "available": false
          }
        },
        {
          "category": {
            "name": "TV"
          },
          "service": {
            "category": "DTV",
            "description": "DTV",
            "name": "DTV",
            "serviceType": "DTV",
            "state": "feasibilityChecked",
            "available": true,
            "accountDetails": [
              {
                "billingAccountNumber": "263212112",
                "accountStatusCode": "A",
                "customerTypeCode": "R",
                "migrationIndicator": false
              }
            ]
          }
        },
        {
          "category": {
            "name": "TV"
          },
          "service": {
            "category": "IPTV",
            "description": "IPTV",
            "name": "IPTV",
            "serviceType": "IPTV",
            "state": "feasibilityChecked",
            "available": false
          }
        },
        {
          "category": {
            "name": "PHONE"
          },
          "service": {
            "category": "VOIP",
            "description": "VOIP",
            "name": "VOIP",
            "serviceType": "VOIP",
            "state": "feasibilityChecked",
            "available": false
          }
        }
      ],
      "state": "accepted",
      "@baseType": "string",
      "@schemaLocation": "string",
      "@type": "string"
    }
  ]
}

Add to Cart, Saraplus sends the DSL Migration Characteristics with Billing Account Number Endpoint - POST https://eidp.att.com/msapi/salesapi/shopping-cart-api/v1/carts/{{cartID}}/items

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
{
  "relatedParty": [
    {
      "role": "customer",
      "extensions": [
        {
          "name": "CustomerType",
          "value": "Consumer"
        },
        {
          "name": "CustomerSubType",
          "value": "Individual"
        }
      ]
    }
  ],
  "items": [
    {
      "itemType": "WBB_Offer",
      "offerId": "52165303-5d47-4827-a51c-f7ab08570210",
      "quantity": 1,
      "characteristic": [
        {
          "name": "Migrated_From",
          "value": "ADSL"
        },
        {
          "name": "Migrated_Account_Number",
          "value": "1231231231234"
        }
      ]
    },
    {
      "itemType": "WBB_Plan",
      "offerId": "0de8cea7-1d0e-421e-8d7f-8c01b32a173a",
      "quantity": 1,
      "rootBundleProductOfferId": "52165303-5d47-4827-a51c-f7ab08570210",
      "product": {
        "place": [
          {
            "id": "SEARC234SFS",
            "role": "SA",
            "name": "ServiceAddress"
          }
        ]
      }   
    },
    {
      "itemType": "Rented_Equipment",
      "offerId": "417df8e3-2026-455b-aa79-03d3545e7f6d",
      "quantity": 1,
      "rootBundleProductOfferId": "52165303-5d47-4827-a51c-f7ab08570210",
      "groupOptionId": "39910481-873e-11ec-9386-076858e5f59f",
      "product": {
        "place": [
          {
            "id": "SEARC234SFS",
            "role": "SA",
            "name": "ServiceAddress"
          }
        ]
      }
    }
  ]
}
4

Updated Add to Cart with BSSE Service Qualification

New BSSE Service QualificationAPI returns the existing DSL service inventory without billing account number. Endpoint - POST https://partner-saraplus.att.com/omni-svcs/v1/service-qualification

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
{
  "addressValidation": {
    "validationResult": "success",
    "validGeographicAddress": {
      "id": "00000FSUXI",
      "streetNr": "12150",
      "streetName": "KING",
      "streetType": "RD",
      "city": "ROSWELL",
      "stateOrProvince": "GA",
      "postcode": "30075",
      "postcodeExtension": "5522",
      "country": "USA",
      "completeTimeZone": "Eastern Time (EST/EDT)"
    }
  },
  "serviceQualification": [
    {
      "queryServiceQualificationDate": "2026-05-01T15:29:10.864371033Z",
      "serviceQualificationItem": [
        {
          "category": {
            "name": "INTERNET",
            "displayName": "Internet"
          },
          "service": {
            "category": "WBB",
            "displayName": "AT&T Internet Air",
            "serviceType": "WBB",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": "1"
              },
              {
                "name": "TransportTypes",
                "valueType": "string",
                "value": "AIA"
              },
              {
                "name": "UversePendingOrder",
                "valueType": "boolean",
                "value": "false"
              },
              {
                "name": "LightGreenIndicator",
                "valueType": "boolean",
                "value": "false"
              },
              {
                "name": "MaxSpeed",
                "valueType": "string",
                "value": "175.0"
              },
              {
                "name": "MaxData",
                "valueType": "string",
                "value": "unlimited"
              },
              {
                "name": "SpecialSvc",
                "valueType": "string",
                "value": "RMO"
              }
            ]
          }
        },
        {
          "category": {
            "name": "TV",
            "displayName": "TV"
          },
          "service": {
            "category": "DTV",
            "displayName": "DirectTV",
            "serviceType": "DTV",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": "1"
              }
            ]
          }
        },
        {
          "category": {
            "name": "PHONE",
            "displayName": "Phone"
          },
          "service": {
            "category": "AP-A",
            "displayName": "AP-A",
            "serviceType": "AP-A",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": "1"
              },
              {
                "name": "AP-ATransportTypes",
                "valueType": "string",
                "value": "APA-WLS"
              }
            ]
          }
        },
        {
          "category": {
            "name": "PHONE",
            "displayName": "Phone"
          },
          "service": {
            "category": "POTS",
            "displayName": "AT&T POTS",
            "serviceType": "POTS",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": "2"
              }
            ]
          }
        },
        {
          "category": {
            "name": "WLS",
            "displayName": "Wireless"
          },
          "service": {
            "category": "WIRELESS",
            "displayName": "Wireless",
            "serviceType": "WIRELESS",
            "serviceCharacteristic": [
              {
                "name": "QualificationResult",
                "valueType": "string",
                "value": "qualified"
              },
              {
                "name": "priority",
                "valueType": "number",
                "value": "1"
              }
            ]
          }
        }
      ],
      "serviceInventory": [
        {
          "category": {
            "name": "INTERNET"
          },
          "service": {
            "serviceType": "ADSL",
            "accountDetails": [
              {
                "accountStatusCode": "A",
                "customerTypeCode": "R",
                "migrationIndicator": true
              }
            ]
          }
        }
      ]
    }
  ],
  "serviceCharacteristic": [
    {
      "name": "InstantHSIAOnIndicator",
      "valueType": "boolean",
      "value": "false"
    }
  ]
}

Add to Cart, Saraplus sends the DSL Migration Characteristics without Billing Account Number Endpoint - POST https://eidp.att.com/msapi/salesapi/shopping-cart-api/v1/carts/{{cartID}}/items

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
{
  "relatedParty": [
    {
      "role": "customer",
      "extensions": [
        {
          "name": "CustomerType",
          "value": "Consumer"
        },
        {
          "name": "CustomerSubType",
          "value": "Individual"
        }
      ]
    }
  ],
  "items": [
    {
      "itemType": "WBB_Offer",
      "offerId": "52165303-5d47-4827-a51c-f7ab08570210",
      "quantity": 1,
      "characteristic": [
        {
          "name": "Migrated_From",
          "value": "ADSL"
        }
      ]
    },
    {
      "itemType": "WBB_Plan",
      "offerId": "0de8cea7-1d0e-421e-8d7f-8c01b32a173a",
      "quantity": 1,
      "rootBundleProductOfferId": "52165303-5d47-4827-a51c-f7ab08570210",
      "product": {
        "place": [
          {
            "id": "SEARC234SFS",
            "role": "SA",
            "name": "ServiceAddress"
          }
        ]
      }   
    },
    {
      "itemType": "Rented_Equipment",
      "offerId": "417df8e3-2026-455b-aa79-03d3545e7f6d",
      "quantity": 1,
      "rootBundleProductOfferId": "52165303-5d47-4827-a51c-f7ab08570210",
      "groupOptionId": "39910481-873e-11ec-9386-076858e5f59f",
      "product": {
        "place": [
          {
            "id": "SEARC234SFS",
            "role": "SA",
            "name": "ServiceAddress"
          }
        ]
      }
    }
  ]
}
5

Migration Intent Derivation Steps

Client Side

  • Identify AIA qualified address from BSSE Service Qualification API
  • Check "serviceInventory" node for existing service at the service address

- Find first service with account having "migrationIndicator=true"

- Identify the "serviceType=ADSL/UVERSE/HISA" of the service

  • Pass the characteristic "Migrated_From" with the value of the "serviceType" from step2 in the Add to Cart Request of IDP API

Server Side

  • "Migrated_Account_Number" updated in Add to Cart characteristics based on the "Migrated_From" value
  • Remaining steps continue as per AIA Ordering flow
  • Failure to lookup the accountNumber based on the "Migrated_From" will result in error