Examples | Fetch Trade-in Promotion

Scenario 1 | Trade-in device with IMEI

1

About

This flow is used when the partner system has the device’s IMEI available.

2

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
{
                    "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"
                        ]
                      }
                    ]
                  }
3

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"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  ]
                }

Scenario 2 | Trade-in device by device make and model

1

About

This flow is used when the customer has the device’s make and model with hylacode available.

2

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
{
                    "make": "Apple",
                    "model": "Iphone 12 Pro",
                    "capacity": "128GB",
                    "qualificationType": "Trade-In",
                    "deviceBillCode": "689C",
                    "flowType": "UP",
                    "tradeInModelCode": "2234245",
                    "deviceConditionAnswers": [
                      {
                        "name": "ATT_GENERIC",
                        "value": [
                          "Yes"
                        ]
                      },
                      {
                        "name": "LCD_FUNCTIONALITY",
                        "value": [
                          "Yes"
                        ]
                      },
                      {
                        "name": "POWER_ON",
                        "value": [
                          "Yes"
                        ]
                      },
                      {
                        "name": "DEACTIVATED",
                        "value": [
                          "Yes"
                        ]
                      }
                    ]
                  }
3

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"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  ]
                }