Product Discovery
Endpoint
Productoffering details will be returned for the provided eligibility and/or filter
http
Query Parameters
- idsstringComma separated list of productOfferingIDs to retrieve details. e.g. ibbndl_prod11920327_prod8580387_rwd-43100015_prod9040405
- limitint32RequiredMax number of productOffering details to be returned in response. Not used when ids query param is populated.
- offsetint32RequiredPage number of productOffering details response. Not used when ids query param is populated.
- channelstringRequiredEnum: [SelfService, ATTR, ECOMM]Channel name of client. eg ATTR,ECOMM,SelfServiceLength: 100
- categoryNamestringEnum: [WBB_Plans, tobrInitiator, tobrAcceptor, Mobile_Devices, Mobile_Offers, Mobile_Accessories, Mobile_Addons, BB_Plans]Category name of productOffering. e.g. WBB_Plans, tobrInitiator, tobrAcceptor, Mobile_devices, BB_Plans. Required for retrieving device details.Length: 100
- serviceAddressIdstringPlace id of the primary service. Mandatory for WBB offer search. Not required when ids query param is populated. e.g. 00010LVFT8Length: 100
- productOfferingTypeGroupstringThe type group of the product offering. The values are used as defined from catalog e.g. WBBOffer, WBBPlan, equipmentLength: 100
- characteristicsstring<i>`conditionally required`</i><br/> Either __characteristics__ or __productOfferingId__ is required for getting the device details response. Characteristics key value pairs to filter the response. This value should be urlencoded. <br/> E.g. [{"Streaming":"Standard-definition"}], [{"uniqueUrlName"="apple-iphone-15-pro"}], %7BuniqueUrlName%3Dapple-iphone-15-pro%7D, [{"SKU"="XXXX"}],[{"SpecialSvc"="LWI"}],%7B%SpecialSvc%22%3A%22LWI%22%7D
- productOfferingIdstring<i>`conditionally required`</i><br/> productOfferingId for fetching the device details. Either __productOfferingId__ or __characteristics__ is required for fetching the device details. <br/> E.g. Mobile_Device_prod21068_sku21068v2
- cartIdstring<i>`conditionally required`</i><br/> The unique id associated with the cart. This is used to get the cart context. Required when getting the Addons for wireless <br/> E.g cb7605f0-9b3e-11ec-b7a2-b93d4c24b7bd
- productOrderItemIdstring<i>`conditionally required`</i><br/> The unique id associated with the productOrderItem present in the cart. Required when getting the Addons for wireless <br/> E.g ProductOrder_142274321286134385_OrderItem_777154531415434162
- migratedFromstringMigration indicator. e.g. ADSL
- relatedProductOfferingIdstringRelated entity ID to be used in retrieving related offers. e.g. ibbndl_prod11920327_prod8580387_rwd-43100015_prod9040405
- relationTypestringBusiness Relationship type. i.e. CommercialRelation
- relationRolestringBusiness Relationship role. i.e. addon,manualReward
- customerIdstringUnique identifier of the related party. e.g. 4c6c369e-cc46-44e7-b692-709d48fa2f42
- productIdstringThe the product's ID in the customer inventory. e.g. 202513607257576794
- customerTypestringCustomer type. e.g. Consumer, IRU, CRU, Business
- customerSubTypestringCustomer sub type. e.g. Individual, Consumer Small Office
- checkEligibilityForCouponstringCheck Eligibility For Coupon. e.g. ACTNOW
- contextTypestringCheck context type eg Order
- contextMainIdentifierstringCheck context type eg Order
- ACPClassificationstringEnum: [TRIBAL, NON_TRIBAL]Check ACP eligibility e.g TRIBAL, NON_TRIBAL
- actionTypestringSpecifies the action type e.g crp
- losgTypesstringEnum: [NEW, UP, AL]LosgTypes of productOffering. e.g. NEW, UP, ALLength: 100
- paymentTypestringEnum: [Prepaid, Postpaid]PaymentType of productOffering. e.g. Prepaid, PostpaidLength: 100
- offerTypesstringEnum: [standalone, tradein, standalone,tradein, bogo, abp]OfferTypes of productOffering. e.g standalone, tradein, bogo, abpLength: 100
- deviceProductIdsstringDeviceProductIds of productOffering. e.g. prod11070255Length: 100
- modestringEnum: [buyFlow, add, new, existing]Mode of productOffering. e.g. buyFlow,add,new,existingLength: 100
- allVariantsbooleanallVariants of productOffering
- lobsstringlobs of productOffering. e.g wireless, wirelineLength: 100
- productTypestringlob or execution flow. eg wireless, wireline
- atgSkuIdsstringskuId of the wireless product. eg sku6910280, sku6910280
- groupByVariantGroupstringIndicator to get all the variants of the wireless product. eg true, false
- imeiTypesstringimeiTypes of the wireless product. eg S6, R1
- skusstringskuId of the wireless product. eg sku6910280, sku6910280
- deviceSkuIdstringdeviceSkuId of the wireless product. eg sku6910280, sku6910280
- planSkuIdsstringplanSkuIds of the wireless product. eg sku6910280, sku6910280
- expandDatastring
- ctnstringCustomer telephone number. e.g. 7876758046. This is required for losgType=Up (upgrade).
- categoryTypestringe.g. ALL
- deviceCountstringDeviceCount e.g. 20
- planFirstFlowbooleanplanFirstFlow
- creditRiskstringCreditRisk e.g. low, medium, high
- referralCodestringCoupon code
- installationTypestringInstallationType. e.g. self, tech
- activeProductsstringActiveProducts for the customer Eg:Wireless, ADSL, HSIA
- transportTypesstringTo identify specific HSIA product type, the transport type is used eg: FTTN,IP-CO-BP,FTTP
- productOfferingOnlyboolean
- initiatorBanstringInitiator account. e.g. 523383275671
- deviceProductOfferingIdsstringDeviceProductOfferingIds. e.g. Mobile_Device_pkey97049_sku2470220
- deviceAllocationFlowboolean
- transferCtnsstringSubscriber number under initiator BAN. e.g. 6193956183,6193956184
- acceptorCtnstringSubscriber number under acceptor BAN. e.g. 2147252420,6193956184
- acceptorBanstringAcceptor account. e.g. 177070155016
- initiatorCustomerTypestringCustomer Type. e.g. Consumer, IRU, CRU
- marketstringCustomer market under acceptor account. e.g. DLS
- targetedPlancodestringTargeted plan code to which initiator subscriber will be moved. e.g. SDGMUX
- accessEligiblestringtrue/false based on user's eligibility for Access. true
- rootBundleProductOrderItemIdstringroot bundle product order item id of the Root Offer
- productOfferingGroupstringproduct Offering Group will determine which flow its BSSE or NoN BSSE
- productOfferingTypestringproduct Offering Type will determine which type of Product. example - Mobile_Device, Mobile_Sim, Mobile_Accessory
- dealerCodestringdealerCode will determine which type of dealer example - G6MDD
- fanIdstringfanId will determine which type of signature customer example - IRU/CRU [Conditional] Provide fanId OR combination of liabilityType, contractType, contractVersion for ASF client
- groupChangeInFocusstringthis param indicates that all the wls subscribers under the group needs available plans in the CRP journey. Example - G35110269
- liabilityTypestring[Conditional] Required with contractType & contractVersion when fanId absent for ASF
- contractTypestring[Conditional] Required with liabilityType & contractVersion when fanId absent for ASF. Example CBE
- contractVersionstring[Conditional] Required with liabilityType & contractType when fanId absent for ASF. Example P20
- channelCatalogstring[Conditional] Source catalog name is required for ASF. Example 'BMG Catalog'
- orderTransactionTypestringEnum: [New Activation, Device Upgrade, Offer Change, Device Change, Order Product Equipment][Conditional] Business transaction type is required for ASF
- subChannelstring[Conditional] Treated as the sales channel context in the system, you may pass multiple channel codes comma separated. sub-channel codes (sales context) is required for ASFExample: S3,S4
- partTypestringEnum: [ALL, LTE, UMTS, GSM, FEM]Device part type
- suppressSBAPricingstringEnum: [Y, N]Flag to suppress DevicePrice structure in device list response. Eg. "Y"
Header Parameters
- X-ATT-ClientIdstringRequiredDomain ID of calling application. e.g. MyATT-MAS,ccmuleLength: 100
- idpctx-appnamestringRequiredEnd UI application name. eg SF-SALES,onlineservices,myATTNativeLength: 100
- idpctx-uuidstringDomain ID of calling application. e.g. CheckoutMs,onlinesalesorch
- idpctx-linkeduverseaccnumsstringExisting Customer Ban Id in CRP flow. e.g: 639035473Length: 100
- idpctx-linkedwirelessaccnumsstringExisting Customer's Wireless Account Number in ACC flow. e.g: 177068635919Length: 100
- idpctx-acctinfocustypestringExisting customer's account type. e.g: WIRELESSLength: 100
- idpctx-acctinfocusstringExisting Customer's BAN focus. e.g: 177068635919Length: 100
- idpctx-agentidstringACC flow agent related Id e.g. att123Length: 100
- idpctx-storeidstringACC flow storeId e.g. 12334Length: 100
- idpctx-agentChannelstringACC flow agentChannel e.g. MSS, hellipLength: 100
- idpctx-x-akamai-edgescapestringFrom idpctx-x-akamai-edgescape will retrive zipCode e.g. qwudh
Body Parameters
Responses
Body
- objectRepresents entities that are orderable from the provider of the catalog, this resource includes pricing information.
- idstringRequiredRequired=true, The productoffering unique id. e.g. 52165303-5d47-4827-a51c-f7ab08570210Length: 100
- namestringRequiredRequired=true, The name or text id of the product offering. e.g. Unlimited 5G WBB Bundle
- localizedNamestringRequiredRequired=true, The localized name of the product offering. e.g. Unlimited 5G WBB Bundle
- descriptionstringRequired=false, The localized description of the product offering. e.g. Unlimited 5G WBB Bundle
- hrefstringRequiredRequired=true, The link to the productoffering. e.g. https://att.com/msapi/cpopoffer/v1/product-offers/417df8e3-2026-455b-aa79-03d3545e7f6d?channel=SelfService
- productOfferingTypestringRequiredEnum: [WBB_Offer, WBB_Plan, Rented_Equipment]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
- productOfferingTypeGroupstringRequiredEnum: [WBBOffer, WBBPlan, equipment]Required=false, The type group of the product offering. The values are used as defined from catalog e.g. WBBOfferLength: 100
- mustBeBundledbooleanRequiredRequired=true, Determines if the product offering can be sold as a standalone (false), or available only as part of a bundle or bundles (true). e.g. false
- isBundlebooleanRequiredRequired=true, Indicates whether the product offering represents a single product offering (false) or a bundle of product offerings (true). e.g. true
- categoryarray of objects
Required=false, A reference to an category. e.g. Refer CategoryRef model for category attributes and example values
The category of productoffering related to - variantGroupobjectProductOffering varient group
- bundledProductOfferingarray of objects
Required=false, The relation between a bundle product offering entity and its bundled product offering entities. e.g. Refer BundledProductOffering model for attributes and example values
The relation between a bundle product offering entity and its bundled product offering entities - productOfferingCharacteristicarray of objects
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
The list of the descriptive characteristics for the Discovery flows derived from the product offering and included in the product specification (if exists) - immediatePromotionarray of objects
Required=false, The reference to the promotion object. e.g. Refer ImmediatePromotion model for attributes and example values
ProductOffering immediate promotion object. TMF+ - productOfferingRelationshiparray of objects
Required=false, The relevant Business Relationship. e.g. Refer ProductOfferingRelationship model for attributes and example values
Product Offering Relationship - validForobjectRequiredvalidFor Object for validate start and end date of the related entity
- productOfferingTotalPricearray of objects
Required=false, The productoffer total price. e.g. Refer ProductOfferingPriceRefOrValue model for attributes and example values
ProductOffering DiscoveryPrice - productOfferingPricearray of objects
Required=false, The productoffer price. e.g. Refer ProductOfferingPriceRefOrValue model for attributes and example values
ProductOffering DiscoveryPrice - cmsInfoarray of objects
Required=false, list of cmsInfo Details. This is only applicable for wirelesss devices and accessories.This is returned only in lookup api where productOfferingIDs is/are provided in request. eligibility call will not return cmsInfo.
List of key-value pair associated with reason code - promotionQualificationMessagearray of objects
Required=false, The reference to the promotionQualificationMessage object. e.g. Refer ImmediatePromotion model for attributes and example values
ProductOffering PromotionQualificationMessage promotion object. - orderItemarray of objects
Required=false, list of product orderItem Details. e.g. Refer OrderItem model for atttributes and example values
ProductOffering OrderIteam - bundledProductOfferingGroupOptionarray of objects
Required=false, list of product BundledProductOfferingGroupOption Details.
Required=false, List of product BundledProductOfferingGroupOption Details. - attachmentarray of objects
Required=false, An attachment complements the description of an element, for example through a document, a video, a picture. e.g. Refer AttachmentRefOrValue model for attributes and example values
benefit item object - offerClassificationstringRequired=false, offerClassification, eg: mobileOffer
- isEnabledBybooleanRequired=false, isEnabledBy
- valueRankint32Required=false, valueRank
- primarybooleanRequired=false, primary
- serializedbooleanRequired=false, serialized
- isRestrictedbooleanRequired=false, isRestricted
- parentProdOfferGroupOptionarray of objects
Required=false, parentProdOfferGroupOption
Required=false, parentProdOfferGroupOption - potentialPromotionarray of objects
Required=false, parentProdOfferGroupOption
ProductOffering potential promotion object. TMF+ - omsreqrescomponentsarray of objects
Required=false, omsreqrescomponents
Required=false, omsreqrescomponents