Listings Items API v2021-08-01 Use Case Guide

API Version: 2021-08-01

What is the Listings Items API?

Use the Selling Partner API for Listings Items (Listings Items API) to create, edit, delete, and retrieve details about Amazon listings (SKUs) for a selling partner. This includes 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.

Key features

• Retrieve details about listings: The Listings Items API accepts GET operations to return detailed information about an existing listing.

• Create or fully update listings: The Listings Items API accepts PUT operations to create a new listing or fully replace the data for an existing listing.

• Partially update listings: The Listings Items API accepts PATCH operations to update one or more individual attributes for an existing listing, such as for updating price and quantity. Additionally, the Listings Items API accepts PATCH operations to delete one or more individual attributes for an existing listing.

• Delete listings: The Listings Items API accepts DELETE operations to delete an existing listing.

• Localize issue messages: The Listings Items API provides localized issue messaging either in the locale specified by the calling application or the default locale of the Amazon marketplace.

• Validate submissions: The Listings Items API provides validation of submission data prior to accepting a submission for processing. Validation errors that prevent further processing are provided synchronously to the calling application.

• Preview validations: Get a real-time preview of errors using the Listings Items API validation preview feature while creating or partially updating listings. This allows you to preview errors synchronously without persisting data to the catalog.

To learn more about the terms that are used on this page, refer to Terminology.

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. The JSON_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 and deleteListingsItem 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 Items getListingsItem 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 was 1 and that item is sold, the attributes section shows 1 as the latest value and the fulfillmentAvailability section shows 0 as the live quantity available for purchase.

🚧

Handling generic JSON schemas in client libraries

If you have generated a client library, it is important to note that Swagger Codegen generates types based on properties defined in the Swagger models, and that Swagger Codegen produces empty or incomplete types when an object is defined with additionalProperties: true. To handle such objects, use the --import-mappings command-line parameter to map these objects to a generic JSON object type or a custom object type of your choosing.

Example Swagger Codegen input parameters:

C#: --import-mappings ItemAttributes=Newtonsoft.Json.Linq.JObject
Java: --import-mappings ItemAttributes=com.google.gson.JsonObject

Tutorial: Retrieve details about a listing

Learn how to 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.

🚧

Important

The new LISTINGS_ITEM_STATUS_CHANGE notification mentioned in the following paragraphs is available only to sellers. The LISTINGS_ITEM_ISSUES_CHANGE notification is available to sellers and vendors.

For example, if you have subscribed to receive the LISTINGS_ITEM_ISSUES_CHANGE notification using the Selling Partner API for Notifications (Notifications API) and you receive the notification, you can call the getListingsItem operation of the Listings Item API to get more details. The LISTINGS_ITEM_ISSUES_CHANGE notification does not include the same level of detailed information about issues as does the API. To return more detailed information, call getListingsItem and specify issues in the includedData parameter to get the issues dataset.

Similarly, if you subscribe to the LISTINGS_ITEM_STATUS_CHANGE notification using the Notifications API and you receive the notification, you can call the getListingsItem operation to receive more detailed info. For example, if a listing ceases to be DISCOVERABLE as indicated in the notification, you might want to get the issues dataset to determine the reason for the search suppression.

For another example, if the LISTINGS_ITEM_STATUS_CHANGE notification does not indicate that the listing is buyable (Status does not include BUYABLE), a common reason could be a lack of inventory. In that case, call the getListingsItem operation and include fulfillmentAvailability in the includedData parameter to return the fulfillmentAvailability dataset.

In general, the datasets available using the includedData parameter helps you better understand the status of the listing. The datasets available include summary information, contributed attributes, issues, offer information (sellers), fulfillment availability (sellers), and procurement details (vendors).

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 listings item GET request

Call the getListingsItem operation to return details about a listings item.

Tutorial: Preview errors before creating or fully updating a listing

Learn how to preview errors before creating or fully updating an Amazon listing for a given selling partner Amazon marketplace.

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.
• A JSON-based listing payload adhering to the JSON Schema provided by the Selling Partner API for Product Type Definitions for the given selling partner, Amazon marketplace, and Amazon product type.

Preview errors for a listings item PUT request

To preview the results after you create or fully update a listing, call the putListingsItem operation.

Tutorial: Create or fully update a listing

Learn how to create or fully update an Amazon listing for a given selling partner and Amazon marketplace.

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.

• A JSON-based listing payload adhering to the JSON Schema provided by the Selling Partner API for Product Type Definitions for the given selling partner, Amazon marketplace, and Amazon product type.

Submit listings item put request

Call the putListingsItem operation to create or fully update a listing.

Tutorial: Preview errors before partially updating a listing

Learn how to preview errors before partially updating an Amazon listing for a given selling partner and Amazon marketplace using the Listings Items API.

Partial updates are submitted in the form of JSON Patch documents. Refer to JSON Object Notation Patch for more details about JSON Patch documents. For Amazon listings, JSON Patch documents can add, replace, or delete entire attributes. Patching content within attributes is not supported.

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.
• For attribute updates, JSON-based listing attribute payloads adhering to the JSON Schema provided by the Selling Partner API for Product Type Definitions for the given selling partner, Amazon marketplace, Amazon product type, and attributes.
• For attribute deletes, JSON-based listing attribute payloads adhering to the JSON Schema provided by the Selling Partner API for Product Type Definitions for the given selling partner, Amazon marketplace, Amazon product type, and attributes with the selector properties of the attributes to delete. Attributes cannot be deleted by name alone. The selector values identify which instance of attributes to delete.

Preview errors for a listings item patch request

Call the patchListingsItem operation to partially update a listing.

Tutorial: Partially update a listing

Learn how to partially update an Amazon listing for a given selling partner and Amazon marketplace using the Listings Items API.

Partial updates are submitted in the form of JSON Patch documents. Refer to https://tools.ietf.org/html/rfc6902 for more details about JSON Patch documents. For Amazon listings, JSON Patch documents can add, replace, or delete entire attributes. Patching content within attributes is not supported.

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.

• For attribute updates, JSON-based listing attribute payloads adhering to the JSON Schema provided by the Selling Partner API for Product Type Definitions for the given selling partner, Amazon marketplace, Amazon product type, and attributes.

• For attribute deletes, JSON-based listing attribute payloads adhering to the JSON Schema provided by the Selling Partner API for Product Type Definitions for the given selling partner, Amazon marketplace, Amazon product type, and attributes with the selector properties of the attributes to delete. Attributes cannot be deleted by name alone, the selector values identify which instance of attributes to delete.

Submit listings item patch request

Call the patchListingsItem operation to partially update a listing.

Tutorial: Delete a listing

Learn how to delete an Amazon listing for a given selling partner and Amazon marketplace using the Listings Items API.

The following diagram provides an overview of the workflow steps to delete a listing item.

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 listings item delete request

Call the deleteListingsItem operation to delete a listing.

Submitting images and other media attributes

The Listings Items API accepts product images and other media content attributes from the following sources:

• Publicly accessible Amazon S3 bucket content downloaded through HTTP or HTTPS URL
• Publicly accessible Amazon CloudFront distribution content downloaded through HTTP or HTTPS URL
• Private Amazon S3 bucket content downloaded through S3 URL (for example, s3://bucket-name/object-name.jpg)
• Images hosted on third-party servers that are publicly available to Amazon.

⭐

Tip

For optimal processing performance, host your media on AWS (such as Amazon S3 or Amazon CloudFront) or other highly available content delivery network (CDN) services.
If you use a private Amazon S3 bucket, you must also configure your Amazon S3 bucket policy to allow the IAM role (arn:aws:iam:111122223333:role/Media-Download-Role) to call the GetObject and ListBucket operations on the bucket. Refer to the following S3 bucket policy for an example.

Private Amazon S3 content is treated as immutable, meaning you cannot change the content for an Amazon S3 object key. New media content requires a new Amazon S3 object key. This convention provides the benefit of improved processing times and avoids the cost of redundant downloads in case listing submissions are re-processed.

The following is an example Amazon S3 bucket policy enabling the required operations on a bucket named bucket-name:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "",
      "Action": [
        "s3:GetObject",
        "s3:ListBucket"
      ],
      "Effect": "Allow",
      "Resource": [
        "arn:aws:s3:::bucket-name/*",
        "arn:aws:s3:::bucket-name"
      ],
      "Principal": {
        "AWS": [
          "arn:aws:iam::368641386589:role/Media-Download-Role"
        ]
      }
    }
  ]
}

Tutorial: 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. 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.