getOffersByOfferIds

Retrieves offers and their respective details based on the list of offer identifiers present in the request. For example, this operation can be used to load a user's cart with the details of selected offers or check the quantity of selected products before placing an order.

Usage Plan:

Rate (requests per second)Burst
.510

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.

📘

To test this API, use any of the following sample request bodies. You can populate the input fields below with values from these samples:

Example #1 - Click to expand
    {
    "offersByOfferIdsRequest": [
        {
            "offerId": "asid-GFH8824XQJpAbpQ"
        }
    ],
    "locale": "en_US",
    "productRegion": "US"
}
Example #2 - Click to expand
{
  "offersByOfferIdsRequest": [
    {
      "offerId": "asid-2q6HC7dfgom1g49"
    },
    {
      "offerId": "asid-GFH8824XQJpAbpQ"
    },
    {
      "offerId": "asid-hD0uGrjek4phqer"
    }
  ],
  "locale": "en_US",
  "productRegion": "US"
}
Query Params
inclusionsForOffers
array of strings
enum
required

A list specifying the offer fields for inclusion in the response object.

inclusionsForOffers*
string

A value that identifies which group a customer belongs to within the Amazon Business account. The customer can set this value in their Amazon Business account information. GroupTag is necessary only if the customer account belongs to more than one group.

Body Params
offersByOfferIdsRequest
array of objects
required

Accepts a list of offer IDs as input. The response will return offer information for each ID provided. The maximum number of IDs allowed for each call is 30.

offersByOfferIdsRequest*
string
enum
required

The region where the customer wants to purchase the product.

Show Details
DEGermany
FRFrance
UKUnited Kingdom
ITItaly
ESSpain
INIndia
USUnited States of America
CACanada
MXMexico
JPJapan
AUAustralia
string

This field determines the region where to ship the product based on the value in the shippingPostalCode.

string
required

The locale of the request in the form of an IETF language tag. Each ProductRegion supports one or more locales. This value should comply with java.util.Locale.

string

The shipping postal or zip code for customer's request. This parameter doesn't support geocode.

Headers
string
required

The email address of the customer requesting this resource.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json