Cpopoffer

Endpoint

GET

/msapi/cpopoffer/v1/product-offers

Copy

productoffering details will be returned for the provided eligibility and/or filter

Request

Header Parameters

Query Parameters

Body Parameters

Responses

OK.. Returns success response

Body

application/json

REQUEST
curl --request GET \
     --url 'https://example.com/msapi/cpopoffer/v1/product-offers?ids=array&limit=integer&offset=integer&channel=string&subChannel=string&subChannelGroup=string&categoryName=string&serviceAddressId=string&productOfferingTypeGroup=string&characteristics=string&migratedFrom=string&relatedProductOfferingId=string&relationType=string&relationRole=string&customerId=string&productId=string&customerType=string&customerSubType=string&checkEligibilityForCoupon=string&contextType=string&contextMainIdentifier=string&ACPClassification=string&cartSuperPhoneLineCount=integer&losgTypes=array&callCenterType=string&billingState=string&paymentType=string&offerTypes=array&deviceProductIds=string&mode=string&expand=array&allVariants=boolean&lobs=array&productType=string&atgSkuIds=string&groupByVariantGroup=string&imeiTypes=string&skus=string&deviceSkuId=string&planSkuIds=string&expandData=string&ctn=string&categoryType=string&deviceCount=string&planFirstFlow=boolean&creditRisk=string&referralCode=string&installationType=string&activeProducts=string&transportTypes=string&productOfferingOnly=boolean&initiatorBan=string&deviceProductOfferingIds=string&deviceAllocationFlow=boolean&transferCtns=string&acceptorCtn=string&acceptorBan=string&initiatorCustomerType=string&market=string&targetedPlancode=string&prefetch=boolean&skuWithPrefixRentedEquipment=string&skuWithPrefixEquipment=string&productOfferingId=string&cartId=string&productOrderItemId=string&bundleProductsIntent=array&uverseBan=string&zipCode=string&actionType=string&rootBundleProductOrderItemId=string&productOfferingType=string&productOfferingGroup=string&accessEligible=boolean&dealerCode=string&fanId=string&planGroupId=string&groupChangeInFocus=string&customerIntend=string&contractType=string&contractVersion=string&status=string&dataGroupInd=string&mobileOfferType=string&deviceCounters=string&checkQualification=string&selectedUpgradeOption=string&tradeInModel=string&tradeInValue=string&hylaModelCode=string&orderType=string&intent=string&accountType=string&accountSubType=string&enterpriseType=string&speed=string&qualificationType=string&marketplaceEligible=boolean&enforcePlanCheck=boolean&planType=string&kitType=string&state=string&stateCode=string&tenderType=string&serviceFlow=boolean' \
     --header 'X-ATT-ClientId: string' \
     --header 'accept: application/json' \
     --header 'idpctx-appname: string' \
     --header 'idpctx-linkeduverseaccnums: string'

RESPONSE
[
  {
    "id": "63fd411b-9ba8-484b-bba5-52797f4c26a1",
    "name": "Extended Wi-Fi Coverage Service",
    "localizedName": "Extended Wi-Fi Coverage Service",
    "description": "Extended Wi-Fi Coverage Service",
    "href": "/msapi/productoffer/discovery/v1/product-offers/63fd411b-9ba8-484b-bba5-52797f4c26a1?channel=SelfService",
    "productOfferingType": "Coverage",
    "productOfferingTypeGroup": "addon",
    "mustBeBundled": false,
    "isBundle": true,
    "productOfferingCharacteristic": [
      {
        "name": "Benefits",
        "localizedName": "Benefits",
        "valueType": "String",
        "value": [
          {
            "value": "<ul> <li>Reduce signal weak spots and dead zones</li> <li>Increase your Wi-Fi coverage by up to 1,000 sq ft.</li> <li>Lifetime extender replacement while your service is active*</li> </ul>  <p>&nbsp;</p> <p>* Account must be active and in good standing; replacement at discretion of AT&amp;T.</p> <p>California Proposition 65 warning</p> <p>WARNING: Cancer and reproductive harm; go to <a href=https://www.p65warnings.ca.gov/>https://www.p65warnings.ca.gov\\</a></p>",
            "localizedValue": "<ul> <li>Reduce signal weak spots and dead zones</li> <li>Increase your Wi-Fi coverage by up to 1,000 sq ft.</li> <li>Lifetime extender replacement while your service is active*</li> </ul>  <p>&nbsp;</p> <p>* Account must be active and in good standing; replacement at discretion of AT&amp;T.</p> <p>California Proposition 65 warning</p> <p>WARNING: Cancer and reproductive harm; go to <a href=https://www.p65warnings.ca.gov/>https://www.p65warnings.ca.gov\\</a></p>",
            "default": false
          }
        ]
      },
      {
        "name": "Service_Description",
        "localizedName": "Service Description",
        "valueType": "String",
        "value": [
          {
            "value": "<p>Next-generation Wi-Fi experience, delivers more coverage to more corners of your home</p>",
            "localizedValue": "<p>Next-generation Wi-Fi experience, delivers more coverage to more corners of your home</p>",
            "default": false
          }
        ]
      },
      {
        "name": "buyersRemorseDuration",
        "localizedName": "Buyer's Remorse Duration",
        "valueType": "Integer",
        "value": [
          {
            "value": "31",
            "localizedValue": "31",
            "default": false
          }
        ]
      },
      {
        "name": "Offer_Code",
        "localizedName": "Offer Code",
        "valueType": "String",
        "value": [
          {
            "value": "EWCS",
            "localizedValue": "EWCS",
            "default": false
          }
        ],
        "characteristicsMetadata": [
          {
            "name": "CharacteristicValueDisplayFields",
            "value": "value"
          }
        ]
      },
      {
        "name": "Payment_Type",
        "localizedName": "Payment Option",
        "valueType": "String",
        "value": [
          {
            "value": "Pay_on_Bill",
            "localizedValue": "Pay on Bill",
            "default": false
          }
        ],
        "characteristicsMetadata": [
          {
            "name": "AppearOnSummary",
            "value": "true"
          },
          {
            "name": "AppearOnPreview",
            "value": "true"
          },
          {
            "name": "Visualization",
            "value": "DropDown"
          },
          {
            "name": "LocalizedName",
            "value": "Payment Option"
          },
          {
            "name": "Presentable",
            "value": "true"
          },
          {
            "name": "Actionable",
            "value": "null"
          },
          {
            "name": "Editable",
            "value": "true"
          }
        ]
      },
      {
        "name": "Payment_Method",
        "localizedName": "Payment Method",
        "valueType": "String",
        "value": [
          {
            "value": "Credit",
            "localizedValue": "Credit",
            "default": false
          }
        ],
        "characteristicsMetadata": [
          {
            "name": "AppearOnSummary",
            "value": "true"
          },
          {
            "name": "AppearOnPreview",
            "value": "true"
          },
          {
            "name": "Visualization",
            "value": "DropDown"
          },
          {
            "name": "LocalizedName",
            "value": "Payment Method"
          },
          {
            "name": "Presentable",
            "value": "true"
          },
          {
            "name": "Actionable",
            "value": "null"
          },
          {
            "name": "Editable",
            "value": "true"
          }
        ]
      },
      {
        "name": "firstRCPaymentOption",
        "localizedName": "First RC Payment Option",
        "valueType": "String",
        "value": [
          {
            "value": "Immediate",
            "localizedValue": "Immediate",
            "default": false
          },
          {
            "value": "payOnBill",
            "localizedValue": "Pay on Bill",
            "default": false
          }
        ],
        "characteristicsMetadata": [
          {
            "name": "AppearOnSummary",
            "value": "true"
          },
          {
            "name": "AppearOnPreview",
            "value": "true"
          },
          {
            "name": "Visualization",
            "value": "DropDown"
          },
          {
            "name": "LocalizedName",
            "value": "First RC Payment Option"
          },
          {
            "name": "Presentable",
            "value": "true"
          },
          {
            "name": "Actionable",
            "value": "null"
          },
          {
            "name": "Editable",
            "value": "true"
          },
          {
            "name": "alignmentType",
            "value": "align"
          },
          {
            "name": "alignOC",
            "value": "false"
          },
          {
            "name": "alignRC",
            "value": "true"
          },
          {
            "name": "alignUC",
            "value": "false"
          }
        ]
      },
      {
        "name": "paymentTiming",
        "localizedName": "Payment Timing",
        "valueType": "String",
        "value": [
          {
            "value": "InAdvance",
            "localizedValue": "In Advance",
            "default": false
          }
        ],
        "characteristicsMetadata": [
          {
            "name": "AppearOnSummary",
            "value": "true"
          },
          {
            "name": "AppearOnPreview",
            "value": "true"
          },
          {
            "name": "Visualization",
            "value": "DropDown"
          },
          {
            "name": "LocalizedName",
            "value": "Payment Timing"
          },
          {
            "name": "Presentable",
            "value": "true"
          },
          {
            "name": "Actionable",
            "value": "null"
          },
          {
            "name": "Editable",
            "value": "true"
          },
          {
            "name": "alignmentType",
            "value": "propagate"
          },
          {
            "name": "alignOC",
            "value": "false"
          },
          {
            "name": "price",
            "value": "MASKED"
          },
          {
            "name": "alignRC",
            "value": "true"
          },
          {
            "name": "alignUC",
            "value": "false"
          }
        ]
      },
      {
        "name": "prorationPolicy",
        "localizedName": "Proration Policy",
        "valueType": "String",
        "value": [
          {
            "value": "defaultProrationStrategy",
            "localizedValue": "Default Proration Strategy",
            "default": false
          }
        ],
        "characteristicsMetadata": [
          {
            "name": "alignmentType",
            "value": "propagate"
          },
          {
            "name": "alignOC",
            "value": "false"
          },
          {
            "name": "price",
            "value": "MASKED"
          },
          {
            "name": "alignRC",
            "value": "true"
          },
          {
            "name": "alignUC",
            "value": "false"
          }
        ]
      },
      {
        "name": "billingProfile",
        "localizedName": "Billing Profile",
        "valueType": "String",
        "value": [
          {
            "value": "hassleFree",
            "localizedValue": "Hassle Free Profile",
            "default": false
          }
        ]
      },
      {
        "name": "commissionable",
        "localizedName": "commissionable",
        "valueType": "String",
        "value": [
          {
            "value": "0",
            "localizedValue": "No",
            "default": true
          },
          {
            "value": "1",
            "localizedValue": "Yes",
            "default": false
          }
        ]
      },
      {
        "name": "chargebackEligible",
        "localizedName": "chargebackEligible",
        "valueType": "String",
        "value": [
          {
            "value": "0",
            "localizedValue": "No",
            "default": true
          },
          {
            "value": "1",
            "localizedValue": "Yes",
            "default": false
          }
        ]
      },
      {
        "name": "productType",
        "localizedName": "Product Type",
        "valueType": "String",
        "value": [
          {
            "value": "WBB",
            "localizedValue": "WBB",
            "default": true
          }
        ],
        "characteristicsMetadata": [
          {
            "name": "systemName"
          },
          {
            "name": "externalName"
          },
          {
            "name": "exposed"
          }
        ]
      },
      {
        "name": "extenderRecommended",
        "localizedName": "extenderRecommended",
        "valueType": "Integer",
        "value": [
          {
            "value": "3",
            "localizedValue": "3",
            "default": false
          }
        ]
      }
    ],
    "productOfferingRelationship": [
      {
        "id": "94fe0227-ab56-45c2-b124-5fd49d570142",
        "name": "WBB_AddOn_Relation",
        "relationshipType": "commercialRelation",
        "role": "addOn"
      }
    ],
    "validFor": {
      "startDateTime": "2021-11-02T07:00:00Z"
    },
    "productOfferingTotalPrice": [
      {
        "priceType": "RC",
        "recurringChargePeriod": "month",
        "recurringChargePeriodLength": 1,
        "price": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 12
          }
        },
        "finalPrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 12
          }
        },
        "standalonePrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 12
          }
        },
        "taxIncluded": "Excluded"
      }
    ],
    "productOfferingPrice": [
      {
        "name": "Extended Wi-Fi Coverage Service",
        "priceCategory": "serviceRC",
        "priceType": "RC",
        "recurringChargePeriod": "month",
        "recurringChargePeriodLength": 1,
        "role": "Price",
        "price": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 12
          }
        },
        "finalPrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 12
          }
        },
        "standalonePrice": {
          "dutyFreeAmount": {
            "unit": "USD",
            "value": 12
          }
        },
        "taxIncluded": "Excluded"
      }
    ],
    "bundledProductOfferingGroupOption": [
      {
        "groupOptionId": "482dd825-81cf-11ec-9599-99edba8abb8c",
        "bundledProductOffering": [
          {
            "id": "31f4774c-3ad1-4cb5-8413-450d06a4d49b",
            "name": "All-Fi Booster",
            "localizedName": "All-Fi Booster",
            "href": "/msapi/productoffer/discovery/v1/product-offers/31f4774c-3ad1-4cb5-8413-450d06a4d49b?channel=SelfService",
            "description": "All-Fi Booster",
            "productOfferingType": "Equipment",
            "productOfferingTypeGroup": "BBDevice",
            "isBundle": false
          }
        ],
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "5"
      }
    ]
  }
]

AT&T DevEx

Omni APIs Central | AIA | Partners

Endpoint

productoffering details will be returned for the provided eligibility and/or filter

Header Parameters

Query Parameters

Body Parameters

Responses

Body

REQUEST

RESPONSE