Search for listings items by product identifier (or other listings parameters)

Learn how to retrieve information about multiple listings based on SKU, ASIN, or supported product identifiers.

Learn how to retrieve information about multiple listings based on SKU, ASIN, or supported product identifiers. Responses can include a number of optional datasets that provide important information about the state of a listing.

Warning

SP-API cannot distinguish encoded commas (%2C) from literal commas (,). This means that you can't include SKUs that contain commas within comma-delimited queries, because commas in SKUs cannot be distinguished from commas that separate arguments.

When a SKU contains a comma, you must search for the SKU individually. For more information, refer to How do I encode a URL?

Even though there can be more than 1,000 SKUs that match the search criteria, the maximum number of results that can be returned and paged through is limited to 1,000. For example, if you set the pageSize to 10, the maximum number of possible pages is 100.

Prerequisites

To complete this tutorial, you need:

  • Authorization from the selling partner for whom you are making calls. Refer to Authorizing Selling Partner API Applications for more information.
  • Approval for the Product Listing role in your developer profile.
  • The Product Listing role selected in the App registration page for your application.

Submit a listings item search request

To return details for multiple listings items, call the searchListingsItem operation.

📘

Note

If you use packageHierarchySku with a family size that exceeds 20 SKUs, only the first 20 SKUs are returned in the response.

You can use sortBy and sortOrder to sort your results.

Include any IncludedData values that you want in your response.

ValueDescription
summariesSummary details of the listing item
attributesA JSON object containing structured listing item attribute data keyed by attribute name
issuesThe issues associated with the listing item
offersThe current offers for the listing item
fulfillmentAvailabilityThe fulfillment availability details for the listing item
procurementThe vendor procurement details for the listing item
relationshipsRelationship details of an listing item (for example, variations)
productTypesProduct types associated with a listing item