HLPS | Availability

Endpoint

POST
/msapi/pno/cpopoffer/msapi/productoffermanagementms/v3/product/availability

Hyper Local Pricing and Strategy for Availability

arrowRequest

Body Parameters

Responses

OK.. Returns success response

arrowBody

application/json

REQUEST

1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
     --url https://example.com/msapi/pno/cpopoffer/msapi/productoffermanagementms/v3/product/availability \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "accountNumber": "559210581033",
  "productType": "BROADBAND",
  "mode": "changeRatePlan"
}
'

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
{
  "content": {
    "accountDetails": {
      "ban": "559210581033"
    },
    "availableProducts": [
      {
        "eligibility": true,
        "orderCount": 0,
        "productDetails": [
          {
            "productType": "BB_Offer",
            "productPrice": {
              "base": 65,
              "total": 55,
              "uom": "month",
              "taxIncluded": "EXCLUDED"
            },
            "productOriginalPrice": {
              "base": 65,
              "total": 55,
              "uom": "month",
              "taxIncluded": "EXCLUDED"
            },
            "productMarketingPrice": {
              "base": 65,
              "total": 55,
              "uom": "month",
              "taxIncluded": "EXCLUDED"
            },
            "productPriceRelationship": [
              {
                "type": "monthlyCharges",
                "charges": [
                  {
                    "base": 65,
                    "total": 55,
                    "uom": "month",
                    "taxIncluded": "EXCLUDED"
                  }
                ]
              }
            ],
            "productOfferingRelationship": [
              {
                "type": "discounts",
                "value": [
                  {
                    "id": "ImmediatePromotion_60d1c554-2c85-47ba-a79a-8f195115933d",
                    "name": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
                    "description": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a debit card or bank account. Or $5/mo. with a credit card.",
                    "applyPolicy": "automatic",
                    "productPrice": {
                      "base": 55,
                      "total": 10,
                      "uom": "month",
                      "taxIncluded": "EXCLUDED"
                    },
                    "promoType": "ABP"
                  }
                ]
              },
              {
                "type": "BB_Plan",
                "value": [
                  {
                    "id": "85333ec5-e9aa-4c8e-b886-04afb19e4a6a",
                    "name": "AT&T Internet 300",
                    "description": "300Mbps speed",
                    "productPrice": {
                      "base": 65,
                      "total": 55,
                      "uom": "month",
                      "taxIncluded": "EXCLUDED",
                      "periodCoverage": {
                        "endDateTime": "1985-04-12T23:20:50.520Z"
                      },
                      "productOfferingPrice": {
                        "id": "ST001",
                        "name": "strategy",
                        "priceType": "Subsidy"
                      }
                    }
                  }
                ]
              },
              {
                "type": "addon",
                "value": [
                  {
                    "id": "b474f34f-5c2b-4501-99dd-28ef9e60dcff",
                    "name": "Fiber Wi-Fi Coverage Service",
                    "description": "Fiber Wi-Fi Coverage Service characteristics: From Benefits, update the characteristics from benefits",
                    "productOfferingType": "Coverage",
                    "productPrice": {
                      "base": 10,
                      "total": 10,
                      "uom": "month",
                      "taxIncluded": "EXCLUDED"
                    },
                    "equipments": [
                      {
                        "deviceId": "3be36e21-9fb4-4fe9-aaa8-fb2ebac818dc",
                        "deviceType": "Equipment",
                        "deviceTypeGroup": "BBDevice",
                        "deviceDisplayName": "All-Fi Fiber Booster",
                        "upperLimit": "5"
                      }
                    ],
                    "currentProductIndicator": false
                  }
                ]
              }
            ],
            "benefits": "<ul><li>Game, stream, and video chat with confidence</li><li>Ensure your smart home devices run smoothly</li><li>300Mbps upload and download speeds</li></ul>",
            "id": "b5d96af0-30bc-4988-92b9-7798cc9d4f93",
            "productName": "AT&T Internet 300",
            "productDescription": "300Mbps speed + unlimited internet data"
          }
        ]
      }
    ]
  }
}