{ "openapi": "3.1.2", "info": { "title": "Products and Offers API", "description": "Products and Offers API can be used to search bundle offer consisting of plans, addons and promotions. This will also provide lookup APIs for addons, devices, sims, offers.", "version": "1.0.5", "contact": { "name": "Omni API Support", "email": "DL-OmniAdapter@att.com" } }, "servers": [ { "url": "https://partner.att.com/omni-svcs" } ], "security": [], "tags": [ { "name": "Product And Offers", "description": "Product And Offers API for searching product offerings" }, { "name": "Promotions APIs", "description": "Apis for searching Promotions" } ], "paths": { "/v1/offers/search": { "post": { "tags": [ "Product And Offers" ], "x-tags": [ "Wireless", "Fiber-Provide-Consumer", "Fiber-Change-Consumer", "Fiber-Move-Consumer", "Fiber-Provide-Business", "Fiber-Change-Business" ], "summary": "Retrieve list of product offers based on eligibility and filter criteria.", "description": "Retrieve list of product offers based on eligibility and filter criteria. Appropriate promotions/rewards cards will be returned based on service address, channel and customer's intent.", "operationId": "getProductOfferings", "parameters": [ { "$ref": "#/components/parameters/ParameterAppname" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOfferingRequest" }, "examples": { "Broadband SMB_CRP BasePlans": { "x-tags": [ "Fiber-Change-Business" ], "value": { "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "subChannelGroup", "value": "National Retail" }, { "name": "subChannel", "value": "Best Buy" }, { "name": "agentId", "value": "s12345" } ] }, "productOfferingTypeGroup": "BBOffers", "customerType": "BUSINESS", "billingAccountNumber": "124865774", "intent": "CHANGE" } }, "Broadband SMB_CRP Addons": { "x-tags": [ "Fiber-Change-Business" ], "value": { "channel": { "id": "IND", "name": "IND", "extensions": [ { "name": "subChannelGroup", "value": "National Retail" }, { "name": "subChannel", "value": "Best Buy" }, { "name": "agentId", "value": "s12345" } ] }, "productOfferingTypeGroup": "BBAddons", "relatedProductOfferingId": "ibbndl_prod11480227_prod9310299_prod9040808", "customerType": "BUSINESS", "billingAccountNumber": "124865774", "intent": "CHANGE" } }, "lookupById": { "value": { "ids": [ "06c387fb-bfd5-4287-a1e8-b9da4c0be06e" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOfferingResponse" }, "examples": { "Broadband SMB CRP base offers": { "x-tags": [ "Fiber-Change-Business" ], "$ref": "#/components/examples/PnO_SMB_CRP_BB_BaseOffers" }, "lookup-by-ids": { "value": { "offers": [ { "id": "06c387fb-bfd5-4287-a1e8-b9da4c0be06e", "name": "Value Plus VL", "localizedName": "Value Plus VL", "description": "Value Plus VL", "href": "/msapi/productoffer/discovery/v1/product-offers/06c387fb-bfd5-4287-a1e8-b9da4c0be06e?channel=ATTR", "productOfferingType": "Mobile_Offer", "productOfferingTypeGroup": "mobileOffer", "mustBeBundled": false, "isBundle": true, "bundledProductOffering": [ { "id": "75c62382-0601-40a9-bc0b-05e7e153fa38", "name": "Value Plus VL", "localizedName": "Value Plus VL", "href": "/msapi/productoffer/discovery/v1/product-offers/75c62382-0601-40a9-bc0b-05e7e153fa38?channel=ATTR", "description": "Value Plus VL", "productOfferingType": "Mobile_Plan", "productOfferingTypeGroup": "mobilePlan", "isBundle": false } ], "productOfferingCharacteristic": [ { "name": "Included_Services", "localizedName": "", "valueType": "" }, { "name": "Auto_Pay_Enrollment", "localizedName": "", "valueType": "", "value": [ { "value": "Y", "localizedValue": "Yes", "default": true }, { "value": "N", "localizedValue": "No", "default": false } ] }, { "name": "TenderType", "localizedName": "", "valueType": "", "value": [ { "value": "ACH", "localizedValue": "ACH", "default": false }, { "value": "NA", "localizedValue": "NA", "default": false }, { "value": "CreditCard", "localizedValue": "Credit Card", "default": false }, { "value": "DebitCard", "localizedValue": "Debit Card", "default": false } ] }, { "name": "Benefits", "localizedName": "", "valueType": "", "value": [ { "value": "", "localizedValue": "", "default": false } ] }, { "name": "Payment_Type", "localizedName": "", "valueType": "", "value": [ { "value": "Pay_on_Bill", "localizedValue": "Pay on Bill", "default": false } ] }, { "name": "Payment_Method", "localizedName": "", "valueType": "", "value": [ { "value": "Credit", "localizedValue": "Credit", "default": false } ] }, { "name": "firstRCPaymentOption", "localizedName": "", "valueType": "" }, { "name": "paymentTiming", "localizedName": "", "valueType": "" }, { "name": "billingProfile", "localizedName": "", "valueType": "", "value": [ { "value": "hassleFree", "localizedValue": "Hassle Free Profile", "default": false } ] }, { "name": "prorationPolicy", "localizedName": "", "valueType": "" }, { "name": "productType", "localizedName": "", "valueType": "", "value": [ { "value": "WIRELESS", "localizedValue": "WIRELESS", "default": false } ] }, { "name": "Highlights", "localizedName": "", "valueType": "", "value": [ { "value": "", "localizedValue": "", "default": false } ] }, { "name": "commissionable", "localizedName": "", "valueType": "", "value": [ { "value": "0", "localizedValue": "No", "default": true }, { "value": "1", "localizedValue": "Yes", "default": false } ] }, { "name": "chargebackEligible", "localizedName": "", "valueType": "", "value": [ { "value": "0", "localizedValue": "No", "default": true }, { "value": "1", "localizedValue": "Yes", "default": false } ] } ], "productOfferingRelationship": [ { "id": "209336ae-1e65-4697-b195-c1f87ab70b3d", "name": "Wireless_Addons", "relationshipType": "commercialRelation", "role": "addOn" }, { "id": "50a7a50b-3d92-4658-b8ea-2eda8ec1e48d", "name": "Wireless_Bundles_with_Active_Armor_POs", "relationshipType": "commercialRelation", "role": "addOn" } ], "validFor": { "startDateTime": "2024-03-04T06:00:00Z" }, "productOfferingTotalPrice": [ { "priceType": "RC", "recurringChargePeriod": "month", "recurringChargePeriodLength": 1, "price": { "dutyFreeAmount": { "unit": "USD", "value": 60.99 } }, "finalPrice": { "dutyFreeAmount": { "unit": "USD", "value": 60.99 } }, "standalonePrice": { "dutyFreeAmount": { "unit": "USD", "value": 60.99 } }, "taxIncluded": "Excluded" } ], "bundledProductOfferingGroupOption": [ { "groupOptionId": "3405d3a9-b60a-11ef-ae7c-ed7e3dc40175", "description": "Select SIM Card", "bundledProductOffering": [ { "id": "790650ec-b512-4bee-ae7f-535668eadf1b", "name": "eSIM Activation", "localizedName": "eSIM Activation", "href": "/msapi/productoffer/discovery/v1/product-offers/790650ec-b512-4bee-ae7f-535668eadf1b?channel=ATTR", "description": "Subscriber Identity Module card for eSIM", "productOfferingType": "SIM", "productOfferingTypeGroup": "sim" } ] }, { "groupOptionId": "3405d3aa-b60a-11ef-ae7c-27965683c6f2", "description": "Select Device", "bundledProductOffering": [ { "id": "c9715944-afed-42eb-a35f-51c2ced6bea4", "name": "Bring Your Own Phone", "localizedName": "Bring Your Own Phone", "href": "/msapi/productoffer/discovery/v1/product-offers/c9715944-afed-42eb-a35f-51c2ced6bea4?channel=ATTR", "description": "Product Offer which is used to store device information, when Subscriber did not purchase its device from APP, but bring his/her own device", "productOfferingType": "Mobile_Device", "productOfferingTypeGroup": "mobileDevice", "isBundle": false } ] } ] } ] } } } } } }, "400": { "description": "Bad request - Missing fields, Invalid input data, validation failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "MissingFields": { "summary": "Missing fields", "value": { "error": { "errorId": "EXTPNO-OFFERS-0001", "message": "Required fields are missing", "errorSystemId": "extpartnerproductoffersdiscovery", "details": [ { "code": "INT-0011", "message": "serviceAddressId is required" } ] } } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedPartnerServiceError" }, "examples": { "ProductOffersSystemError": { "summary": "System Error", "value": { "error": { "errorId": "EXTPNO-OFFERS-CPOPOFFER-0002", "message": "Downstream service error occurred while fetching product offerings", "errorSystemId": "cpopoffer", "details": [ { "code": "CPOP_BROADBAND_EDS_ERROR", "message": "Error occurred while retrieving the product offer details" } ] } } }, "ProductOffersAIAError": { "summary": "AIA Error", "value": { "error": { "errorId": "EXTPNO-OFFERS-CPOPOFFER-0006", "message": "Unsupported Flow", "errorSystemId": "extpartnerproductoffersdiscovery", "details": [ { "code": "INT-0010", "message": "AIA is not supported yet, please switch to regular AT&T internet AIR flow" } ] } } } } } } } } } } }, "components": { "schemas": { "ProductOfferingRequest": { "type": "object", "properties": { "ids": { "description": "Lookup by Ids. IDs is a list of productOfferingIDs to retrieve details. e.g. 06c387fb-bfd5-4287-a1e8-b9da4c0be06e", "type": "array", "items": { "type": "string" } }, "limit": { "description": "Max number of productOffering details to be returned in response. Not used when ids query param is populated.", "type": "integer", "format": "int32", "default": 50 }, "offset": { "description": "Page number of productOffering details response. Not used when ids query param is populated.", "type": "integer", "format": "int32", "default": 0 }, "channel": { "$ref": "#/components/schemas/SalesChannel" }, "relatedProductOfferingId": { "description": "Product Offering Id needs to be passed to return compatible products. Pass device offering id to get compatible mobile_offers. Pass mobile_offers to get compatible addons.", "maxLength": 100, "minLength": 1, "type": "string", "example": "06c387fb-bfd5-4287-a1e8-b9da4c0be06e" }, "productOfferingTypeGroup": { "type": "string", "enum": [ "mobilePlan", "mobileAddon", "mobileDevice", "mobileOffer", "sim", "BBAddons", "BBOffers" ], "example": "BBOffers" }, "customerType": { "description": "Customer Type to be used for fetching compatible offers. e.g. CONSUMER, IRU, CRU.", "type": "string", "enum": [ "CONSUMER", "IRU", "CRU", "BUSINESS" ] }, "cartId": { "description": "Cart Id", "type": "string", "example": "1111-12333333" }, "ctn": { "description": "Customer telephone number if available for wireless flow - AL, UP", "type": "string", "example": "4694561111" }, "flowTypes": { "description": "List of Flow types to be used for fetching compatible offers. e.g. NEW, AL, UP.", "type": "array", "items": { "type": "string", "enum": [ "NEW", "AL", "UP" ] } }, "BYOD": { "type": "object", "description": "Search for offers based on BYOD device model", "properties": { "edModels": { "type": "string", "example": "iPh11PMA2161" } } }, "deviceType": { "type": "array", "description": "Fetch offers for wireless deviceType: Phone, Tablet, Wearable, etc.", "items": { "type": "string", "example": "Phone", "enum": [ "Phone", "Tablet", "Wearable" ] } }, "lineCount": { "type": "number", "description": "Number of lines that customer wants to add in the cart so that adjusted plan prices can be returned" }, "serviceAddressId": { "type": "string", "description": "Service Address Id to be used for filtering fiber offers that can be offered at that address", "example": "12345" }, "billingAccountNumber": { "type": "string", "description": "Customer Billing Account Number", "example": "123456789" }, "intent": { "type": "string", "description": "Intent of the flow example: MOVE, CHANGE, for New Provide flow this will be empty", "example": "MOVE" } } }, "ProductOfferingResponse": { "type": "object", "properties": { "offers": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOffering" } } } }, "ProductOffering": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the product offer, use this for adding to cart or for fetching addons based on this product offer", "example": "06c387fb-bfd5-4287-a1e8-b9da4c0be06e" }, "name": { "type": "string", "description": "Name of the product offer", "example": "Value Plus VL" }, "localizedName": { "type": "string", "description": "Localized name of the product offer based on channel locale", "example": "Value Plus VL" }, "description": { "type": "string", "description": "Description of the product offer", "example": "Value Plus VL" }, "productOfferingType": { "type": "string", "description": "Type of the product offer", "example": "BB_Offer, Mobile_Offer" }, "productOfferingTypeGroup": { "type": "string", "description": "Product offering type is part of this group e.g. mobilePlan, mobileAddon, mobileDevice, mobileOffer, sim, BBOffer, BBPlan, BBInstallation, BBHomeTechProtectionPlan, BBREWARD", "example": "BBOffer" }, "broadbandFactsUrl": { "type": "string", "description": "Url for broadband nutrition label facts for the offer if taxation geocode can be determined from address", "example": "https://test2.att.com/static-content-service-ui/v1/labelfeed/shared/nutrition/CONS/85333ec5-e9aa-4c8e-b886-04afb19e4a6a?taxationgeocode=261830000" }, "bundledProductOffering": { "type": "array", "description": "List of bundled product offers that are part of this product offer", "items": { "$ref": "#/components/schemas/BundledProductOffering" } }, "productOfferingTotalPrice": { "type": "array", "description": "Total price of the bundled offers including promotions", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "bundledProductOfferingGroupOption": { "type": "array", "description": "Shows if multiple options are available of which only one or more needs to be selected e.g. SelfInstallation and TechInstallation", "items": { "$ref": "#/components/schemas/BundledProductOfferingGroupOption" } }, "immediatePromotion": { "type": "array", "description": "List of applicable promotions", "items": { "$ref": "#/components/schemas/ImmediatePromotionRef" } }, "productOfferingCharacteristic": { "type": "array", "description": "List of characteristics of the product offer", "items": { "$ref": "#/components/schemas/ProductOfferingCharacteristic" } } } }, "ImmediatePromotionRef": { "type": "object", "properties": { "id": { "type": "string", "description": "Promotion instance Id, used for referencing promotions in priceAlterations", "example": "62900028" }, "status": { "type": "string", "description": "Status of the promotion application", "example": "add", "enum": [ "add", "keep", "revoke", "update" ] }, "promotion": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the promotion", "example": "wrlnpr-62900028" }, "name": { "type": "string", "description": "Name of the promotion", "example": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a bank account. Or $5/mo. with a debit card." }, "description": { "type": "string", "description": "Description of the promotion", "example": "Price includes $10/mo. discount when you sign up for paperless billing and AutoPay with a bank account. Or $5/mo. with a debit card." }, "type": { "type": "string", "description": "Type of the promotion", "example": "discount" }, "applyPolicy": { "type": "string", "description": "Policy for applying the promotion can be manual or automatic", "example": "automatic" }, "promotionCharacteristics": { "type": "array", "description": "List of characteristics of the promotion", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "duration" }, "value": { "type": "string", "example": "999" } } } } } } } }, "ProductOfferingCharacteristic": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the product offer characteristic", "example": "Payment_Type" }, "localizedName": { "type": "string", "description": "Localized name of the product offer characteristic", "example": "" }, "valueType": { "type": "string", "description": "Value type of the product offer characteristic useful for parsing values of number, or boolean type", "example": "" }, "value": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "example": "Pay_on_Bill" }, "localizedValue": { "type": "string", "example": "Pay on Bill" }, "default": { "type": "boolean", "example": false } } } } } }, "ProductOfferingPrice": { "type": "object", "properties": { "name": { "type": "string", "description": "Optional field depicting Name of the price", "example": "Easy self-setup kit Price" }, "priceCategory": { "type": "string", "description": "Optional field depicting Price category", "example": "serviceRC" }, "priceType": { "type": "string", "description": "Price type", "example": "RC" }, "recurringChargePeriod": { "type": "string", "description": "Recurring charge period", "example": "month", "enum": [ "month", "week" ] }, "recurringChargePeriodLength": { "type": "number", "description": "Length of the recurring charge period", "example": 1 }, "role": { "type": "string", "description": "Role of the price", "example": "Price", "enum": [ "Price", "Bundle Price Alteration" ] }, "price": { "$ref": "#/components/schemas/PriceRef" }, "finalPrice": { "$ref": "#/components/schemas/PriceRef" }, "standalonePrice": { "$ref": "#/components/schemas/PriceRef" }, "priceAlteration": { "type": "array", "description": "List of price alterations that are applied on the price such as promotions", "items": { "$ref": "#/components/schemas/PriceAlterationRef" } }, "productOfferingPrice": { "type": "object", "description": "Hyperlocal Pricing Strategy attributes", "properties": { "id": { "type": "string", "description": "Hyperlocal pricing strategy id", "example": "SO003" }, "name": { "type": "string", "description": "Hyperlocal pricing strategy name", "example": "South East LA" }, "priceType": { "type": "string", "description": "Hyperlocal pricing strategy price type", "example": "Subsidy" } } }, "periodCoverage": { "type": "object", "description": "Hyperlocal Pricing Strategy attributes", "properties": { "startDateTime": { "type": "string", "description": "Start date and time of the hyperlocal pricing strategy", "example": "2024-01-01T00:00:00Z" }, "endDateTime": { "type": "string", "description": "End date and time of the hyperlocal pricing strategy", "example": "2024-12-31T23:59:59Z" } } }, "taxIncluded": { "type": "string", "description": "Indicates whether the price includes tax or not", "example": "Excluded" } } }, "PriceRef": { "type": "object", "properties": { "dutyFreeAmount": { "type": "object", "description": "Price amount without tax", "properties": { "unit": { "type": "string", "description": "Currency unit of the price amount, if this field is empty assume USD", "example": "USD" }, "value": { "description": "Numeric value of the price amount", "type": "number" } } }, "marketingAmount": { "type": "object", "description": "Marketing amount is the price which business wants to show to customer which may exclude certain limited time promotions to show more accurate price over longer duration", "properties": { "unit": { "type": "string", "description": "Currency unit of the marketing amount, if this field is empty assume USD", "example": "USD" }, "value": { "type": "number", "description": "Numeric value of the marketing amount", "example": 60.99 } } } } }, "BundledProductOfferingGroupOption": { "type": "object", "description": "Shows if multiple options are available of which only one or more needs to be selected e.g. SelfInstallation and TechInstallation", "properties": { "groupOptionId": { "type": "string", "example": "3405d3aa-b60a-11ef-ae7c-27965683c6f2" }, "description": { "type": "string", "description": "Description of the group option", "example": "Select Device" }, "bundledProductOffering": { "type": "array", "description": "List of bundled product offers that are part of this group option", "items": { "$ref": "#/components/schemas/BundledProductOffering" } } } }, "BundledProductOffering": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the bundled product offering", "example": "c9715944-afed-42eb-a35f-51c2ced6bea4" }, "name": { "type": "string", "description": "Name of the bundled product offering", "example": "Bring Your Own Phone" }, "description": { "type": "string", "description": "Description of the bundled product offering", "example": "Bring Your Own Phone" }, "productOfferingType": { "type": "string", "description": "Type of the bundled product offering", "example": "Mobile_Device" }, "productOfferingTypeGroup": { "type": "string", "description": "Group of the bundled product offering type", "example": "mobileDevice" }, "bundledProductOfferingOption": { "type": "array", "description": "List of options available for the bundled product offering", "items": { "$ref": "#/components/schemas/BundledProductOfferingOption" } }, "conflictingProductOfferIds": { "type": "array", "description": "List of IDs of conflicting product offers for the bundled product offering", "items": { "type": "string", "description": "Product offer ID of a conflicting product offer" } }, "productOfferingTotalPrice": { "type": "array", "description": "Total price of the bundled product offering including promotions", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } } } }, "BundledProductOfferingOption": { "type": "object", "description": "Pricing options for bundled product", "properties": { "numberRelOfferDefault": { "type": "integer", "description": "Default number of related offers to include when selecting this option" }, "numberRelOfferLowerLimit": { "type": "integer", "description": "Lower limit for number of related offers that can be selected" }, "numberRelOfferUpperLimit": { "type": "integer", "description": "Upper limit for number of related offers that can be selected" }, "productOfferingPrice": { "type": "array", "description": "Price of all bundled products and price alterations with promotion references", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "productOfferingTotalPrice": { "type": "array", "description": "Total price of all bundled products with aggregated price alterations by price type", "items": { "$ref": "#/components/schemas/ProductOfferingPrice" } }, "productOfferingCharacteristic": { "type": "array", "description": "Bundled product offer options characteristics", "items": { "$ref": "#/components/schemas/ProductOfferingCharacteristic" } } } }, "PriceAlterationRef": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the price e.g. Discount", "example": "Discount" }, "priceType": { "type": "string", "description": "Price type of the price alteration e.g. RC, OC", "example": "RC" }, "immediatePromotionId": { "type": "string", "description": "Reference to the promotion instance Id that is applied as part of this price alteration", "example": "RC" }, "chargeType": { "type": "string", "description": "Charge type of the price alteration", "example": "credit", "enum": [ "credit", "debit", "discount" ] }, "price": { "type": "object", "description": "Price alteration amount", "properties": { "dutyFreeAmount": { "type": "object", "properties": { "unit": { "type": "string", "description": "Unit of price", "example": "USD" }, "value": { "type": "number", "description": "Numeric value of the price alteration", "example": 10 } } } } } } }, "PromotionEligibilityRequest": { "type": "object", "properties": { "imei": { "type": "string", "description": "Device IMEI number. Used to uniquely identify a device for trade-in eligibility." }, "make": { "type": "string", "description": "Device manufacturer (e.g., Apple, Samsung). Required if IMEI is not provided." }, "model": { "type": "string", "description": "Device model name (e.g., iPhone 12 Pro). Required if IMEI is not provided." }, "capacity": { "type": "string", "description": "Device storage capacity (e.g., 128GB). Required if IMEI is not provided." }, "qualificationType": { "type": "string", "enum": [ "Trade-In" ], "description": "Type of qualification to check. Only 'Trade-In' is currently supported." }, "deviceBillCode": { "type": "string", "description": "Device bill code. Used to identify the device for billing and trade-in purposes." }, "flowType": { "type": "string", "description": "Flow type for the trade-in process. Allowed values: AL (Add Line), UP (Upgrade), NEW (New Line).", "enum": [ "AL", "UP", "NEW" ] }, "tradeInModelCode": { "type": "string", "description": "Internal code representing the trade-in device model. Used if IMEI is not provided." }, "deviceConditionAnswers": { "type": "array", "description": "List of answers to device condition questions (e.g., is device functional, powered on, etc.). Each item contains a question name and an array of answer values.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the device condition question (e.g., ATT_GENERIC, LCD_FUNCTIONALITY)." }, "value": { "type": "array", "description": "Array of answers for the question (e.g., ['Yes'], ['No']).", "items": { "type": "string" } } } } } } }, "ProductFamilyItem": { "type": "object", "properties": { "tradeInModelCode": { "type": "string", "description": "Internal code representing the specific trade-in device model. Used to identify the model for trade-in eligibility and processing." }, "capacity": { "type": "string", "description": "Device storage capacity (e.g., 64GB, 128GB, 256GB). Indicates the storage size of the device model." }, "name": { "type": "string", "description": "Device name. Indicates the name of the device model." } }, "questions": { "type": "array", "description": "List of trade-in device questions relevant for this device category. Each question includes code, text, help, and valid answers.", "items": { "$ref": "#/components/schemas/TradeinDeviceQuestions" } } }, "Model": { "type": "object", "properties": { "name": { "type": "string", "description": "Device model name (e.g., iPhone 12 Pro, Galaxy S21). Identifies the specific model within a make." }, "productFamily": { "type": "array", "description": "List of product family items for this model, each representing a variant (e.g., different storage capacities) of the model.", "items": { "$ref": "#/components/schemas/ProductFamilyItem" } } } }, "Make": { "type": "object", "properties": { "name": { "type": "string", "description": "Device manufacturer name (e.g., Apple, Samsung, Google). Identifies the brand or make of the device." }, "models": { "type": "array", "description": "List of device models available for this make. Each model contains its own variants and product family information.", "items": { "$ref": "#/components/schemas/Model" } } } }, "TradeinDeviceQuestions": { "type": "object", "properties": { "questionCode": { "type": "string", "description": "Unique code identifying the trade-in device question (e.g., ATT_GENERIC, POWER_ON, LCD_FUNCTIONALITY, DEACTIVATED).", "example": "Yes" }, "text": { "type": "string", "description": "The text of the question presented to the user (e.g., 'Is your device in good condition?').", "example": "Is your device in good condition?" }, "helpText": { "type": "string", "description": "Additional help or guidance text for the question, explaining what is meant or what to consider when answering.", "example": "Select if the following are true: >It turns on and off, and functions normally >The buttons and cameras work It’s free of dents and scratches >The touchscreen and back glass aren’t damaged" }, "validAnswers": { "type": "array", "description": "List of valid answers for the question. Each answer includes the answer text and associated code.", "items": { "$ref": "#/components/schemas/ValidAnswers" } } } }, "ValidAnswers": { "type": "object", "properties": { "answerText": { "type": "string", "description": "Text of the valid answer option for the question (e.g., 'Yes', 'No').", "example": "Yes" }, "questionCode": { "type": "string", "description": "Code of the question this answer is associated with (e.g., ATT_GENERIC, POWER_ON).", "example": "ATT_GENERIC" } } }, "DeviceCategory": { "type": "object", "properties": { "category": { "type": "string", "description": "Device category type (e.g., phone, tablet, wearable, other). Identifies the general class of device.", "enum": [ "phone", "tablet", "wearable", "other" ] }, "makes": { "type": "array", "description": "List of primary device makes (manufacturers) for this category (e.g., Apple, Samsung). Each make contains its models.", "items": { "$ref": "#/components/schemas/Make" } }, "otherMakes": { "type": "array", "description": "List of additional or less common device makes for this category.", "items": { "$ref": "#/components/schemas/Make" } } } }, "TradeInDetails": { "type": "object", "properties": { "devices": { "type": "array", "description": "List of device categories eligible for trade-in. Each item represents a device category (e.g., phone, tablet, wearable) and includes associated questions, makes, and other makes.", "items": { "$ref": "#/components/schemas/DeviceCategory" } } } }, "QualificationResponse": { "type": "object", "description": "Root payload describing qualification results.", "properties": { "qualificationType": { "type": "string", "description": "Type of qualification (e.g., Trade-in).", "enum": [ "Trade-In" ] }, "potentialQualificationItem": { "type": "array", "description": "Collection of qualification items that may qualify for promotions.", "items": { "$ref": "#/components/schemas/PotentialQualificationItem" } } } }, "PotentialQualificationItem": { "type": "object", "description": "A single potential qualification item including characteristics and promotions.", "properties": { "characteristic": { "type": "array", "description": "Key/value characteristics of the item (e.g., model, value).", "items": { "$ref": "#/components/schemas/KeyValueObject" } }, "potentialPromotion": { "type": "array", "description": "List of promotions potentially applicable to this item.", "items": { "$ref": "#/components/schemas/PotentialPromotion" } } } }, "PotentialPromotion": { "type": "object", "description": "Wrapper describing a potential promotion reference and its details.", "properties": { "id": { "type": "string", "description": "Identifier of the potential promotion entry.", "example": "wrlspr-29966" }, "promotion": { "$ref": "#/components/schemas/Promotion" } } }, "Promotion": { "type": "object", "description": "Detailed promotion payload with characteristics.", "properties": { "id": { "type": "string", "description": "Unique identifier for the promotion. Used to reference and distinguish each promotion entry.", "example": "wrlspr-29966" }, "name": { "type": "string", "description": "Human-readable name or summary of the promotion. Provides a brief description for display purposes.", "example": "OFFER APPLIED: You're getting up to $350 off with elig. trade-in on installment & elig. unlimited plan (speed restr's apply). Credits start within 3 bills. Without unlimited, device is full price." }, "promotionCharacteristics": { "type": "array", "description": "List of characteristics (attributes) associated with the promotion. Each item describes a specific property of the promotion, such as maximum value, duration, or eligibility criteria.", "items": { "$ref": "#/components/schemas/PromotionCharacteristic" } } } }, "PromotionCharacteristic": { "type": "object", "description": "Name/value pair describing a promotion attribute.", "properties": { "name": { "type": "string", "description": "Promotion characteristic name.", "example": "maxValue" }, "value": { "type": "string", "description": "Promotion characteristic value (string representation to match payload).", "example": "129.99" } } }, "SalesChannel": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of a channel eg. IND." }, "name": { "type": "string", "description": "Name of the channel eg. IND." }, "extensions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the characteristic", "enum": [ "subChannelGroup", "subChannel", "agentId" ] }, "value": { "type": "string", "description": "Value of the characteristic" } } } } }, "description": "Sales channel through which the customer is being served." }, "PartnerServiceError": { "type": "object", "properties": { "errorId": { "type": "string", "example": "Top level error code" }, "message": { "type": "string", "example": "Top level error message" }, "errorSystemId": { "type": "string", "example": "System name" }, "details": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "example": "Detail code 1" }, "message": { "type": "string", "example": "Detail message 1" } } } } } }, "WrappedPartnerServiceError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/PartnerServiceError" } } }, "KeyValueObject": { "required": [ "value" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the characteristic" }, "value": { "type": "string", "description": "Value of the characteristic" } }, "description": "Describes a characteristic of an object or entity using a name/value pair." } }, "parameters": { "ParameterAppname": { "name": "appname", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Application name making the request" } }, "examples": { "PnO_SMB_CRP_BB_BaseOffers": { "value": { "offers": [ { "id": "ibbndl_prod11480227_prod9310299_prod9040808", "name": "AT&T Business Fiber 2000", "localizedName": "AT&T Business Fiber 2000", "description": "Ultrafast speed and bandwidth to support next-gen businesses and smart-office technologies", "href": "/msapi/productoffer/discovery/v1/product-offers/ibbndl_prod11480227_prod9310299_prod9040808?channel=SelfService", "productOfferingType": "BB_Offer", "productOfferingTypeGroup": "BBOffer", "bundledProductOffering": [ { "id": "prod11480227", "name": "AT&T Business Fiber 2000", "description": "Ultrafast speed and bandwidth to support next-gen businesses and smart-office technologies", "productOfferingType": "BB_Plan", "productOfferingTypeGroup": "BBPlan", "bundledProductOfferingOption": [ { "numberRelOfferDefault": 1, "numberRelOfferLowerLimit": 1, "numberRelOfferUpperLimit": 1, "productOfferingPrice": [ { "name": "AT&T Business Fiber 2000 Price", "priceType": "RC", "recurringChargePeriod": "month", "recurringChargePeriodLength": 1, "role": "Price", "price": { "dutyFreeAmount": { "unit": "USD", "value": 1000 } }, "finalPrice": { "dutyFreeAmount": { "unit": "USD", "value": 185 }, "marketingAmount": { "unit": "USD", "value": 185 } }, "priceAlteration": [ { "name": "Discount", "priceType": "RC", "chargeType": "credit", "immediatePromotionId": "60400046", "price": { "dutyFreeAmount": { "unit": "USD", "value": 815 } } } ], "taxIncluded": "Excluded" } ], "productOfferingTotalPrice": [ { "name": "AT&T Business Fiber 2000 Price", "priceType": "RC", "recurringChargePeriod": "month", "recurringChargePeriodLength": 1, "role": "Price", "price": { "dutyFreeAmount": { "unit": "USD", "value": 1000 } }, "finalPrice": { "dutyFreeAmount": { "unit": "USD", "value": 185 }, "marketingAmount": { "unit": "USD", "value": 185 } }, "priceAlteration": [ { "name": "Discount", "priceType": "RC", "chargeType": "credit", "price": { "dutyFreeAmount": { "unit": "USD", "value": 815 } } } ], "taxIncluded": "Excluded" } ] } ] } ], "productOfferingCharacteristic": [ { "name": "displayName", "localizedName": "displayName", "valueType": "String", "value": [ { "value": "AT&T Business Fiber 2000", "localizedValue": "AT&T Business Fiber 2000", "default": false } ] }, { "name": "rank", "localizedName": "rank", "valueType": "String", "value": [ { "value": "3", "localizedValue": "3", "default": false } ] }, { "name": "pricePlanCode", "localizedName": "pricePlanCode", "valueType": "String", "value": [ { "value": "33311", "localizedValue": "33311", "default": false } ] }, { "name": "hsiaSwimlane", "localizedName": "hsiaSwimlane", "valueType": "String", "value": [ { "value": "0", "localizedValue": "0", "default": false } ] }, { "name": "shortDisplayName", "localizedName": "shortDisplayName", "valueType": "String", "value": [ { "value": "Business Fiber 2000", "localizedValue": "Business Fiber 2000", "default": false } ] }, { "name": "omsProductCode", "localizedName": "omsProductCode", "valueType": "String", "value": [ { "value": "2000m2000mg", "localizedValue": "2000m2000mg", "default": false } ] }, { "name": "downloadSpeed", "localizedName": "downloadSpeed", "valueType": "String", "value": [ { "value": "2 Gbps", "localizedValue": "2 Gbps", "default": false } ] }, { "name": "Benefits", "localizedName": "Benefits", "valueType": "String", "value": [ { "value": "
  • 2 GIG upload and download speeds
  • Ultrafast speed and bandwidth to support next-gen businesses and smart-office technologies
  • Includes built-in 5G internet backup
    • ", "localizedValue": "
  • 2 GIG upload and download speeds
  • Ultrafast speed and bandwidth to support next-gen businesses and smart-office technologies
  • Includes built-in 5G internet backup
    • ", "default": false } ] }, { "name": "applicableFeatures", "localizedName": "applicableFeatures", "valueType": "String", "value": [ { "value": "