* Account must be active and in good standing; replacement at discretion of AT&T.
California Proposition 65 warning
WARNING: Cancer and reproductive harm; go to https://www.p65warnings.ca.gov\\
", "localizedValue": "
* Account must be active and in good standing; replacement at discretion of AT&T.
California Proposition 65 warning
WARNING: Cancer and reproductive harm; go to https://www.p65warnings.ca.gov\\
", "default": false } ] }, { "name": "Service_Description", "localizedName": "Service Description", "valueType": "String", "value": [ { "value": "Next-generation Wi-Fi experience, delivers more coverage to more corners of your home
", "localizedValue": "Next-generation Wi-Fi experience, delivers more coverage to more corners of your home
", "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" } ] } ] } } } } }, "206": { "description": "OK.. Returns partial response with paginaton information", "headers": { "idpctx-X-Pagination-Total-Pages": { "description": "integer for the total pages based on provided limit", "style": "simple", "schema": { "type": "integer" } }, "idpctx-X-Total-Count": { "description": "integer for the total resource response count", "style": "simple", "schema": { "type": "integer" } }, "idpctx-OC-X-Dox-trace": { "description": "traceID from OrderCapture api call", "required": true, "style": "simple", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } } }, "400": { "description": "Error in request details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceError" } } } }, "500": { "description": "Error from backend or error connecting to backend source", "headers": { "idpctx-OC-X-Dox-trace": { "description": "traceID from OrderCapture api call", "required": true, "style": "simple", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceError" } } } } } } } }, "components": { "schemas": { "AccountDetails": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountstatus": { "type": "string" }, "activationDate": { "type": "string" }, "subscribers": { "type": "array", "items": { "$ref": "#/components/schemas/Subscriber" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } }, "systemId": { "type": "string" } } }, "Action": { "type": "object", "properties": { "action": { "type": "string" }, "modifyReason": { "$ref": "#/components/schemas/Reason" } }, "description": "The action ID (resume, suspend, or change) and its reason " }, "Benefit": { "type": "object", "properties": { "billingBenefitId": { "type": "string" }, "billingBenefitCode": { "type": "string" }, "promotionType": { "type": "string" }, "offerCode": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "portin": { "type": "boolean" }, "extBenefitId": { "type": "string" } } }, "BenefitsCustomerHasReceived": { "type": "object", "properties": { "benefitCode": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } } }, "CTBenefit": { "type": "object", "properties": { "id": { "type": "string" }, "billingBenefitId": { "type": "string" }, "billingBenefitCode": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "offerCode": { "type": "string" }, "promotionBillingCode": { "type": "string" }, "promotionType": { "type": "string" }, "promotionName": { "type": "string" }, "effectiveDate": { "type": "string" }, "offerId": { "type": "string" }, "nextUpReAttachRequired": { "type": "boolean" } } }, "CartContext": { "type": "object", "properties": { "cpopProductIds": { "type": "array", "items": { "type": "string" } }, "coupons": { "type": "array", "items": { "$ref": "#/components/schemas/CouponsRequestWrapper" } }, "businessApps": { "$ref": "#/components/schemas/CartProduct" }, "salesChannel": { "type": "string" }, "validateOnlyReward": { "type": "boolean" }, "validateAvailableQuota": { "type": "boolean" }, "lobDetails": { "type": "array", "items": { "$ref": "#/components/schemas/LOBDetails" } }, "location": { "$ref": "#/components/schemas/Location" }, "cpopOfferIds": { "type": "array", "items": { "type": "string" } }, "cpopOfferCodes": { "type": "array", "items": { "type": "string" } }, "broadband": { "$ref": "#/components/schemas/CartProduct" }, "IPTV": { "$ref": "#/components/schemas/CartProduct" }, "satellite": { "$ref": "#/components/schemas/CartProduct" }, "OTT": { "$ref": "#/components/schemas/CartProduct" }, "wireless": { "$ref": "#/components/schemas/CartProduct" }, "voip": { "$ref": "#/components/schemas/CartProduct" } } }, "CartProduct": { "type": "object", "properties": { "tradeInValue": { "type": "number", "format": "double" }, "sunsetDate": { "type": "string" }, "isActive": { "type": "boolean" }, "retentionPromotionIndicator": { "type": "boolean" }, "segmentDescription": { "type": "string" }, "coolOffPeriod": { "type": "string" }, "freeTrialEligible": { "type": "boolean" }, "isDefaultPromo": { "type": "boolean" }, "accountType": { "type": "string" }, "nextBillingDate": { "type": "string" }, "sdgSocCode": { "type": "string" }, "tradeInEligibiltyReason": { "type": "string" }, "accountInFocus": { "type": "string" }, "groupIDInFocus": { "type": "string" }, "ctnInFocus": { "type": "string" }, "accountDetails": { "$ref": "#/components/schemas/AccountDetails" }, "losgs": { "type": "array", "items": { "$ref": "#/components/schemas/Losg" } }, "promotions": { "type": "array", "items": { "$ref": "#/components/schemas/Promotion" } }, "active": { "type": "boolean" }, "defaultPromo": { "type": "boolean" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductInfo" } }, "accountNumber": { "type": "string" }, "productFamily": { "type": "string" }, "isContracted": { "type": "boolean" }, "benefits": { "type": "array", "items": { "$ref": "#/components/schemas/Benefit" } }, "accountStatus": { "type": "string" }, "rootLevelContextId": { "type": "string" }, "installmentPlanIdentifier": { "type": "string" } } }, "ChannelEligibility": { "type": "object", "properties": { "opusGroup": { "type": "array", "items": { "type": "string" } }, "opusChannels": { "type": "array", "items": { "type": "string" } }, "opusSubChannels": { "type": "array", "items": { "type": "string" } }, "regions": { "type": "array", "items": { "type": "string" } }, "market": { "type": "array", "items": { "type": "string" } }, "opusState": { "type": "array", "items": { "type": "string" } }, "storeIds": { "type": "array", "items": { "type": "string" } }, "dealerIds": { "type": "array", "items": { "type": "string" } }, "callCenterIds": { "type": "array", "items": { "type": "string" } }, "kioskIds": { "type": "array", "items": { "type": "string" } }, "repProfile": { "type": "array", "items": { "type": "string" } } } }, "ComplexContext": { "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/Filter" } } } }, "ComplexFilterContext": { "type": "object", "properties": { "broadband": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexContext" } }, "voip": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexContext" } }, "businessApps": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexContext" } }, "wireless": { "type": "array", "items": { "$ref": "#/components/schemas/ComplexContext" } } } }, "ContractDetails": { "type": "object", "properties": { "amountFinanced": { "type": "number", "format": "double" }, "annualPercentageRate": { "type": "number", "format": "double" }, "balancedAmount": { "type": "number", "format": "double" }, "contractDisplayName": { "type": "string" }, "contractLength": { "type": "integer", "format": "int32" }, "contractType": { "type": "string" }, "downPayment": { "type": "number", "format": "double" }, "downPaymentPercent": { "type": "number", "format": "double" }, "financeCharge": { "type": "number", "format": "double" }, "installmentAmount": { "type": "number", "format": "double" }, "installmentPlanDefinition": { "type": "string" }, "prepaidFinanceCharge": { "type": "number", "format": "double" }, "totalSalePrice": { "type": "number", "format": "double" }, "_commitmentTermId": { "type": "string" } } }, "CouponsRequestWrapper": { "type": "object", "properties": { "code": { "type": "string" } } }, "CustomerContext": { "type": "object", "properties": { "accountType": { "type": "string" }, "fan": { "type": "string" }, "accountNumber": { "type": "string" }, "accountInFocus": { "type": "string" }, "ctnInFocus": { "type": "string" }, "ctnsInFocus": { "type": "array", "items": { "type": "string" } }, "groupIDInFocus": { "type": "string" }, "businessSegment": { "type": "string" }, "customerID": { "type": "string" }, "autoPay": { "type": "string" }, "billingDeliveryPreference": { "type": "string" }, "fanProfile": { "$ref": "#/components/schemas/FanProfileContent" }, "accountDetails": { "$ref": "#/components/schemas/AccountDetails" }, "completeConnectivityIndicator": { "type": "string" } } }, "CustomerEligibility": { "type": "object", "properties": { "state": { "type": "array", "items": { "type": "string" } }, "dma": { "type": "array", "items": { "type": "string" } }, "county": { "type": "array", "items": { "type": "string" } }, "city": { "type": "array", "items": { "type": "string" } }, "zipCode": { "type": "array", "items": { "type": "string" } }, "customerCallIntent": { "type": "array", "items": { "type": "string" } }, "custClassification": { "type": "array", "items": { "type": "string" } }, "region": { "type": "array", "items": { "type": "string" } }, "zipCode+4": { "type": "array", "items": { "type": "string" } } } }, "CustomerIntent": { "type": "object", "properties": { "productFamily": { "type": "string" }, "productStatus": { "type": "string" } } }, "CustomerPromotion": { "type": "object", "properties": { "promotionId": { "type": "string" }, "promotionStartDate": { "type": "string" }, "promotionEndDate": { "type": "string" } } }, "DeviceDetailsInfo": { "type": "object", "properties": { "key": { "type": "string" }, "sku": { "type": "string" }, "imeiType": { "type": "string" }, "deviceMake": { "type": "string" }, "deviceModel": { "type": "string" }, "imeiNumber": { "type": "string" }, "simSerialNumber": { "type": "string" } } }, "DiscountValue": { "type": "object", "properties": { "amountType": { "type": "string" }, "amount": { "type": "number", "format": "double" } } }, "FanProfile": { "type": "object", "properties": { "fanCategories": { "type": "array", "items": { "type": "string" } }, "mrcModifiers": { "type": "array", "items": { "type": "string" } } } }, "Filter": { "type": "object", "properties": { "filterName": { "type": "string" }, "filterValues": { "type": "array", "items": { "type": "string" } } } }, "Group": { "type": "object", "properties": { "groupId": { "type": "string" }, "groupSdg": { "type": "string" }, "phoneCounter": { "type": "string" }, "maxValidPhoneCounter": { "type": "string" } } }, "HardGood": { "type": "object", "properties": { "byodIndicator": { "type": "boolean" }, "eid": { "type": "string" }, "hardGoodType": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "productImageUrl": { "type": "string" }, "wirelessHardGoodCharacteristics": { "$ref": "#/components/schemas/WirelessHardGoodCharacteristics" } } }, "Intent": { "type": "object", "properties": { "type": { "type": "string" }, "segment": { "type": "array", "items": { "type": "string" } }, "offerCategories": { "type": "array", "items": { "type": "string" } }, "billingCode": { "type": "string" }, "cart": { "type": "boolean" }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/Segments" } }, "dealerCode": { "type": "array", "items": { "type": "string" } }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Action" } }, "planType": { "type": "string" }, "coverageType": { "type": "string" }, "destinationCode": { "type": "string" } } }, "LOBDetails": { "type": "object", "properties": { "businessSegment": { "type": "string" }, "customerSegement": { "type": "string" }, "offerActionType": { "type": "string" }, "productFamily": { "type": "string" }, "lobType": { "type": "string" }, "losgs": { "type": "array", "items": { "$ref": "#/components/schemas/Losgs" } } } }, "LineItem": { "type": "object", "properties": { "ctBenefits": { "type": "array", "items": { "$ref": "#/components/schemas/CTBenefit" } }, "lineItemId": { "type": "string" }, "action": { "type": "string" }, "productKey": { "type": "string" }, "skuKey": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "commitmentTermId": { "type": "string" }, "tierAttr": { "type": "string" }, "deviceCategory": { "type": "string" }, "id": { "type": "string" }, "billingCode": { "type": "string" }, "productType": { "type": "string" }, "offerId": { "type": "string" }, "productId": { "type": "string" }, "productSKU": { "type": "string" }, "itemType": { "type": "string" }, "promotionReferences": { "type": "array", "items": { "type": "string" } }, "productGroupReferences": { "type": "array", "items": { "type": "string" } }, "offerCodes": { "type": "array", "items": { "type": "string" } }, "billingProductCode": { "type": "string" }, "benefits": { "type": "array", "items": { "$ref": "#/components/schemas/Benefit" } }, "productCode": { "type": "string" }, "hardGood": { "$ref": "#/components/schemas/HardGood" }, "price": { "$ref": "#/components/schemas/Price" }, "contractDetails": { "$ref": "#/components/schemas/ContractDetails" } } }, "Location": { "type": "object", "properties": { "zipCode": { "type": "string" }, "dma": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "county": { "type": "string" }, "region": { "type": "string" }, "market": { "type": "string" }, "subMarket": { "type": "string" }, "country": { "type": "string" } } }, "Losg": { "type": "object", "properties": { "losgId": { "type": "string" }, "productFamily": { "type": "string" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/LineItem" } }, "flowType": { "type": "string" } } }, "Losgs": { "type": "object", "properties": { "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/LineItem" } }, "productFamily": { "type": "string" }, "flowType": { "type": "string" }, "ctnInFocus": { "type": "string" }, "losgId": { "type": "string" }, "inCart": { "type": "boolean" }, "withPortIn": { "type": "boolean" }, "losgType": { "type": "string" }, "losgSubType": { "type": "string" }, "primaryIndicator": { "type": "boolean" } } }, "OfferRequest": { "type": "object", "properties": { "accountTypes": { "type": "array", "items": { "type": "string" } }, "addOnType": { "type": "array", "items": { "type": "string" } }, "benefitCodes": { "type": "array", "items": { "type": "string" } }, "billingProductCodes": { "type": "array", "items": { "type": "string" } }, "bundleProductCodes": { "type": "array", "items": { "type": "string" } }, "bundleProductIds": { "type": "array", "items": { "type": "string" } }, "benefitsCodesToSuppressOffer": { "type": "array", "items": { "type": "string" } }, "benefitsCustomerHasReceived": { "type": "array", "items": { "$ref": "#/components/schemas/BenefitsCustomerHasReceived" } }, "businessSegment": { "type": "array", "items": { "type": "string" } }, "customerSegments": { "type": "array", "items": { "type": "string" } }, "businessSegments": { "type": "array", "items": { "type": "string" } }, "cartContext": { "$ref": "#/components/schemas/CartContext" }, "channelEligibility": { "$ref": "#/components/schemas/ChannelEligibility" }, "fanId": { "type": "string" }, "contractIndicator": { "type": "array", "items": { "type": "string" } }, "customerContext": { "$ref": "#/components/schemas/CustomerContext" }, "customerEligibility": { "$ref": "#/components/schemas/CustomerEligibility" }, "customerIntent": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerIntent" } }, "intent": { "type": "array", "items": { "$ref": "#/components/schemas/Intent" } }, "fanProfile": { "$ref": "#/components/schemas/FanProfile" }, "marketingDisplay": { "type": "array", "items": { "type": "string" } }, "heartValue": { "type": "string" }, "offerActionType": { "type": "array", "items": { "type": "string" } }, "offerCodes": { "type": "array", "items": { "type": "string" } }, "offerIds": { "type": "array", "items": { "type": "string" } }, "offerProductFamily": { "type": "array", "items": { "type": "string" } }, "offerStatus": { "type": "array", "items": { "type": "string" } }, "offerTypes": { "type": "array", "items": { "type": "string" } }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "planSubType": { "type": "array", "items": { "type": "string" } }, "productCodes": { "type": "array", "items": { "type": "string" } }, "qualifyingProductCodes": { "type": "array", "items": { "type": "string" } }, "qualifyingProducts": { "type": "array", "items": { "type": "string" } }, "salesChannel": { "type": "array", "items": { "type": "string" } }, "tribalIndicator": { "type": "string" }, "offerClassificationType": { "type": "array", "items": { "type": "string" } }, "offerClassificationSubType": { "type": "array", "items": { "type": "string" } }, "migrationServiceType": { "type": "array", "items": { "type": "string" } }, "creditRisk": { "type": "string" }, "orderDate": { "type": "string" }, "complexfilterContext": { "$ref": "#/components/schemas/ComplexFilterContext" }, "paymentType": { "type": "string" }, "customerSubType": { "type": "array", "items": { "type": "string" } }, "fan": { "type": "string" }, "fanCategories": { "type": "array", "items": { "type": "string" } }, "couponStatus": { "type": "array", "items": { "type": "string" } }, "productsOnAccountToSuppressOffer": { "type": "array", "items": { "type": "string" } }, "migrationIndicator": { "type": "boolean" }, "addressId": { "type": "string" }, "customerType": { "type": "array", "items": { "type": "string" } }, "location": { "$ref": "#/components/schemas/Location" }, "intentOnlyOffers": { "type": "boolean" }, "swimlaneSwitchEligible": { "type": "boolean" }, "tradeInValue": { "type": "string" }, "tradeInModels": { "type": "string" }, "reconnectCustomer": { "type": "boolean" }, "dealerCode": { "type": "array", "items": { "type": "string" } }, "portIn": { "type": "boolean" }, "extBenefitCodes": { "type": "array", "items": { "type": "string" } }, "billingBenefitIds": { "type": "array", "items": { "type": "string" } }, "returnPortInOffers": { "type": "boolean" }, "existingProductOnAccount": { "type": "array", "items": { "type": "string" } }, "linkedUverseAccount": { "type": "string" }, "storeId": { "type": "string" }, "offerTrayEnabled": { "type": "boolean" }, "selfServiceChannel": { "type": "boolean" }, "uuid": { "type": "string" }, "accchannel": { "type": "boolean" }, "upgradeFlow": { "type": "boolean" }, "offerProductTypes": { "type": "array", "items": { "type": "string" } }, "isExpiredOffers": { "type": "boolean" }, "isOfferTrayEnabled": { "type": "boolean" }, "isOffersForYou": { "type": "boolean" }, "isPaytoPromoReached": { "type": "boolean" }, "isEarlyUpgrade": { "type": "boolean" }, "selectedUpgradeOption": { "type": "string" }, "nextUpAnytime": { "type": "boolean" }, "nextUptradeInValue": { "type": "number", "format": "double" } } }, "Pagination": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" } } }, "Price": { "type": "object", "properties": { "taxIncludedAmount": { "$ref": "#/components/schemas/Money" }, "dutyFreeAmount": { "$ref": "#/components/schemas/Money" }, "taxAmount": { "$ref": "#/components/schemas/Money" }, "taxRate": { "type": "number", "format": "float" }, "percentage": { "type": "number", "format": "float" }, "priceReduction": { "$ref": "#/components/schemas/Money" }, "priceOverride": { "$ref": "#/components/schemas/Money" }, "priceRecordId": { "type": "string", "description": "The unique identifier of the price in the pricing domain. " }, "impactingPriceParameter": { "type": "array", "description": "The parameters that impact the price ", "items": { "$ref": "#/components/schemas/PriceParam" } }, "appliedTax": { "type": "array", "items": { "$ref": "#/components/schemas/AppliedTax" } }, "chargeType": { "type": "string" }, "extensions": { "type": "object", "additionalProperties": { "type": "object" } } }, "description": "The price of current catalog item. It is set to null if the price record is missing or if there is any exception. " }, "PriceAdjustment": { "type": "object", "properties": { "type": { "type": "string" }, "promoId": { "type": "string" }, "benefitCode": { "type": "string" }, "reasonCode": { "type": "string" }, "amount": { "type": "number" }, "discountVal": { "$ref": "#/components/schemas/DiscountValue" }, "waivedIndicator": { "type": "boolean" }, "isDiscountRolledUp": { "type": "boolean" } } }, "PriceAdjustments": { "type": "object", "properties": { "type": { "type": "string" }, "benefitCode": { "type": "string" }, "amount": { "type": "number" } } }, "Product": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the product " }, "href": { "type": "string", "description": "Hypertext reference to the product " }, "name": { "type": "string", "description": "Name of the product " }, "referenceId": { "type": "string", "description": "Reference ID of the product " }, "status": { "type": "string", "description": "State of the product in the Product Inventory subdomain " }, "version": { "type": "string", "description": "Version of the product in the Product Inventory subdomain " }, "primaryProductId": { "type": "string", "description": "Unique identifier of the primary product. This property is populated only when the product is a product reference for the *Enable By* relation, and the referenced product is a product in the inventory and is not part of the order. In this case, the property contains the ID of the product ancestor that is marked as primary. This property and *productOrderRef* are mutually exclusive. " }, "activationDate": { "type": "string", "description": "Date on which the product was activated " }, "terminationDate": { "type": "string", "description": "Date on which the product is terminated " }, "alternateId": { "type": "integer", "description": "Alternate identifier of the product ", "format": "int64" }, "relatedParty": { "type": "array", "description": "Party associated with the product ", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "productSpecification": { "$ref": "#/components/schemas/ProductSpecificationRef" }, "characteristic": { "type": "array", "description": "Characteristic of the product ", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } }, "productCharacteristic": { "type": "array", "description": "Characteristic of the product ", "items": { "$ref": "#/components/schemas/ProductCharacteristic" } }, "place": { "type": "array", "description": "Place of the product ", "items": { "$ref": "#/components/schemas/PlaceRef" } }, "productRelationship": { "type": "array", "description": "Relationship of the product ", "items": { "$ref": "#/components/schemas/ProductRelationship" } }, "metadata": { "type": "array", "description": "Product specification metadata ", "items": { "$ref": "#/components/schemas/Metadata" } }, "productOrder": { "$ref": "#/components/schemas/ProductOrderRef" }, "statusReason": { "type": "array", "description": "The reason of the product state. This property is populated only when the referenced product is a product in the inventory. ", "items": { "$ref": "#/components/schemas/StatusReason" } }, "nextStatusReason": { "type": "array", "description": "The reason of the product state. This property is populated only when the referenced product is a product in the inventory. ", "items": { "$ref": "#/components/schemas/Reason" } }, "businessActivity": { "type": "array", "description": "Business activities with correlated dates for each activity ", "items": { "$ref": "#/components/schemas/BusinessActivity" } }, "statusChangeDate": { "type": "string", "description": "The product last status chane date.May be equal to the network fulfillment date, or set according to different logic. " }, "productOrderItem": { "type": "array", "description": "Place of the product ", "items": { "$ref": "#/components/schemas/RelatedProductOrderItem" } }, "product": { "type": "array", "description": "Place of the product ", "items": { "type": "string", "description": "Place of the product " } }, "productCriteria": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCriteria" } }, "sourceReason": { "$ref": "#/components/schemas/Reason" }, "targetReason": { "$ref": "#/components/schemas/Reason" }, "targetRelatedParty": { "$ref": "#/components/schemas/RelatedPartyRef" }, "additionalTargetRelatedParty": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyRef" } }, "targetBillingAccount": { "$ref": "#/components/schemas/BillingAccountRef" }, "statusChangeReason": { "type": "array", "items": { "$ref": "#/components/schemas/Reason" } }, "extensions": { "type": "object", "additionalProperties": { "type": "object" } } }, "description": "An owned product or a product to be provided " }, "ProductInfo": { "type": "object", "properties": { "basePrice": { "type": "string" }, "cpopProductId": { "type": "string" }, "productCode": { "type": "string" }, "productType": { "type": "string" }, "pricePlanCode": { "type": "string" }, "billingProductCode": { "type": "string" }, "productId": { "type": "string" }, "streamType": { "type": "string" }, "promotions": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPromotion" } }, "lineType": { "type": "string" } } }, "Promotion": { "required": [ "description", "id", "name", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, The unique ID of the promotion. e.g. 2074e0c0-08b6-49ea-8ea9-9390651ab676" }, "name": { "type": "string", "description": "Required=true, The name of the promotion. e.g. Autopay Discount" }, "description": { "type": "string", "description": "Required=true, The description of the promotion for the business user. e.g. Discount of flat recurring $10 when subscribed to auto pay option." }, "type": { "type": "string", "description": "Required=true, The type of the promotion. e.g. discount" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "applyPolicy": { "type": "string", "description": "Required=false, Defines the policy to apply the promotion. e.g. automatic" }, "href": { "type": "string", "description": "Required=true, href to the promotion" }, "productOfferingTotalPrice": { "type": "array", "description": "Required=false, The productOfferingTotalPrice of the promotion. e.g. ", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRefOrValue" } }, "promotionCharacteristics": { "type": "array", "description": "Required=false, The characteristics of the promotion. e.g. ", "items": { "$ref": "#/components/schemas/PromotionCharacteristic" } }, "additionalQualificationCriteria": { "type": "array", "description": "Required=false, characteristics items with value as List", "items": { "$ref": "#/components/schemas/AdditionalQualificationCriteria" } } }, "description": "Promotion Object" }, "QualifyingDetail": { "type": "object", "properties": { "productFamily": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } } }, "Segments": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "flag": { "type": "boolean" } } }, "Soc": { "type": "object", "properties": { "socId": { "type": "string" }, "dataGroupInd": { "type": "string" }, "socMode": { "type": "string" } } }, "Subscribers": { "type": "object", "properties": { "subscriberNumber": { "type": "string" }, "subscriberStatus": { "type": "string" }, "groupId": { "type": "string" }, "primary": { "type": "boolean" }, "deviceDetailsInfo": { "$ref": "#/components/schemas/DeviceDetailsInfo" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "socs": { "type": "array", "items": { "$ref": "#/components/schemas/Soc" } }, "sdgSocCode": { "type": "string" }, "sdfSocCode": { "type": "string" } } }, "WirelessHardGoodCharacteristics": { "type": "object", "properties": { "deviceCategory": { "type": "string" }, "equipmentType": { "type": "string" }, "imei": { "type": "string" }, "imeiType": { "type": "string" }, "phoneType": { "type": "string" }, "techType": { "type": "string" }, "productSKU": { "type": "string" }, "productId": { "type": "string" }, "_deviceSubType": { "type": "string" } } }, "BenefitItem": { "required": [ "action", "href", "id", "inCart", "itemState", "itemStatus", "itemType", "pathToRoot", "promotionCriteriaGroupId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, The unique ID of the benefit item. e.g. ff1f96e8-704e-4d97-92c6-35008ec1c0ac" }, "itemType": { "type": "string", "description": "Required=true, The type of the benefit item. e.g. catalog" }, "itemStatus": { "type": "string", "description": "Required=true, The benefit item Status new , keep, revoke " }, "promotionCriteriaGroupId": { "type": "string", "description": "Required=true, The ID of the promotion criteria group (root or nested) as part of which the item is qualified as a benefit item. e.g. 6bb6c561-4707-4a20-ada1-027a35b57768" }, "pathToRoot": { "type": "string", "description": "Required=true, The path from the current item in the oroduct offering structure to the root. This property is populated if the benefit item is a nested item. e.g. /d134f2c2-37cd-4eab-96e7-d2d12350e3b0_d8bfb8be-79dd-45e6-95c6-0bc2e30f12d8/943200e2-00da-4555-8f35-a1141683a866_ff1f96e8-704e-4d97-92c6-35008ec1c0ac" }, "action": { "type": "array", "description": "Required=true, The action of the promotion. When customers meet the conditions in the promotion pattern, they can be given the benefits that are included in the action. Note - duration field is deprecated. Use duarationPolicy instead. e.g. Refer PromotionAction attributes and example values", "items": { "$ref": "#/components/schemas/PromotionAction" } }, "href": { "type": "string", "description": "Required=true, The self-reference to the trigger item" }, "inCart": { "type": "boolean", "description": "Required=true, The benefit item Status new , keep, revoke " }, "potentialBenefitItem": { "type": "array", "description": "Required=false, This will show potential offers required to qualify for promotion", "items": { "$ref": "#/components/schemas/PotentialBenefitItem" } }, "itemState": { "type": "string", "description": "Required=true, The benefit item Status new , keep, revoke " } }, "description": "benefit item object" }, "ContainedResource": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the resource " }, "id": { "type": "string", "description": "Unique identifier of the resource " }, "variable": { "type": "array", "description": "Variables that are related to the resource ", "items": { "$ref": "#/components/schemas/Variable" } } }, "description": "Resources that are contained in the validation message " }, "Context": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the context of the rule " }, "type": { "type": "string", "description": "The type of the context of the rule " }, "value": { "type": "array", "description": "The value of the context of the rule ", "items": { "type": "string", "description": "The value of the context of the rule " } } }, "description": "The reference to the context definition of the rule " }, "CountRestriction": { "type": "object", "properties": { "benefitLimit": { "type": "integer", "description": "The benefit limit of the count restriction. Specifies how many of the counted items can be included within a promotion instance as benefits ", "format": "int32" }, "payForCount": { "type": "integer", "description": "The payed item limit of the count restriction. Specifies how many of the counted items within a promotion instance how many should be payed for ", "format": "int32" } }, "description": "The benefit limit and BOGO restrictions related to the count. In case of benefit limit restriction, specifies how many of the counted items can be included within a promotion instance. In case of BOGO restriction, specifies how many of the counted items are benefited and how many should be payed for. " }, "DurationPolicy": { "type": "object", "properties": { "duration": { "$ref": "#/components/schemas/Quantity" }, "startDatePolicy": { "type": "string" }, "endDatePolicy": { "type": "string" }, "effectiveFor": { "$ref": "#/components/schemas/TimePeriod" }, "terminationPolicy": { "type": "string" } }, "description": "Policy for calculting a limited duration for any entity " }, "ImmediatePromotion": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the immediate promotion " }, "status": { "type": "string", "description": "Status of the instance of the immediate promotion " }, "state": { "type": "string", "description": "The apply state of the qualified promotion. The state can have the following values: - 'applied' - For an immediate promotion that all of it's benefits are applied - 'notApplied' - For an immediate promotion that none of it's benefits are applied - future - 'partiallyApplied' - For an immediate promotion that part of it's benefits are applied - future - 'pendingApply' - Received in the request for an immediate promotion for which certain benefits, which are selected externally by a consuming application, should be applied " }, "promotion": { "$ref": "#/components/schemas/PromotionRef" }, "productPromotion": { "$ref": "#/components/schemas/ProductPromotionRef" }, "triggerItem": { "type": "array", "items": { "$ref": "#/components/schemas/TriggerItem" } }, "benefitItem": { "type": "array", "items": { "$ref": "#/components/schemas/BenefitItem" } }, "immediatePromotionCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/ContextCharacteristic" } }, "reason": { "$ref": "#/components/schemas/ModifyReason" }, "relatedParty": { "$ref": "#/components/schemas/RelatedPartyRef" }, "actionReason": { "$ref": "#/components/schemas/ActionReason" } }, "description": "Immediate promotion " }, "ManualPromotionModifyReason": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the modification reason " }, "reasonText": { "type": "string", "description": "The free text for the modification reason, for cases where the modify reason type requires the input of free text " }, "action": { "type": "string", "description": "The action to be performed " } }, "description": "The modification reason associated with the optional promotion modification " }, "ManualPromotionQualification": { "type": "object", "properties": { "immediatePromotion": { "type": "array", "items": { "$ref": "#/components/schemas/ImmediatePromotion" } }, "promotionQualificationMessage": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationMessage" } } } }, "ProductOfferingBenefit": { "type": "object", "properties": { "productOfferingId": { "type": "string", "description": "the id of the product offering granted as a benefit " }, "promotionPriceAlteration": { "type": "array", "description": "referecne to price entity representing the actual monetary discount ", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRef" } } }, "description": "Reference to a product offering used as a free offer benefit by the promotion" }, "ProductOfferingPriceRef": { "required": [ "actionType", "id", "priceType" ], "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Required=true, The unique ID of the action. e.g. 3f0cfcaf-613e-4919-8f09-30bbf8c05967" }, "actionType": { "type": "string", "description": "Required=true, ProductOfferingPrice price type . e.g. OC." }, "priceType": { "type": "string", "description": "Required=true, ProductOfferingPrice price type . e.g. OC." } }, "description": "ProductOfferingPriceRef Object for promotionPriceAlteration of Promotion pattern promotion action relevant pricing entity that defines the actual discount" }, "ProductPromotionRef": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the product promotion " }, "href": { "type": "string", "description": "Hypertext reference to the product promotion " } }, "description": "Reference to the product promotion. " }, "PromotionAction": { "required": [ "actionType", "actionValue", "id" ], "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Required=true, The unique ID of the action. e.g. 3f0cfcaf-613e-4919-8f09-30bbf8c05967" }, "name": { "type": "string", "description": "Required=false, The localized name of the promotion. e.g. Discount" }, "actionType": { "type": "string", "description": "Required=true, The type of the benefit. e.g. Product Offering." }, "actionValue": { "type": "integer", "description": "Required=true, The value of the action. e.g. type is Price Alteration, the value is populated with '1'.", "format": "int32" }, "promotionPriceAlteration": { "$ref": "#/components/schemas/ProductOfferingPriceRef" }, "durationPolicy": { "$ref": "#/components/schemas/DurationPolicy" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" } }, "description": "PromotionAction Object for The promotion action of the promotion pattern related entities" }, "PromotionCriteria": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the criteria " }, "criteriaParam": { "type": "string" }, "criteriaParamName": { "type": "string" }, "criteriaOperator": { "type": "string" }, "criteriaValue": { "type": "string" }, "criteriaUOM": { "type": "string" }, "criteriaCharacteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Context" } } } }, "PromotionCriteriaGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the criteria group " }, "groupName": { "type": "string", "description": "The name of the criteria group " }, "criteriaType": { "type": "string", "description": "The type of the criteria. Usually, represents a context entity such as Customer, Product Offering, Product, and so on. " }, "criteriaTypeMethod": { "type": "string", "description": "The criteria type method used to describe the criteria group type. The supported criteria group types are - Scope, Criteria, List, Aggregation, and so on. " }, "relationTypeInGroup": { "type": "string", "description": "The logical relation type amongst the various criteria inside the promotion criteria group. The AND and the OR logical relations are supported. " }, "equalVariable": { "type": "string", "description": "Relevant for criteria groups with criteriaTypeMethod = Scope. Represents a common parameter that must be qualified on all criteria groups defined uder the scope. " }, "aggregationFunctionCriteria": { "$ref": "#/components/schemas/PromotionCriteria" }, "criteria": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCriteria" } }, "criteriaGroup": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCriteriaGroup" } }, "scopeCriteria": { "$ref": "#/components/schemas/PromotionCriteriaGroup" }, "countRestriction": { "$ref": "#/components/schemas/CountRestriction" } }, "description": "For the Price Alteration type, the object on which the action is being performed, that is, the promotion discount. This object represents a promotion criteria group. " }, "PromotionCriteriaGroupRef": { "type": "object", "properties": { "id": { "type": "string" } }, "description": "The reference to the object of the action. For the Price Alteration type, this object is the promotion discount - represents a reference to an existing promotion criteria group in the current promotion rule. If there is a reference only, the ID of the promotion criteria group is populated. " }, "PromotionRef": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the promotion " }, "name": { "type": "string", "description": "Name of the promotion " }, "description": { "type": "string", "description": "Promotion description for a business user " }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "type": { "type": "string", "description": "The type of the promotion " }, "priority": { "type": "integer", "description": "The priority of the promotion ", "format": "int32" }, "applyPolicy": { "type": "string", "description": "Defines the policy to apply the promotion - can be manual or automatic " }, "href": { "type": "string", "description": "Hypertext reference to the promotion " } }, "description": "Reference to the promotion " }, "QualifyManualPromotionResponse": { "type": "object", "properties": { "promotionQualification": { "$ref": "#/components/schemas/ManualPromotionQualification" } } }, "Quantity": { "type": "object", "properties": { "units": { "type": "string" }, "amount": { "type": "number" } }, "description": "Quantity of a resource " }, "RelatedPartyRef": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the related party " }, "role": { "type": "string", "description": "Role played by the related party " }, "extensions": { "type": "array", "description": "extensions of the related party ", "items": { "$ref": "#/components/schemas/NameValuePair" } }, "@referredType": { "type": "string", "description": "Referred type of the related party " } }, "description": "Party or party role that is linked to a specific entity " }, "RelatedResource": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the resource " }, "id": { "type": "string", "description": "Unique identifier of the resource " }, "variable": { "type": "array", "description": "Variables related to the resource ", "items": { "$ref": "#/components/schemas/Variable" } }, "containedResource": { "type": "array", "description": "Other resources, specs, or offers that are linked to the message but did not trigger the validation message ", "items": { "$ref": "#/components/schemas/ContainedResource" } } }, "description": "Resource that is associated with the validation message (that is, triggered the validation failure) " }, "RelatedTriggerItem": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the related trigger item " }, "role": { "type": "string", "description": "The role of the related trigger item " } }, "description": "A relation to a specific trigger item. For example, for promotion action with actionType = productOffering, this relation indicates a relevant trigger item to which the action should be related. The type of the relation is specified in 'role' field " }, "TimePeriod": { "type": "object", "properties": { "startDateTime": { "type": "string", "description": "Required=false, valid start date and time. e.g. 2031-04-23T12:38:31.774Z" }, "endDateTime": { "type": "string", "description": "Required=false, valid end date and time. e.g. 2021-01-31T14:00:00Z" } }, "description": "validFor Object for validate start and end date of the related entity" }, "TriggerItem": { "required": [ "id", "itemState", "itemType", "pathToRoot", "promotionCriteriaGroupId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, The unique ID of the trigger item. e.g. 943200e2-00da-4555-8f35-a1141683a866_ff1f96e8-704e-4d97-92c6-35008ec1c0ac" }, "itemType": { "type": "string", "description": "Required=true, The type of the trigger item. e.g. catalog" }, "itemStatus": { "type": "string" }, "promotionCriteriaGroupId": { "type": "string", "description": "Required=true, The ID of the promotion criteria group (root or nested) as part of which the item is qualified as a trigger item. e.g. 6bb6c561-4707-4a20-ada1-027a35b57768" }, "pathToRoot": { "type": "string", "description": "Required=true, The path from the current item in the product offering structure to the root. This property is populated if the trigger item is a nested item. e.g. /d134f2c2-37cd-4eab-96e7-d2d12350e3b0_d8bfb8be-79dd-45e6-95c6-0bc2e30f12d8/943200e2-00da-4555-8f35-a1141683a866_ff1f96e8-704e-4d97-92c6-35008ec1c0ac" }, "href": { "type": "string", "description": "Required=false, The self-reference to the trigger item" }, "itemState": { "type": "string", "description": "Required=true, The benefit item Status new , keep, revoke " } }, "description": "Trigger item Object" }, "ValidationMessage": { "type": "object", "properties": { "id": { "type": "string", "description": "Non-localized name identifier of the validation message " }, "text": { "type": "string", "description": "Localized descriptive validation message " }, "type": { "type": "string", "description": "Type of the validation message " }, "subtype": { "type": "string", "description": "Distinct code which represents the issue " }, "parameter": { "type": "array", "description": "Name/value pair of the validation message ", "items": { "$ref": "#/components/schemas/ValidationMessageParameter" } }, "severity": { "type": "string", "description": "Severity of the validation message " }, "path": { "type": "string", "description": "Path to the resource part to which the validation message is related " }, "resource": { "type": "array", "description": "Resource that is associated with the message ", "items": { "$ref": "#/components/schemas/RelatedResource" } } }, "description": "Message associated with the validation failure " }, "ValidationMessageParameter": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the parameter " }, "value": { "type": "array", "description": "Value of the parameter ", "items": { "type": "string", "description": "Value of the parameter " } } }, "description": "Name/value pair of the validation message parameter " }, "Variable": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the variable " }, "id": { "type": "string", "description": "Unique identifier of the variable " }, "value": { "type": "array", "description": "Value(s) of the variable ", "items": { "type": "string", "description": "Value(s) of the variable " } } }, "description": "Variable that is associated with a resource " }, "Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "ServiceError": { "type": "object", "properties": { "errorId": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "QualificationPrefetch": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "productType": { "type": "string" }, "channel": { "type": "string" } } }, "Message": { "type": "object", "properties": { "type": { "type": "string", "description": "Required=false, The type of the message. e.g. displayName" }, "message": { "type": "string", "description": "Required=false, The localized text of the message. e.g. Qualifier:WLS, Beneficiary:AIA" } }, "description": "The message that describes the promotion. The message can be of several types. Typically, the message is presented by consumers in their user interface." }, "PromotionCharacteristic": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "description": "Required=true, The text ID of the promotion characteristic. e.g. promoType" }, "value": { "type": "string", "description": "Required=true, Value of the promotion characteristic. e.g. flatrate" } }, "description": "The list of the descriptive characteristics for the Discovery flows derived from the promotions and included in the promotion specification (if exists)" }, "PromotionPattern": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, The unique ID of the promotion pattern. e.g. 5694779d-f15c-444d-806e-26f7a284258c" }, "description": { "type": "string", "description": "Required=false, The localized description of the promotion pattern. e.g. " }, "name": { "type": "string", "description": "Required=false, The name of the promotion pattern. e.g. " }, "relationTypeAmongGroup": { "type": "string", "description": "Required=false, The relationTypeAmongGroup of the promotion pattern. e.g. " }, "priority": { "type": "integer", "description": "Required=false, The priority of the promotion pattern. e.g. 1", "format": "int32" }, "action": { "type": "array", "description": "Required=false, The benefits of the promotion. e.g. ", "items": { "$ref": "#/components/schemas/PromotionAction" } }, "criteriaGroup": { "type": "array", "description": "Required=false, This object represents a promotion criteria group, that is promotion discount.", "items": { "$ref": "#/components/schemas/PromotionCriteriaGroup" } } }, "description": "promotionPattern Object for The pattern of the promotion related entity" }, "Promotions": { "required": [ "applyPolicy", "crossProduct", "href", "id", "name", "selectionPolicy", "type", "validFor" ], "type": "object", "properties": { "id": { "maxLength": 100, "minLength": 10, "type": "string", "description": "Required=true, The ID of the promotion. e.g. 3f0cfcaf-613e-4919-8f09-30bbf8c05967" }, "href": { "type": "string", "description": "Required=true, The self-reference to the item. e.g. https://amd-apigw-stack-service-amo-eks2-d2d2-runtime.dtd.attbsse.amdocs.com/promotion/v0/promotion/3f0cfcaf-613e-4919-8f09-30bbf8c05967" }, "name": { "type": "string", "description": "Required=true, The localized name of the promotion. e.g. AirPods 10% off Discount" }, "description": { "type": "string", "description": "Required=false, The localized description of the promotion. e.g. Discount of 10% One Time when Purchasing AirPods Accessory" }, "type": { "type": "string", "description": "Required=true, The type of the promotion. e.g. Discount" }, "lastUpdate": { "type": "string", "description": "Required=false, The lastUpate of the promotion. e.g. " }, "priority": { "type": "integer", "description": "Required=false, The priority of the promotion. e.g. 1", "format": "int32" }, "applyPolicy": { "type": "string", "description": "Required=true, Defines the policy to apply the qualified promotion - can be manual or automatic. e.g. manual" }, "selectionPolicy": { "type": "string", "description": "Required=true, Defines how to select the benefited offer in case there are more than required by a promotion condition. e.g. byPurchaseDate" }, "message": { "type": "array", "description": "Required=false, The message that describes the promotion. e.g. type: displayName, message: Qualifier:WLS, Beneficiary:AIA", "items": { "$ref": "#/components/schemas/Message" } }, "crossProduct": { "type": "boolean", "description": "Required=true, Indicates whether the promotion rule refers to cross-product. e.g. based on Promition domain" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "pattern": { "$ref": "#/components/schemas/PromotionPattern" }, "promotionCharacteristics": { "type": "array", "description": "Required=false, The characteristics of the promotion. e.g. ", "items": { "$ref": "#/components/schemas/PromotionCharacteristic" } } }, "description": "Represents entities of managable promotion qualification and promotion resources, It enables qualifying the available promotions for the relevant items - product offerings, product order items, shopping cart items, and configuration items." }, "Category": { "required": [ "href", "id", "isRoot", "localizedName", "name", "validFor" ], "type": "object", "properties": { "id": { "maxLength": 100, "type": "string", "description": "Required=true, Unique identifier of the category. e.g. f1c5f22d-c331-47e2-ba3a-4814fde0e56c" }, "name": { "maxLength": 100, "type": "string", "description": "Required=true, Name of the category. e.g. Wbb_Plan_Services", "enum": [ "Wbb_Plan_Services", "Wbb_Plan", "Fixed_Wbb_Plans" ] }, "localizedName": { "maxLength": 100, "type": "string", "description": "Required=true, The localized name of the category. e.g. Plan & Services" }, "description": { "maxLength": 500, "type": "string", "description": "Required=false, The localized description of the category. e.g. Plan & Services" }, "href": { "type": "string", "description": "Required=true, The link to the productoffering. e.g. https://att.com/​msapi/cpopoffer/v1/productOfferingDiscovery/v1.1/category/f1c5f22d-c331-47e2-ba3a-4814fde0e56c" }, "isRoot": { "type": "boolean", "description": "Required=true, If true, this Boolean indicates that the category is a root of categories. e.g. true" }, "lastUpdate": { "type": "string", "description": "Required=false, Date and time of the last update. e.g. 2020-08-27T00:00:00Z" }, "lifecycleStatus": { "type": "string", "description": "Required=false, Used to indicate the current lifecycle status" }, "version": { "type": "string", "description": "Required=true, Category version. e.g. 1.0" }, "parentId": { "type": "string", "description": "Required=true, Unique identifier of the parent category. e.g. f1c5f22d-c331-47e2-ba3a-4814fde0e56c" }, "validFor": { "$ref": "#/components/schemas/TimePeriod" }, "subCategory": { "maxLength": 100, "type": "array", "description": "Required=false, A list of sub category references.", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "productOffering": { "maxLength": 100, "type": "array", "description": "Required=false, A list of Product Offering references.", "items": { "$ref": "#/components/schemas/ProductOfferingRef" } }, "category": { "maxLength": 100, "type": "array", "description": "Required=false, A list of category.", "items": { "$ref": "#/components/schemas/Category" } }, "isLeaf": { "type": "boolean", "description": "Required=false, Date and time of the last update. e.g. 2020-08-27T00:00:00Z" }, "categoryCharacteristics": { "type": "array", "description": "Required=false, A list of category characteristics.", "items": { "$ref": "#/components/schemas/CategoryCharacteristic" } } }, "description": "The category resource is used to group product offerings, service and resource candidates in logical containers.Categories can contain other categories and/or product offerings, resource or service candidates." }, "CategoryCharacteristic": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the characteristic." }, "localizedName": { "type": "string", "description": "The localized name of the characteristic." }, "valueType": { "type": "string", "description": "The value type of the characteristic." }, "value": { "type": "array", "description": "The list of values for this characteristic.", "items": { "$ref": "#/components/schemas/CategoryCharacteristicValue" } } }, "description": "A characteristic of a category, such as longDescription, iconUrl, rank, etc." }, "CategoryCharacteristicValue": { "type": "object", "properties": { "value": { "type": "string", "description": "The value of the characteristic." }, "localizedValue": { "type": "string", "description": "The localized value of the characteristic." }, "get_default": { "type": "boolean", "description": "Indicates if this value is the default." } }, "description": "A value for a category characteristic, including the value, localized value, and default flag." }, "CategoryRef": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, The unique ID of the product offering category. e.g. c8f31d65-4eb5-4700-bc1b-f157bd17f195" }, "name": { "type": "string", "description": "Required=true, The name of the product offering category. e.g. WBB_Plans", "enum": [ "WBB_Plans" ] } }, "description": "The category of productoffering related to" }, "ProductOfferingRef": { "required": [ "id", "name", "productOfferingType" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, The relevant Business Relationship unique identifier. e.g. 0b2a61d3-35a0-4cd0-bba8-1bafc0694fda" }, "name": { "type": "string", "description": "Required=true, Business Relationship name. e.g. Compatible addons for the product. e.g. " }, "href": { "type": "string", "description": "Required=true, Business Relationship type. The type of the relation by which the related product offering. e.g. https://att.com/​msapi/cpopoffer/v1/productOffering/7655" }, "productOfferingType": { "type": "string", "description": "Required=true, Product Offering Type. The type of the product for which the offering requested for. e.g. Mobile_Device " } }, "description": "Product Offering Reference" }, "ProductOfferingPriceItem": { "type": "object", "properties": { "sku": { "type": "string" }, "salePrice": { "type": "number" }, "reasonCode": { "type": "string" } } }, "ProductOfferingPriceRequest": { "type": "object", "properties": { "type": { "type": "string" }, "channel": { "type": "string" }, "state": { "type": "string" }, "storeId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOfferingPriceItem" } }, "ban": { "type": "string" }, "market": { "type": "string" }, "activityDate": { "type": "string" }, "subscribers": { "type": "array", "items": { "type": "string" } }, "subscriberDetails": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberDetail" } } } }, "SubscriberDetail": { "type": "object", "properties": { "subscriber": { "type": "string" }, "cancellationDate": { "type": "string" } } }, "AdditionalQualificationCriteria": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "description": "Required=true, The name of the additional qualification criteria. e.g. qualifierSkus" }, "value": { "type": "array", "description": "Required=true, value of the additional qualification criteria. e.g. List of qualifierSkus", "items": { "type": "string", "description": "Required=true, value of the additional qualification criteria. e.g. List of qualifierSkus" } } }, "description": "Holds characteristics with String name and List value, which cannot be accommodated in PromotionCharacteristic" }, "AttachmentRefOrValue": { "required": [ "attachmentType", "id", "name", "url" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, Unique identifier for this particular attachment. e.g. 4aafacbd-11ff-4dc8-b445-305f2215715f" }, "name": { "type": "string", "description": "Required=true, The name of the attachment. e.g. Moreabout5G" }, "attachmentType": { "type": "string", "description": "Required=true, Attachment type such as video, picture. e.g. URL" }, "url": { "type": "string", "description": "Required=true, Uniform Resource Locator, is a web page address (a subset of URI). e.g. /knowledgearticle/5Gbroadband" } }, "description": "benefit item object" }, "AttributeOperations": { "type": "object", "properties": { "id": { "type": "string" }, "operationName": { "type": "string" } } }, "BundledProdOfferOption": { "required": [ "numberRelOfferDefault", "numberRelOfferLowerLimit", "numberRelOfferUpperLimit" ], "type": "object", "properties": { "numberRelOfferDefault": { "type": "integer", "description": "Required=true, default number of Related Offer Upper Limit. e.g. 1", "format": "int32" }, "numberRelOfferLowerLimit": { "type": "integer", "description": "Required=true, number of Related Offer Lower Limit. e.g. 1", "format": "int32" }, "numberRelOfferUpperLimit": { "type": "integer", "description": "Required=true, number of Related Offer Upper Limit. e.g. 1", "format": "int32" }, "productOfferingPrice": { "type": "array", "description": "Required=false, itemPrice. e.g. Refer ProductOfferingPriceRefOrValue attributes and example values", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRefOrValue" } }, "productOfferingTotalPrice": { "type": "array", "description": "Required=false, item TotalPrice. e.g. Refer ProductOfferingPriceRefOrValue attributes and example values", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRefOrValue" } } }, "description": "The lower and upper limits for a product offering that can be purchased as part of the related bundled product offering. The values can range from 0 to unlimited." }, "BundledProductOffering": { "required": [ "description", "href", "id", "localizedName", "name", "productOfferingType", "productOfferingTypeGroup" ], "type": "object", "properties": { "id": { "type": "string", "description": "Required=true, The unique ID of the bundled product offering. e.g. a002fb3e-991b-4189-aec6-faae3b27ec3e" }, "name": { "type": "string", "description": "Required=true, The name of the bundled product offering. e.g. HD Streaming" }, "localizedName": { "type": "string", "description": "Required=true, The localized name of the bundled product offering. e.g. HD Streaming" }, "href": { "type": "string", "description": "Required=true, The link to the productoffering. e.g. https://att.com/msapi/cpopoffer/v1/product-offers/417df8e3-2026-455b-aa79-03d3545e7f6d?channel=SelfService" }, "description": { "type": "string", "description": "Required=true, The description of the bundled product offering. e.g. With HD Streaming, you can stream videos in High Definition" }, "productSku": { "type": "string", "description": "Required=false, The Product Sku id" }, "default": { "type": "boolean", "description": "Required=false, Indicates whether the bundled product offering is selected by default when purchasing the bundle product offering. e.g. true" }, "productOfferingType": { "type": "string", "description": "Required=true, The type of the product offering - can represent the LOB or other relevant types like shipping offer. e.g.WBB_Offer, WBB_Plan, Rented_Equipment", "enum": [ "WBB_Offer", "WBB_Plan", "Rented_Equipment" ] }, "productOfferingTypeGroup": { "maxLength": 100, "minLength": 1, "type": "string", "description": "Required=true, The type group of the product offering. e.g. WBBOffer, WBBPlan, equipment", "enum": [ "WBBPlan", "WBBOffer", "equipment" ] }, "bundledProductOffering": { "type": "array", "description": "Required=false, The child bundle product offering. e.g. Refer bundledProductOffering attributes and example values", "items": { "$ref": "#/components/schemas/BundledProductOffering" } }, "bundledProductOfferingOption": { "type": "array", "description": "Required=false, The upper and lower limits of the product offerings that can be purchased as part of the bundle product offering. e.g. Refer BundledProdOfferOption attributes and example values", "items": { "$ref": "#/components/schemas/BundledProdOfferOption" } }, "bundledProductOfferingGroupOption": { "type": "array", "description": "Required=false, list of product BundledProductOfferingGroupOption Details.", "items": { "$ref": "#/components/schemas/BundledProductOfferingGroupOption" } }, "productOfferingCharacteristic": { "type": "array", "description": "Required=false, The list of characteristics for the product offering. The type of the characteristic is determined by the related characteristic property entity. e.g. Refer ProductOfferingCharacteristic model for attributes and example values", "items": { "$ref": "#/components/schemas/ProductOfferingCharacteristic" } }, "subscriberResults": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriberResults" } }, "substitutionAction": { "type": "string", "description": "Required=false, Action to add incompatible boosters" }, "productOfferingPrice": { "type": "array", "description": "Required=false, The productoffer price. e.g. Refer ProductOfferingPriceRefOrValue model for attributes and example values", "items": { "$ref": "#/components/schemas/ProductOfferingPriceRefOrValue" } }, "installType": { "type": "string", "description": "Required=false, type of installation Eg: Self Installation/Tech Installation" }, "productOfferingRelationship": { "type": "array", "description": "Required=false, The relevant Business Relationship. e.g. Refer ProductOfferingRelationship model for attributes and example values", "items": { "$ref": "#/components/schemas/ProductOfferingRelationship" } }, "isBundle": { "type": "boolean", "description": "Required=false, Indicates whether the bundled product offering represents a single product offering (false) or a bundle of product offerings (true). e.g. true" } }, "description": "The relation between a bundle product offering entity and its bundled product offering entities" }, "BundledProductOfferingGroupOption": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the bundled product offering option. e.g. HD Streaming" }, "localizedName": { "type": "string", "description": "The localized name of the bundled product offering option. e.g. HD Streaming" }, "description": { "type": "string", "description": "The description of bundled product offering option. e.g. With HD Streaming, you can stream videos in High Definition" }, "groupOptionId": { "type": "string", "description": "Generated bundled product offering option id." }, "bundledProductOffering": { "type": "array", "description": "The bundled product offerings included in this group option.", "items": { "$ref": "#/components/schemas/BundledProductOffering" } }, "category": { "type": "array", "description": "Required=false, A reference to an category. e.g. Refer CategoryRef model for category attributes and example values", "items": { "$ref": "#/components/schemas/CategoryRef" } }, "numberRelOfferLowerLimit": { "type": "string", "description": "The lower limit of the number of related offers that can be purchased as part of the bundle offering. e.g. 1" }, "numberRelOfferUpperLimit": { "type": "string", "description": "The upper limit of the number of related offers that can be purchased as part of the bundle offering. e.g. 3" } }, "description": "Required=false, list of product BundledProductOfferingGroupOption Details." }, "Characteristic": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "CharacteristicValue": { "required": [ "entry", "localizedValue", "value" ], "type": "object", "properties": { "value": { "type": "string", "description": "Required=true, The value of the characteristic. e.g. Pay_on_Bill" }, "localizedValue": { "type": "string", "description": "Required=true, The localized product offering characteristic name. e.g. Pay on Bill" }, "descriptiveCharacteristicsMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/Metadata" } }, "entry": { "type": "array", "description": "Required=true, Contains list of key-value pair.", "items": { "$ref": "#/components/schemas/KeyValuePair" } }, "default": { "type": "boolean" } }, "description": "The available values of the descriptive characteristic" }, "CompatibleDevice": { "type": "object", "properties": { "name": { "type": "string", "description": "Required=false, The value of name" }, "variantGroup": { "type": "string", "description": "Required=false, The value of variantGroup" }, "id": { "type": "string", "description": "Required=false, The ID of the variant group offerings. e.g. 135b1da7-e54f-477a-bd14-a5505eddb20c" }, "variantCharacteristics": { "type": "array", "description": "Required=true, The varient characteristics. e.g. The reference to the list of VariantCharacteristics objects", "items": { "$ref": "#/components/schemas/VariantCharacteristics" } } }, "description": "The available values of Compatible Devices" }, "ComponentOperations": { "type": "object", "properties": { "id": { "type": "string" }, "operationName": { "type": "string" } } }, "Constraint": { "type": "object", "properties": { "id": { "type": "string" }, "characteristic": { "type": "array", "items": { "$ref": "#/components/schemas/Characteristic" } } }, "description": "The Constraint resource represents a policy/rule applied to ProductOfferingPrice" }, "ImmediatePayOption": { "type": "object", "properties": { "payOption": { "type": "string", "description": "The immediate pay option: