AT&T DevEx

Omni APIs Central | Wireless Solutions | Partners

Check Potential Promotion Eligibility

download iconDownload spec

Endpoint

POST
https://partner.att.com/omni-svcs/v1/promotions/potential-promotions

Evaluate promotion eligibility for a device context.

arrowRequest

Body Parameters

Responses

Qualification response

arrowBody

application/json

REQUEST

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
curl --request POST \
     --url https://partner.att.com/omni-svcs/v1/promotions/potential-promotions \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "imei": "12345789",
  "qualificationType": "Trade-In",
  "deviceBillCode": "689C",
  "flowType": "UP",
  "deviceConditionAnswers": [
    {
      "name": "ATT_GENERIC",
      "value": [
        "Yes"
      ]
    },
    {
      "name": "LCD_FUNCTIONALITY",
      "value": [
        "Yes"
      ]
    },
    {
      "name": "POWER_ON",
      "value": [
        "Yes"
      ]
    },
    {
      "name": "DEACTIVATED",
      "value": [
        "Yes"
      ]
    }
  ]
}
'

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
{
  "qualificationType": "Trade-In",
  "potentialQualificationItem": [
    {
      "characteristic": [
        {
          "name": "tradeInValue",
          "value": "81.0"
        },
        {
          "name": "tradeInModel",
          "value": "iPhone 14 Pro"
        }
      ],
      "potentialPromotion": [
        {
          "id": "wrlspr-29966",
          "promotion": {
            "id": "wrlspr-29966",
            "name": "OFFER APPLIED: You're getting up to $350 off with elig. trade-in on installment & elig. unlimited plan (speed restr's apply). Credits start within 3 bills. Without unlimited, device is full price.",
            "promotionCharacteristics": [
              {
                "name": "discount",
                "value": "350.0"
              },
              {
                "name": "promotype",
                "value": "tradeIn"
              }
            ]
          }
        }
      ]
    }
  ]
}