"description":"The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.\n\nFor more information, see the [Catalog Items API Use Case Guide](doc:catalog-items-api-v2020-12-01-use-case-guide).",
"description":"Search for and return a list of Amazon catalog items and associated information.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 5 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"A comma-delimited list of words or item identifiers to search the Amazon catalog for.",
"in":"query",
"required":true,
"type":"array",
"items":{
"type":"string"
},
"collectionFormat":"csv",
"x-example":"shoes"
},
{
"name":"marketplaceIds",
"description":"A comma-delimited list of Amazon marketplace identifiers for the request.",
"in":"query",
"required":true,
"type":"array",
"maxItems":1,
"items":{
"type":"string"
},
"collectionFormat":"csv",
"x-example":"ATVPDKIKX0DER"
},
{
"name":"includedData",
"description":"A comma-delimited list of data sets to include in the response. Default: summaries.",
"in":"query",
"required":false,
"type":"array",
"items":{
"enum":[
"identifiers",
"images",
"productTypes",
"salesRanks",
"summaries",
"variations",
"vendorDetails"
],
"type":"string",
"x-docgen-enum-table-extension":[
{
"value":"identifiers",
"description":"Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers."
},
{
"value":"images",
"description":"Images for an item in the Amazon catalog. All image variants are provided to brand owners; a thumbnail of the \"MAIN\" image variant is provided otherwise."
},
{
"value":"productTypes",
"description":"Product types associated with the Amazon catalog item."
},
{
"value":"salesRanks",
"description":"Sales ranks of an Amazon catalog item."
},
{
"value":"summaries",
"description":"Summary details of an Amazon catalog item."
},
{
"value":"variations",
"description":"Variation details of an Amazon catalog item (variation relationships)."
},
{
"value":"vendorDetails",
"description":"Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only."
}
]
},
"collectionFormat":"csv",
"x-example":"summaries",
"default":"summaries"
},
{
"name":"brandNames",
"description":"A comma-delimited list of brand names to limit the search to.",
"in":"query",
"required":false,
"type":"array",
"items":{
"type":"string"
},
"collectionFormat":"csv",
"x-example":"Beautiful Boats"
},
{
"name":"classificationIds",
"description":"A comma-delimited list of classification identifiers to limit the search to.",
"in":"query",
"required":false,
"type":"array",
"items":{
"type":"string"
},
"collectionFormat":"csv",
"x-example":"12345678"
},
{
"name":"pageSize",
"description":"Number of results to be returned per page.",
"in":"query",
"required":false,
"type":"integer",
"maximum":20,
"default":10,
"x-example":9
},
{
"name":"pageToken",
"description":"A token to fetch a certain page when there are multiple pages worth of results.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Retrieves details for an item in the Amazon catalog.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 5 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](doc:usage-plans-and-rate-limits-in-the-sp-api).",
"description":"A JSON object containing structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners and conform to the related Amazon product type definitions available in the Selling Partner API for Product Type Definitions."
"description":"Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers."
},
{
"value":"images",
"description":"Images for an item in the Amazon catalog. All image variants are provided to brand owners. Otherwise, a thumbnail of the \"MAIN\" image variant is provided."
},
{
"value":"productTypes",
"description":"Product types associated with the Amazon catalog item."
},
{
"value":"salesRanks",
"description":"Sales ranks of an Amazon catalog item."
},
{
"value":"summaries",
"description":"Summary details of an Amazon catalog item."
},
{
"value":"variations",
"description":"Variation details of an Amazon catalog item (variation relationships)."
},
{
"value":"vendorDetails",
"description":"Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only."
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners and conform to the related product type definitions available in the Selling Partner API for Product Type Definitions.",
"description":"Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.",
"properties":{
"marketplaceId":{
"description":"Amazon marketplace identifier.",
"type":"string"
},
"identifiers":{
"description":"Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.",
"items":{
"$ref":"#/definitions/ItemIdentifier"
},
"type":"array"
}
},
"required":[
"marketplaceId",
"identifiers"
],
"type":"object"
},
"ItemIdentifier":{
"description":"Identifier associated with the item in the Amazon catalog, such as a UPC or EAN identifier.",
"properties":{
"identifierType":{
"description":"Type of identifier, such as UPC, EAN, or ISBN.",
"type":"string"
},
"identifier":{
"description":"Identifier.",
"type":"string"
}
},
"required":[
"identifierType",
"identifier"
],
"type":"object"
},
"ItemImages":{
"description":"Images for an item in the Amazon catalog. All image variants are provided to brand owners. Otherwise, a thumbnail of the \"MAIN\" image variant is provided.",
"items":{
"$ref":"#/definitions/ItemImagesByMarketplace"
},
"type":"array"
},
"ItemImagesByMarketplace":{
"description":"Images for an item in the Amazon catalog for the indicated Amazon marketplace.",
"properties":{
"marketplaceId":{
"description":"Amazon marketplace identifier.",
"type":"string"
},
"images":{
"description":"Images for an item in the Amazon catalog for the indicated Amazon marketplace.",
"items":{
"$ref":"#/definitions/ItemImage"
},
"type":"array"
}
},
"required":[
"marketplaceId",
"images"
],
"type":"object"
},
"ItemImage":{
"description":"Image for an item in the Amazon catalog.",
"properties":{
"variant":{
"description":"Variant of the image, such as MAIN or PT01.",
"example":"MAIN",
"type":"string",
"enum":[
"MAIN",
"PT01",
"PT02",
"PT03",
"PT04",
"PT05",
"PT06",
"PT07",
"PT08",
"SWCH"
],
"x-docgen-enum-table-extension":[
{
"value":"MAIN",
"description":"Main image for the item."
},
{
"value":"PT01",
"description":"Other image #1 for the item."
},
{
"value":"PT02",
"description":"Other image #2 for the item."
},
{
"value":"PT03",
"description":"Other image #3 for the item."
},
{
"value":"PT04",
"description":"Other image #4 for the item."
},
{
"value":"PT05",
"description":"Other image #5 for the item."
},
{
"value":"PT06",
"description":"Other image #6 for the item."
},
{
"value":"PT07",
"description":"Other image #7 for the item."
},
{
"value":"PT08",
"description":"Other image #8 for the item."
},
{
"value":"SWCH",
"description":"Swatch image for the item."
}
]
},
"link":{
"description":"Link, or URL, for the image.",
"type":"string"
},
"height":{
"description":"Height of the image in pixels.",
"type":"integer"
},
"width":{
"description":"Width of the image in pixels.",
"type":"integer"
}
},
"required":[
"variant",
"link",
"height",
"width"
],
"type":"object"
},
"ItemProductTypes":{
"description":"Product types associated with the Amazon catalog item.",
"description":"Items in the Amazon catalog and search related metadata.",
"properties":{
"numberOfResults":{
"description":"The estimated total number of products matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).\n\nNote: The maximum number of items (ASINs) that can be returned and paged through is 1000.",
"type":"integer"
},
"pagination":{
"description":"If available, the nextToken and/or previousToken values required to return paginated results.",
"$ref":"#/definitions/Pagination"
},
"refinements":{
"$ref":"#/definitions/Refinements"
},
"items":{
"description":"A list of items from the Amazon catalog.",
"type":"array",
"items":{
"$ref":"#/definitions/Item"
}
}
},
"required":[
"numberOfResults",
"pagination",
"refinements",
"items"
],
"type":"object"
},
"Pagination":{
"description":"When a request produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there will be no nextToken key in the pagination object.",
"properties":{
"nextToken":{
"description":"A token that can be used to fetch the next page.",
"type":"string"
},
"previousToken":{
"description":"A token that can be used to fetch the previous page.",