listOffers

post https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search

Returns the details of a selling partner's replenishment program offers.

Usage Plan:

Rate (requests per second)	Burst
1	1

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Responses

Response body

object

offers

array of objects

A list of offers.

offers

object

sku

string

The SKU. This property is only supported for sellers and not for vendors.

asin

string

The Amazon Standard Identification Number (ASIN).

marketplaceId

string

The marketplace identifier. The supported marketplaces for both sellers and vendors are US, CA, ES, UK, FR, IT, IN, DE and JP. The supported marketplaces for vendors only are BR, AU, MX, AE and NL. Refer to Marketplace IDs to find the identifier for the marketplace.

eligibility

string

The current eligibility status of an offer.

ELIGIBLE INELIGIBLE SUSPENDED REPLENISHMENT_ONLY_ORDERING

Show Details

ELIGIBLE	The offer is able to fulfill current subscriptions and add new subscriptions.
INELIGIBLE	The offer will not be able to add new subscriptions and existing subscriptions will be cancelled.
SUSPENDED	The offer will not be able to add new subscriptions but existing subscriptions will be fulfilled.
REPLENISHMENT_ONLY_ORDERING	The offer will not be able to add new subscriptions but existing subscriptions will be fulfilled. This eligibility status also blocks one-time purchases to preserve inventory for existing subscriptions.

offerProgramConfiguration

object

The offer program configuration contains a set of program properties for an offer.

programType

string

The replenishment program type.

SUBSCRIBE_AND_SAVE

Show Details

SUBSCRIBE_AND_SAVE

Subscribe And Save Program.

vendorCodes

array of strings

A list of vendor codes associated with the offer.

vendorCodes

pagination

object

Use these parameters to paginate through the response.

totalResults

int64

≥ 0

Total number of results matching the given filter criteria.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://sellingpartnerapi-na.amazon.com/replenishment/2022-11-07/offers/search \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "sort": {
8
    "order": "ASC",
9
    "key": "ASIN"
10
  }
11
}
12
'


xxxxxxxxxx
34
}
1
{
2
  "offers": [
3
    {
4
      "marketplaceId": "ATVPDKIKX0DER",
5
      "offerProgramConfiguration": {
6
        "preferences": {
7
          "autoEnrollment": "OPTED_IN"
8
        },
9
        "promotions": {
10
          "sellingPartnerFundedBaseDiscount": {
11
            "percentage": 5
12
          },
13
          "sellingPartnerFundedTieredDiscount": {
14
            "percentage": 0
15
          },
16
          "amazonFundedBaseDiscount": {
17
            "percentage": 5
18
          },
19
          "amazonFundedTieredDiscount": {
20
            "percentage": 10
21
          }
22
        },
23
        "enrollmentMethod": "AUTOMATIC"
24
      },
25
      "programType": "SUBSCRIBE_AND_SAVE",

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

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

404The specified resource does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.