listCatalogItems

Effective September 30, 2022, the listCatalogItems operation will no longer be available in the Selling Partner API for Catalog Items v0. As an alternative, searchCatalogItems is available in the latest version of the Selling Partner API for Catalog Items v2022-04-01. Integrations that rely on the listCatalogItems operation should migrate to the searchCatalogItemsoperation to avoid service disruption.
Note: The listCatalogCategories operation is not being deprecated and you can continue to make calls to it.

Request

Query Params

MarketplaceId

string

required

A marketplace identifier. Specifies the marketplace for which items are returned.

Query

string

optional

Keyword(s) to use to search for items in the catalog. Example: 'harry potter books'.

QueryContextId

string

optional

An identifier for the context within which the given search will be performed. A marketplace might provide mechanisms for constraining a search to a subset of potential items. For example, the retail marketplace allows queries to be constrained to a specific category. The QueryContextId parameter specifies such a subset. If it is omitted, the search will be performed using the default context for the marketplace, which will typically contain the largest set of items.

SellerSKU

string

optional

Used to identify an item in the given marketplace. SellerSKU is qualified by the seller's SellerId, which is included with every operation that you submit.

UPC

string

optional

A 12-digit bar code used for retail packaging.

EAN

string

optional

A European article number that uniquely identifies the catalog item, manufacturer, and its attributes.

ISBN

string

optional

The unique commercial book identifier used to identify books internationally.

JAN

string

optional

A Japanese article number that uniquely identifies the product, manufacturer, and its attributes.

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference ID.

Body

payload

object (ListMatchingItemsResponse)

optional

Items

array[object (Item) {7}]

optional

The list of items you want to include in a shipment.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "Items": [
            {
                "sku": "string",
                "summaries": [
                    {
                        "marketplaceId": "string",
                        "asin": "string",
                        "productType": "string",
                        "conditionType": "new_new",
                        "status": [
                            "BUYABLE"
                        ],
                        "fnSku": "string",
                        "itemName": "string",
                        "createdDate": "2019-08-24T14:15:22Z",
                        "lastUpdatedDate": "2019-08-24T14:15:22Z",
                        "mainImage": {
                            "link": "string",
                            "height": 0,
                            "width": 0
                        }
                    }
                ],
                "attributes": {},
                "issues": [
                    {
                        "code": "string",
                        "message": "string",
                        "severity": "ERROR",
                        "attributeNames": [
                            "string"
                        ],
                        "categories": [
                            "INVALID_ATTRIBUTE"
                        ],
                        "enforcements": {
                            "actions": [
                                {
                                    "action": "LISTING_SUPPRESSED"
                                }
                            ],
                            "exemption": {
                                "status": "EXEMPT",
                                "expiryDate": "2023-10-28T00:36:48.914Z"
                            }
                        }
                    }
                ],
                "offers": [
                    {
                        "marketplaceId": "string",
                        "offerType": "B2C",
                        "price": {
                            "currencyCode": "string",
                            "amount": "string"
                        },
                        "points": {
                            "pointsNumber": 0,
                            "pointsMonetaryValue": {
                                "currencyCode": "string",
                                "amount": 0
                            }
                        },
                        "audience": {
                            "value": "ALL",
                            "displayName": "string"
                        }
                    }
                ],
                "fulfillmentAvailability": [
                    {
                        "fulfillmentChannelCode": "string",
                        "quantity": 0
                    }
                ],
                "procurement": [
                    {
                        "costPrice": {
                            "currencyCode": "string",
                            "amount": "string"
                        }
                    }
                ]
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses