Inquire Products & Offers
Version 1.0.0
Endpoint
POST
https://partner.att.com/omni-svcs/v1/offers/search
Copy
Productoffering details will be returned for the provided eligibility and/or filter
Body Parameters
- objectRequired
- idsarray of strings
Lookup by Ids. IDs can be comma separated list of productOfferingIDs to retrieve details. e.g. 06c387fb-bfd5-4287-a1e8-b9da4c0be06e
- limitint32Max number of productOffering details to be returned in response. Not used when ids query param is populated.
- offsetint32Page number of productOffering details response. Not used when ids query param is populated.
- channelstringEnum: [IND, SelfService, ATTR, ECOMM]Channel name of client. eg ATTR,ECOMM,SelfServiceLength: 100
- productOfferingIdstringProduct 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.Example: 06c387fb-bfd5-4287-a1e8-b9da4c0be06eLength: 100
- productOfferingTypeGroupstringEnum: [mobilePlan, mobileAddon, mobileDevice, mobileOffer, sim]Example: mobileOffer
- customerTypestringEnum: [CONSUMER, IRU, CRU]Customer Type to be used for filtering. e.g. CONSUMER, IRU, CRU.Length: 100
- orderIdstringDraft orderIdExample: 99-12333333
- ctnstringCustomer telephone number if available for AL, UPExample: 4694561111
- flowTypesarray of stringsEnum: [NEW, AL, UP]
List of Flow types to be used for filtering. e.g. NEW, AL, UP.
- BYODobjectList of characteristics to be used for filtering BYOD for certain edModels of device
- deviceTypearray of stringsEnum: [Phone, Tablet, Wearable]
deviceType: Phone, Tablet, Wearable, etc.
Example: Phone - lineCountNumber of lines that customer wants to add in the cart so that adjusted plan prices can be returned
Responses
OK
Body
application/json
- array of objectsRequired
- idstringExample: 06c387fb-bfd5-4287-a1e8-b9da4c0be06e
- namestringExample: Value Plus VL
- localizedNamestringExample: Value Plus VL
- descriptionstringExample: Value Plus VL
- productOfferingTypestringExample: Mobile_Offer
- productOfferingTypeGroupstringExample: mobileOffer
- bundledProductOfferingarray of objectsbundledProductOffering can be ANY OF the following schemas:
- productOfferingTotalPricearray of objects
- bundledProductOfferingGroupOptionarray of objectsbundledProductOfferingGroupOption can be ANY OF the following schemas:
[{]}