searchOffersRequest

get

https://api.business.amazon.com/products/2020-08-26/products/{productId}/offers

Search for offers of a specific product.

Usage Plan:

Rate (requests per second)	Burst
.5	10

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.

🚧
productRegion can be either US or DE to return results for the US and German marketplaces, respectively. Selecting any other region will return an error.

📘
To test this API, populate each required input field with the pre-defined example values.

Path Params

productId

string

required

The Amazon Standard Item Identifier (ASIN) for the product.

Query Params

productRegion

string

enum

required

The region where the customer wants to purchase the product.

shippingRegion

string

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

locale

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.

shippingPostalCode

string

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

pageNumber

integer

The zero-based number of the page being requested. If not specified, a default value of 0 will be used. When passed, the value must be equal or greater than zero, and less than the number of pages returned in the response. The maximum number of pages that can be fetched is 13.

pageSize

integer

The requested number of products per page (default 24). Max 24 without privilege.

groupTag

string

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

filterIds

array of strings

A list of filter ids for use to query results.

filterIds

quantity

integer

Defaults to 1

The number of units the customer intends to purchase. This helps Amazon Business determines quantity-based discounts if an eligible offer is present. Defaults to 1.

inclusionsForOffers

array of strings

enum

A list specifying the offer fields for inclusion in the response object. Excluding this query parameter results in the response including all inclusions.

inclusionsForOffers

Headers

x-amz-user-email

string

required

The email address of the customer requesting this resource

Responses

🚧

📘

200Search success

400The service was unable to process the request. Reasons for the error are described in an error response object.

401The request's authorization header isn't formatted correctly or doesn't contain a valid authorization input.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified doesn't exist.

429The frequency of requests was greater than allowed.

500Encountered an unexpected condition which prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.