HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

searchListingsItems

Search for and return a list of selling partner listings items and their respective details.

Usage Plan:

Rate (requests per second)Burst
55

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

Path Params
string
required

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

Query Params
marketplaceIds
array of strings
required
length ≤ 1

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

marketplaceIds*
string

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

includedData
array of strings
Defaults to summaries

A comma-delimited list of datasets that you want to include in the response. Default: summaries.

Show Details
summariesSummary details for the listing item.
attributesA JSON object that contains structured listing item attribute data, keyed by attribute name.
issuesIssues that are associated with the listing item.
offersCurrent offers for the listing item.
fulfillmentAvailabilityFulfillment availability details for the listing item.
procurementVendor procurement details for the listing item.
relationshipsRelationship details for a listing item (for example, variations).
productTypesProduct types associated with a listing item.
includedData
identifiers
array of strings
length ≤ 20

A comma-delimited list of product identifiers that you can use to search for listings items.

Note:

  1. This is required when you specify identifiersType.
  2. You cannot use 'identifiers' if you specify variationParentSku or packageHierarchySku.
identifiers
string

A type of product identifiers that you can use to search for listings items.

Note:
This is required when identifiers is provided.

string

Filters results to include listing items that are variation children of the specified SKU.

Note: You cannot use variationParentSku if you include identifiers or packageHierarchySku in your request.

string

Filter results to include listing items that contain or are contained by the specified SKU.

Note: You cannot use packageHierarchySku if you include identifiers or variationParentSku in your request.

date-time

A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in ISO 8601 date-time format.

date-time

A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in ISO 8601 date-time format.

date-time

A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in ISO 8601 date-time format.

date-time

A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in ISO 8601 date-time format.

withIssueSeverity
array of strings

Filter results to include only listing items that have issues that match one or more of the specified severity levels.

Show Details
ERRORIndicates that an issue has occurred, which prevented the submission from processing. For example, a validation error.
WARNINGIndicates an issue has occurred that should be reviewed, but it has not prevented the submission from processing.
withIssueSeverity
withStatus
array of strings

Filter results to include only listing items that have the specified status.

Show Details
BUYABLEThe listings item can be purchased by shoppers. This status does not apply to vendor listings.
DISCOVERABLEThe listings item is visible to shoppers.
withStatus
withoutStatus
array of strings

Filter results to include only listing items that don't contain the specified statuses.

Show Details
BUYABLEThe listings item can be purchased by shoppers. This status does not apply to vendor listings.
DISCOVERABLEThe listings item is visible to shoppers.
withoutStatus
string
Defaults to lastUpdatedDate

An attribute by which to sort the returned listing items.

string
Defaults to DESC

The order in which to sort the result items.

integer
≤ 20
Defaults to 10

The number of results that you want to include on each page.

string

A token that you can use to fetch a specific page when there are multiple pages of results.

Responses

Response body
object
integer
required

The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found).

Note: The maximum number of items (SKUs) that can be returned and paged through is 1000.

pagination
object

When a request produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there will be no nextToken key in the pagination object.

string

A token that can be used to fetch the next page.

string

A token that can be used to fetch the previous page.

items
array of objects
required

A list of listings items.

items*
object
string
required

A selling partner provided identifier for an Amazon listing.

summaries
array of objects

Summary details of a listings item.

summaries
object
string
required

A marketplace identifier. Identifies the Amazon marketplace for the listings item.

string

Amazon Standard Identification Number (ASIN) of the listings item.

string
required

The Amazon product type of the listings item.

string

Identifies the condition of the listings item.

new_new new_open_box new_oem refurbished_refurbished used_like_new used_very_good used_good used_acceptable collectible_like_new collectible_very_good collectible_good collectible_acceptable club_club

Show Details
new_newNew.
new_open_boxNew - Open Box.
new_oemNew - OEM.
refurbished_refurbishedRefurbished.
used_like_newUsed - Like New.
used_very_goodUsed - Very Good.
used_goodUsed - Good.
used_acceptableUsed - Acceptable.
collectible_like_newCollectible - Like New.
collectible_very_goodCollectible - Very Good.
collectible_goodCollectible - Good.
collectible_acceptableCollectible - Acceptable.
club_clubClub.
status
array of strings
required

Statuses that apply to the listings item.

Show Details
BUYABLEThe listings item can be purchased by shoppers. This status does not apply to vendor listings.
DISCOVERABLEThe listings item is visible to shoppers.
status*
string

The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item.

string

The name or title associated with an Amazon catalog item.

date-time
required

The date the listings item was created in ISO 8601 format.

date-time
required

The date the listings item was last updated in ISO 8601 format.

mainImage
object

The image for the listings item.

attributes
object

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

Has additional fields
issues
array of objects

The issues associated with the listings item.

issues
object
string
required

An issue code that identifies the type of issue.

string
required

A message that describes the issue.

string
required

The severity of the issue.

ERROR WARNING INFO

Show Details
ERRORIndicates an issue has occurred preventing the submission from processing, such as a validation error.
WARNINGIndicates an issue has occurred that should be reviewed, but has not prevented the submission from processing.
INFOIndicates additional information has been provided that should be reviewed.
attributeNames
array of strings

The names of the attributes associated with the issue, if applicable.

attributeNames
categories
array of strings
required

List of issue categories.

Possible vales:

  • INVALID_ATTRIBUTE - Indicating an invalid attribute in the listing.

  • MISSING_ATTRIBUTE - Highlighting a missing attribute in the listing.

  • INVALID_IMAGE - Signifying an invalid image in the listing.

  • MISSING_IMAGE - Noting the absence of an image in the listing.

  • INVALID_PRICE - Pertaining to issues with the listing's price-related attributes.

  • MISSING_PRICE - Pointing out the absence of a price attribute in the listing.

  • DUPLICATE - Identifying listings with potential duplicate problems, such as this ASIN potentially being a duplicate of another ASIN.

  • QUALIFICATION_REQUIRED - Indicating that the listing requires qualification-related approval.

categories*
enforcements
object

This field provides information about the enforcement actions taken by Amazon that affect the publishing or status of a listing. It also includes details about any associated exemptions.

offers
array of objects

Offer details for the listings item.

offers
object
string
required

The Amazon marketplace identifier.

string
required

Type of offer for the listings item.

B2C B2B

Show Details
B2CThe offer on this listings item is available for Business to Consumer purchase, meaning that it is available to shoppers on Amazon retail sites.
B2BThe offer on this listings item is available for Business to Business purchase.
price
object
required

The currency type and amount.

points
object

The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the Points element is only returned in Japan (JP).

audience
object

Buyer segment or program this offer is applicable to.

fulfillmentAvailability
array of objects

The fulfillment availability for the listings item.

fulfillmentAvailability
object
string
required

The code of the fulfillment network that will be used.

integer
≥ 0

The quantity of the item you are making available for sale.

procurement
array of objects

The vendor procurement information for the listings item.

procurement
object
costPrice
object
required

The currency type and amount.

relationships
array of objects

Relationships for a listing item, by marketplace (for example, variations).

relationships
object
string
required

Amazon marketplace identifier.

relationships
array of objects
required

Relationships for the listing item.

relationships*
object
childSkus
array of strings

Identifiers (SKUs) of the related items that are children of this listing item.

childSkus
parentSkus
array of strings

Identifiers (SKUs) of the related items that are parents of this listing item.

parentSkus
variationTheme
object

A variation theme that indicates the combination of listing item attributes that define the variation family.

string
required

The type of relationship.

VARIATION PACKAGE_HIERARCHY

Show Details
VARIATIONThe listing item in the request is a variation parent or variation child of the related listing items, indicated by SKU.
PACKAGE_HIERARCHYThe listing item in the request is a package container or is contained by the related listing items, indicated by SKU.
productTypes
array of objects

Product types for a listing item, by marketplace.

productTypes
object
string
required

Amazon marketplace identifier.

string
required

The name of the product type that is submitted by the Selling Partner.

Headers
object
string

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

string

Unique request reference identifier.

Language