Download OpenAPI specification:Download
The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.
For more information, refer to the Catalog Items API Use Case Guide.
Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.
Usage Plans:
Rate (requests per second) | Burst |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the Usage Plans and Rate Limits in the Selling Partner API.
identifiers | Array of strings <= 20 items A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with |
identifiersType | string Enum: "ASIN" "EAN" "GTIN" "ISBN" "JAN" "MINSAN" "SKU" "UPC" Type of product identifiers to search the Amazon catalog for. Note: Required when |
marketplaceIds required | Array of strings <= 1 items A comma-delimited list of Amazon marketplace identifiers for the request. |
includedData | Array of strings Items Enum: "attributes" "dimensions" "identifiers" "images" "productTypes" "relationships" "salesRanks" "summaries" "vendorDetails" A comma-delimited list of data sets to include in the response. Default: |
locale | string Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. |
sellerId | string A selling partner identifier, such as a seller account or vendor code. Note: Required when |
keywords | Array of strings <= 20 items A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with |
brandNames | Array of strings A comma-delimited list of brand names to limit the search for |
classificationIds | Array of strings A comma-delimited list of classification identifiers to limit the search for |
pageSize | integer <int32> <= 20 Default: 10 Number of results to be returned per page. |
pageToken | string A token to fetch a certain page when there are multiple pages worth of results. |
keywordsLocale | string The language of the keywords provided for |
Content-Type | string Value: "application/json" |
{- "numberOfResults": 0,
- "pagination": {
- "nextToken": "string",
- "previousToken": "string"
}, - "refinements": {
- "brands": [
- {
- "numberOfResults": 0,
- "brandName": "string"
}
], - "classifications": [
- {
- "numberOfResults": 0,
- "displayName": "string",
- "classificationId": "string"
}
]
}, - "items": [
- {
- "asin": "string",
- "attributes": { },
- "dimensions": [
- {
- "marketplaceId": "string",
- "item": {
- "height": {
- "unit": "string",
- "value": 0
}, - "length": {
- "unit": "string",
- "value": 0
}, - "weight": {
- "unit": "string",
- "value": 0
}, - "width": {
- "unit": "string",
- "value": 0
}
}, - "package": {
- "height": {
- "unit": "string",
- "value": 0
}, - "length": {
- "unit": "string",
- "value": 0
}, - "weight": {
- "unit": "string",
- "value": 0
}, - "width": {
- "unit": "string",
- "value": 0
}
}
}
], - "identifiers": [
- {
- "marketplaceId": "string",
- "identifiers": [
- {
- "identifierType": "string",
- "identifier": "string"
}
]
}
], - "images": [
- {
- "marketplaceId": "string",
- "images": [
- {
- "variant": "MAIN",
- "link": "string",
- "height": 0,
- "width": 0
}
]
}
], - "productTypes": [
- {
- "marketplaceId": "string",
- "productType": "LUGGAGE"
}
], - "relationships": [
- {
- "marketplaceId": "string",
- "relationships": [
- {
- "childAsins": [
- "string"
], - "parentAsins": [
- "string"
], - "variationTheme": {
- "attributes": [
- "string"
], - "theme": "COLOR_NAME/STYLE_NAME"
}, - "type": "VARIATION"
}
]
}
], - "salesRanks": [
- {
- "marketplaceId": "string",
- "classificationRanks": [
- {
- "classificationId": "string",
- "title": "string",
- "link": "string",
- "rank": 0
}
], - "displayGroupRanks": [
- {
- "websiteDisplayGroup": "string",
- "title": "string",
- "link": "string",
- "rank": 0
}
]
}
], - "summaries": [
- {
- "marketplaceId": "string",
- "brand": "string",
- "browseClassification": {
- "displayName": "string",
- "classificationId": "string"
}, - "color": "string",
- "itemClassification": "BASE_PRODUCT",
- "itemName": "string",
- "manufacturer": "string",
- "modelNumber": "string",
- "packageQuantity": 0,
- "partNumber": "string",
- "size": "string",
- "style": "string",
- "websiteDisplayGroup": "string",
- "websiteDisplayGroupName": "string"
}
], - "vendorDetails": [
- {
- "marketplaceId": "string",
- "brandCode": "string",
- "manufacturerCode": "string",
- "manufacturerCodeParent": "string",
- "productCategory": {
- "displayName": "string",
- "value": "string"
}, - "productGroup": "string",
- "productSubcategory": {
- "displayName": "string",
- "value": "string"
}, - "replenishmentCategory": "ALLOCATED"
}
]
}
]
}
Retrieves details for an item in the Amazon catalog.
Usage Plan:
Rate (requests per second) | Burst |
---|---|
2 | 2 |
The x-amzn-RateLimit-Limit
response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the Usage Plans and Rate Limits in the Selling Partner API.
asin required | string The Amazon Standard Identification Number (ASIN) of the item. |
marketplaceIds required | Array of strings A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces. |
includedData | Array of strings Items Enum: "attributes" "dimensions" "identifiers" "images" "productTypes" "relationships" "salesRanks" "summaries" "vendorDetails" A comma-delimited list of data sets to include in the response. Default: |
locale | string Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace. |
Content-Type | string Value: "application/json" |
{- "asin": "string",
- "attributes": { },
- "dimensions": [
- {
- "marketplaceId": "string",
- "item": {
- "height": {
- "unit": "string",
- "value": 0
}, - "length": {
- "unit": "string",
- "value": 0
}, - "weight": {
- "unit": "string",
- "value": 0
}, - "width": {
- "unit": "string",
- "value": 0
}
}, - "package": {
- "height": {
- "unit": "string",
- "value": 0
}, - "length": {
- "unit": "string",
- "value": 0
}, - "weight": {
- "unit": "string",
- "value": 0
}, - "width": {
- "unit": "string",
- "value": 0
}
}
}
], - "identifiers": [
- {
- "marketplaceId": "string",
- "identifiers": [
- {
- "identifierType": "string",
- "identifier": "string"
}
]
}
], - "images": [
- {
- "marketplaceId": "string",
- "images": [
- {
- "variant": "MAIN",
- "link": "string",
- "height": 0,
- "width": 0
}
]
}
], - "productTypes": [
- {
- "marketplaceId": "string",
- "productType": "LUGGAGE"
}
], - "relationships": [
- {
- "marketplaceId": "string",
- "relationships": [
- {
- "childAsins": [
- "string"
], - "parentAsins": [
- "string"
], - "variationTheme": {
- "attributes": [
- "string"
], - "theme": "COLOR_NAME/STYLE_NAME"
}, - "type": "VARIATION"
}
]
}
], - "salesRanks": [
- {
- "marketplaceId": "string",
- "classificationRanks": [
- {
- "classificationId": "string",
- "title": "string",
- "link": "string",
- "rank": 0
}
], - "displayGroupRanks": [
- {
- "websiteDisplayGroup": "string",
- "title": "string",
- "link": "string",
- "rank": 0
}
]
}
], - "summaries": [
- {
- "marketplaceId": "string",
- "brand": "string",
- "browseClassification": {
- "displayName": "string",
- "classificationId": "string"
}, - "color": "string",
- "itemClassification": "BASE_PRODUCT",
- "itemName": "string",
- "manufacturer": "string",
- "modelNumber": "string",
- "packageQuantity": 0,
- "partNumber": "string",
- "size": "string",
- "style": "string",
- "websiteDisplayGroup": "string",
- "websiteDisplayGroupName": "string"
}
], - "vendorDetails": [
- {
- "marketplaceId": "string",
- "brandCode": "string",
- "manufacturerCode": "string",
- "manufacturerCodeParent": "string",
- "productCategory": {
- "displayName": "string",
- "value": "string"
}, - "productGroup": "string",
- "productSubcategory": {
- "displayName": "string",
- "value": "string"
}, - "replenishmentCategory": "ALLOCATED"
}
]
}