Inquire Product Offering Details
Endpoint
productoffering details will be returned for the provided eligibility and/or filter
Query Parameters
- headersobjectRequired
- datestring
- cookiesobject
- requestHeadersobject
- mediaTypeobject
- acceptableMediaTypesarray of objects
- acceptableLanguagesarray of objects
- lengthint32
- languageobject
- array of strings
Required=false, comma separated list of productOfferingIDs to retrieve details
[{}] - limitint32RequiredRequired=true, max number of productOffering details to be returned in response. Not used when ids query param is populated.Length: 2
- offsetint32RequiredRequired=true, page number of productOffering details response. Not used when ids query param is populated.Length: 2
- channelstringRequiredEnum: [CallCenter, SelfService, ATTR, ERP, IND, APPLE, LSP, D2D, DMDR, MSS, MCC, RETENTION, BACKOFF, CONCIERGE, IHX, ECOMM, CONCAR, ISM, FIRSTNET, TESTER]Required=true, channel name of client. eg ATTR for AT&T Retail and ERP for External Retail PartnersLength: 100
- categoryNamestringEnum: [BB_Plans]Required=false, category name of productOfferingLength: 100
- serviceAddressIdstringRequiredRequired=false, place id of the primary service. Mandatory for BB offer search. Not required when ids query param is populatedLength: 100
- productOfferingTypeGroupstringEnum: [BBOffer, BBPlan, equipment]Required=false, The type group of the product offering. The values are used as defined from catalog e.g. BBOfferLength: 100
- characteristicsstringRequired=false, characteristics key value pairs to filter the response. This value should be urlencoded. e.g. [{"Streaming":"Standard-definition"}], actual value= %5B%7B%22Streaming%22%3A%5B%22Standard-definition%22%5D%7D%5D
- migratedFromstringEnum: [ADSL]Required=false, Migration indicator. e.g. ADSL
- relatedProductOfferingIdstringRequired=false, Related entity ID to be used in retrieving related offers.
- relationTypestringRequired=false, Business Relationship type. i.e. CommercialRelation
- relationRolestringRequired=false, Business Relationship role. i.e. addon
- customerIdstringRequired=false, Unique identifier of the related party
- productIdstringRequired=false, The the product's ID in the customer inventory.
- customerTypestringRequiredEnum: [Consumer, Business]Required=false, customer type. e.g. Consumer/Business
- customerSubTypestringEnum: [Individual]Required=false, customer sub type. e.g. Individual
- productOrderIdstringRequired=false, productOrderId. e.g. 1345678
- checkEligibilityForCouponstringRequired=false, check Eligibility For Coupon. e.g. ACTNOW
- productOfferingTypestringRequired=false, product Offering Type. e.g. BBClosureOffer
- array of strings
Required=false, comma separated list of coupons. e.g. FEB4040
[{}] - contextTypestringRequired=false, check context type eg Order
- contextMainIdentifierstringRequired=false, check context type eg Order
Header Parameters
- X-ATT-ClientIdstringEnum: [CheckoutMs, CartMs, onlinesalesorch, salesforce, WirelessUpgradeOptionsMs, idpgwconsumer, PurchaseOrderMs]Required=true, domain ID of calling application. e.g. CheckoutMs,onlinesalesorchLength: 100
- idpctx-appnamestringEnum: [onlinesales, onlineservices, myATTNative, SF-SALES, omhub]Required=true, end UI application name. eg SF-SalesLength: 100
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 BB Bundle
- localizedNamestringRequiredRequired=true, The localized name of the product offering. e.g. Unlimited 5G BB Bundle
- descriptionstringRequired=false, The localized description of the product offering. e.g. Unlimited 5G BB 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: [BB_Offer, BB_Plan, Rented_Equipment]Required=true, The type of the product offering - can represent the LOB or other relevant types like shipping offer. e.g.BB_Offer, BB_Plan, Rented_Equipment
- productOfferingTypeGroupstringRequiredEnum: [BBOffer, BBPlan, equipment, BBDevice, addOn]Required=false, The type group of the product offering. The values are used as defined from catalog e.g. BBOfferLength: 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