SP-API Catalog Items

Search catalog items

Proxy to https://developer-docs.amazon.com/sp-api/reference/searchcatalogitems. The limit is 60 requests per minute. Amazon seller account integration is required to make this request. You can do it here.

get/api/v1/sp-api/catalog/2022-04-01/items

Request

  • Base URL: https://app.sellerassistant.app (the document declares no server; this is the origin it was published from)
  • URL: https://app.sellerassistant.app/api/v1/sp-api/catalog/2022-04-01/items
  • Auth: one of:
    • API key in query parameter api_key
    • API key in header X-Api-Key

Query parameters

A comma-delimited list of product identifiers that you can use to search the Amazon catalog. Note: You cannot include identifiers and keywords in the same request.

The type of product identifiers that you can use to search the Amazon catalog. Note: identifiersType is required when identifiers is in the request. Allowed values: ASIN, EAN, GTIN, ISBN, JAN, MINSAN, SKU, UPC.

A comma-delimited list of datasets to include in the response. Allowed values: attributes, classifications, dimensions, identifiers, images, productTypes, relationships, salesRanks, summaries, vendorDetails.

The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.

A comma-delimited list of keywords that you can use to search the Amazon catalog. Note: You cannot include keywords and identifiers in the same request.

A comma-delimited list of brand names that you can use to limit the search in queries based on keywords. Note: Cannot be used with identifiers.

A comma-delimited list of classification identifiers that you can use to limit the search in queries based on keywords. Note: Cannot be used with identifiers.

The number of results to include on each page (Min: 1, Max: 20). Default: 10.

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

The language of the keywords that are included in queries based on keywords. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.

Amazon marketplace domain. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. Options: amazon.com, amazon.ca, amazon.co.uk, amazon.de, amazon.es, amazon.it, amazon.fr, amazon.in, amazon.com.mx, amazon.com.br.

Amazon marketplace id. Domain amazon.com is used by default if domain and marketplaceId are not provided. If both domain and marketplaceId are chosen, domain has bigger priority. See all options here.

Response

Successful response

numberOfResultsinteger

For searches that are based on identifiers, numberOfResults is the total number of Amazon catalog items found. For searches that are based on keywords, numberOfResults is the estimated total number of Amazon catalog items that are matched by the search query. Only results up to the page count limit are returned per request regardless of the number found. Note: The maximum number of items (ASINs) that can be returned and paged through is 1,000.

Example response

{
  "numberOfResults": 3,
  "pagination": {
    "nextToken": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234",
    "previousToken": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d"
  },
  "items": [
    {
      "asin": "B00U26V4VQ",
      "classifications": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "classifications": [
            {
              "displayName": "Electronics",
              "classificationId": "123456789"
            }
          ]
        }
      ],
      "dimensions": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "item": {
            "height": {
              "unit": "inches",
              "value": 10.5
            },
            "length": {
              "unit": "inches",
              "value": 10.5
            },
            "weight": {
              "unit": "inches",
              "value": 10.5
            },
            "width": {
              "unit": "inches",
              "value": 10.5
            }
          },
          "package": {
            "height": {
              "unit": "inches",
              "value": 10.5
            },
            "length": {
              "unit": "inches",
              "value": 10.5
            },
            "weight": {
              "unit": "inches",
              "value": 10.5
            },
            "width": {
              "unit": "inches",
              "value": 10.5
            }
          }
        }
      ],
      "identifiers": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "identifiers": [
            {
              "identifierType": "UPC",
              "identifier": "123456789012"
            }
          ]
        }
      ],
      "images": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "images": [
            {
              "variant": "MAIN",
              "link": "https://www.example.com/image.jpg",
              "height": 500,
              "width": 500
            }
          ]
        }
      ],
      "productTypes": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "productType": "LUGGAGE"
        }
      ],
      "relationships": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "relationships": [
            {
              "type": "VARIATION",
              "childAsins": [
                "B00U26V4VQ",
                "B08T8YZ49Z"
              ],
              "parentAsins": [
                "B08T8YZ47X"
              ],
              "variationTheme": {
                "attributes": [
                  "Color",
                  "Size"
                ],
                "theme": "ColorSize"
              }
            }
          ]
        }
      ],
      "salesRanks": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "classificationRanks": [
            {
              "classificationId": "123456789",
              "title": "Best Sellers in Electronics",
              "rank": 1,
              "link": "https://www.amazon.com/gp/bestsellers/electronics"
            }
          ],
          "displayGroupRanks": [
            {
              "websiteDisplayGroup": "electronics",
              "title": "Best Sellers in Electronics",
              "rank": 1,
              "link": "https://www.amazon.com/gp/bestsellers/electronics"
            }
          ]
        }
      ],
      "summaries": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "brand": "Samsung",
          "browseClassification": {
            "displayName": "Electronics",
            "classificationId": "123456789"
          },
          "color": "Black",
          "contributors": [
            {
              "role": {
                "value": "author",
                "displayName": "Author"
              },
              "value": "John Smith"
            }
          ],
          "itemClassification": "BASE_PRODUCT",
          "itemName": "Samsung QLED TV",
          "manufacturer": "Samsung Electronics",
          "modelNumber": "QN82Q60RAFXZA",
          "packageQuantity": 1,
          "partNumber": "QN82Q60RAFXZA",
          "releaseDate": "2021-03-01T00:00:00Z",
          "size": "82-inch",
          "style": "Flat",
          "tradeInEligible": true,
          "websiteDisplayGroup": "electronics",
          "websiteDisplayGroupName": "Electronics"
        }
      ],
      "vendorDetails": [
        {
          "marketplaceId": "ATVPDKIKX0DER",
          "brandCode": "SAMSUNG",
          "manufacturerCode": "SAMSUNG",
          "manufacturerCodeParent": "SAMSUNG_PARENT",
          "productCategory": {
            "displayName": "Electronics",
            "value": "50400100"
          },
          "productGroup": "Electronics",
          "productSubcategory": {
            "displayName": "Electronics",
            "value": "50400100"
          },
          "replenishmentCategory": "BASIC"
        }
      ]
    }
  ],
  "refinements": {
    "brands": [
      {
        "numberOfResults": 5,
        "brandName": "Samsung"
      }
    ],
    "classifications": [
      {
        "numberOfResults": 10,
        "displayName": "Electronics",
        "classificationId": "123456789"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.