Listings Items API
Learn how to access data on selling partner listings on Amazon.
You use the Listings Items API to access details about your listings on Amazon. These details include product facts, such as item titles, and sales terms, such as price and inventory. Refer to the Listings Items API Reference for details about Listings Items API operations and associated data types and schemas.
Listings data submitted to the Listings Items API adheres to the JSON Schema format provided by the Selling Partner API for Product Type Definitions. Refer to the Product Type Definitions API documentation for details on retrieving schemas for supported Amazon product types and validating data prior to submitting to Amazon with the Listings Items API.
Current version | Legacy versions | Available to sellers | Available to vendors |
---|---|---|---|
v2021-08-01 (Reference | Model) | v2020-09-01 | Yes | Yes |
Release notes
To learn more about the terms that are used on this page, refer to Terminology.
Use cases
The following use case examples are available for the Listings Items API:
- Retrieve details about a listing: Return detailed information about an Amazon listing for a given selling partner and Amazon marketplace. The details returned can include a number of optional datasets that provide important information about the state of the listing.
- Preview errors before creating or fully updating a listing: Preview errors before creating or fully updating an Amazon listing for a given selling partner Amazon marketplace.
- Create or fully update a listing: Create or fully update an Amazon listing for a given selling partner and Amazon marketplace.
- Preview errors before partially updating a listing: Preview errors before partially updating an Amazon listing for a given selling partner and Amazon marketplace using the Listings Items API.
- Partially update a listing: Partially update an Amazon listing for a given selling partner and Amazon marketplace using the Listings Items API.
- Merge a listing: Partially update the
quantity
field within thefulfillment_availability
without the need to explicitly specify other optional attributes suchrestock_date
andlead_time_to_ship_max_days
. You can also delete previously set values forquantity_discount_plan
within purchasable_offer for B2B offers. The merge operation is not supported for other attributes outside of these two use cases. - Delete a listing: Delete an Amazon listing for a given selling partner and Amazon marketplace using the Listings Items API.
- Search for listings items by product identifier (or other listings parameters): 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.
Considerations
-
1x1 updates: The Listings Items API accepts listings updates one at a time. For use-cases better suited to bulk uploads, the
JSON_LISTINGS_FEED
feed type can be used with the Selling Partner API for Feeds. TheJSON_LISTINGS_FEED
is the bulk equivalent of the Listings Items API, offering the same features and schemas provided by the Selling Partner API for Product Type Definitions. -
Fully supported product types: The Listings Items API does not yet fully support all Amazon product types. Supported Amazon product types differ by selling partner type (merchant or vendor) and by Amazon marketplace. Refer to the Selling Partner API for Product Type Definitions for the latest available Amazon product types.
-
Partially supported product types: For Amazon product types not yet fully supported by the Listings Items API, offer-only submissions for existing ASINs and partial updates are supported by using the
PRODUCT
product type. -
Results and issues: Responses from the Listings Items
putListingsItem
,patchListingsItem
anddeleteListingsItem
operations indicate whether or not the submission was accepted for processing, along with any issues preventing the submission from being accepted. Responses do not include issues that occur after accepting the submission for processing. Responses to the Listings ItemsgetListingsItem
operation can include issues that occur after the submission has been processed. -
Attributes: The attributes section shows the latest data provided by the selling partner. Other sections, such as
fulfillmentAvailability
, represent the latest live data for the listing. For example, if the last inventory quantity submitted was1
and that item is sold, the attributes section shows1
as the latest value and thefulfillmentAvailability
section shows0
as the live quantity available for purchase.
<handing_generic_json_client_library />
Roles
deleteListingsItem
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Inventory and Order Tracking Product Listing |
getListingsItem
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Inventory and Order Tracking Product Listing |
patchListingsItem
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Inventory and Order Tracking Product Listing |
putListingsItem
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Inventory and Order Tracking Product Listing |
searchListingsItems
Attribute | Value |
---|---|
Regions | NA, EU, FE |
Required roles (need at least one) | Inventory and Order Tracking Product Listing |
Updated about 11 hours ago