Selling Partner API for Listings Items (2021-08-01)

Download OpenAPI specification:Download

The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.

For more information, see the Listings Items API Use Case Guide.

listings

deleteListingsItem

Delete a listings item for a selling partner.

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, 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.

path Parameters
sellerId
required
string

A selling partner identifier, such as a merchant account or vendor code.

sku
required
string

A selling partner provided identifier for an Amazon listing.

query Parameters
marketplaceIds
required
Array of strings

A comma-delimited list of Amazon marketplace identifiers for the request.

issueLocale
string

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.

header Parameters
Content-Type
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "sku": "GM-ZDPI-9B4E",
  • "status": "ACCEPTED",
  • "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003",
  • "issues": [ ]
}

getListingsItem

Returns details about a listings item for a selling partner.

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, 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
sellerId
required
string

A selling partner identifier, such as a merchant account or vendor code.

sku
required
string

A selling partner provided identifier for an Amazon listing.

query Parameters
marketplaceIds
required
Array of strings

A comma-delimited list of Amazon marketplace identifiers for the request.

issueLocale
string

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.

includedData
Array of strings
Default: "summaries"
Items Enum: "summaries" "attributes" "issues" "offers" "fulfillmentAvailability" "procurement"

A comma-delimited list of data sets to include in the response. Default: summaries.

header Parameters
Content-Type
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "sku": "GM-ZDPI-9B4E",
  • "summaries": [
    ],
  • "offers": [
    ],
  • "fulfillmentAvailability": [
    ],
  • "issues": [ ]
}

patchListingsItem

Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.

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, 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
sellerId
required
string

A selling partner identifier, such as a merchant account or vendor code.

sku
required
string

A selling partner provided identifier for an Amazon listing.

query Parameters
marketplaceIds
required
Array of strings

A comma-delimited list of Amazon marketplace identifiers for the request.

issueLocale
string

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.

header Parameters
Content-Type
string
Value: "application/json"
Request Body schema: application/json

The request body schema for the patchListingsItem operation.

productType
required
string

The Amazon product type of the listings item.

required
Array of objects (PatchOperation) non-empty

One or more JSON Patch operations to perform on the listings item.

Responses

Request samples

Content type
application/json
{
  • "productType": "string",
  • "patches": [
    ]
}

Response samples

Content type
application/json
{
  • "sku": "GM-ZDPI-9B4E",
  • "status": "ACCEPTED",
  • "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003",
  • "issues": [ ]
}

putListingsItem

Creates a new or fully-updates an existing listings item for a selling partner.

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, 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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
sellerId
required
string

A selling partner identifier, such as a merchant account or vendor code.

sku
required
string

A selling partner provided identifier for an Amazon listing.

query Parameters
marketplaceIds
required
Array of strings

A comma-delimited list of Amazon marketplace identifiers for the request.

issueLocale
string

A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: "en_US", "fr_CA", "fr_FR". Localized messages default to "en_US" when a localization is not available in the specified locale.

header Parameters
Content-Type
string
Value: "application/json"
Request Body schema: application/json

The request body schema for the putListingsItem operation.

productType
required
string

The Amazon product type of the listings item.

requirements
string (Requirements)
Enum: "LISTING" "LISTING_PRODUCT_ONLY" "LISTING_OFFER_ONLY"

The name of the requirements set for the provided data.

attributes
required
object

JSON object containing structured listings item attribute data keyed by attribute name.

Responses

Request samples

Content type
application/json
{
  • "productType": "string",
  • "requirements": "LISTING",
  • "attributes": { }
}

Response samples

Content type
application/json
{
  • "sku": "GM-ZDPI-9B4E",
  • "status": "ACCEPTED",
  • "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003",
  • "issues": [ ]
}