{
"swagger": "2.0",
"info": {
"title": "Products API",
"description": "Use the Amazon Products API to search Amazon's catalog, get product details, get variations, and get featured offers (the Buy Box) for products.",
"version": "2020-08-26"
},
"host": "sellingpartnerapi-na.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/products/2020-08-26/products": {
"get": {
"tags": [
"products"
],
"description": "Returns a list of products and their attributes, based on a search query or item identifier. **Note:** Cannot return more than 10 products per request. The total number of matching products for a keywords-based query may exceed 10. If that is the case, the returned value contains pagination tokens and you can make additional calls to get more products.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.033 | 1 |\n\nThe `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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "searchCatalogItems",
"parameters": [
{
"name": "keywords",
"in": "query",
"description": "A comma-delimited list of words or item identifiers to search the Amazon catalog for.",
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "marketplaceIds",
"in": "query",
"description": "A comma-delimited list of Amazon marketplace identifiers for the request.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "inclusionsForProducts",
"in": "query",
"description": "A comma-delimited list of data sets to include in the response. Default: summaries.",
"type": "array",
"items": {
"type": "string",
"enum": [
"attributes",
"dimensions",
"identifiers",
"images",
"productTypes",
"relationships",
"salesRanks",
"summaries",
"vendorDetails",
"classifications",
"browseClassification",
"fulfillmentAvailability",
"prices",
"fees",
"offers",
"eligibilityStatus",
"asin",
"externalIds",
"productVariations",
"variationImages",
"legalInformation",
"isCustomQuoteEligible",
"manufacturerInfo",
"additionalAttributes"
]
},
"collectionFormat": "csv"
},
{
"name": "locale",
"in": "query",
"description": "Locale for retrieving data such as attributes, in the format language_territory, such as en_US.",
"type": "string"
},
{
"name": "sellerId",
"in": "query",
"description": "A selling partner identifier, such as a seller account or vendor code.",
"type": "string"
},
{
"name": "identifiersType",
"in": "query",
"description": "Type of product identifiers to search the Amazon catalog for.",
"type": "string",
"enum": [
"ASIN",
"EAN",
"GTIN",
"ISBN",
"JAN",
"MINSAN",
"SKU",
"UPC"
]
},
{
"name": "identifiers",
"in": "query",
"description": "A comma-delimited list of product identifiers to search the Amazon catalog for.",
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "pageToken",
"in": "query",
"description": "A token to fetch a certain page when there are multiple pages worth of results.",
"type": "string"
},
{
"name": "keywordsLocale",
"in": "query",
"description": "The language the keywords are provided in. Defaults to the primary locale of the marketplace.",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/SearchCatalogItemsResponse"
},
"examples": {
"application/json": {
"numberOfResults": 1,
"pagination": {
"nextToken": "AAA",
"previousToken": "BBB"
},
"refinements": {
"brands": [
{
"numberOfResults": 1,
"brandName": "Nike"
}
],
"classifications": [
{
"numberOfResults": 1,
"classificationId": "12345",
"displayName": "Shoes"
}
]
},
"items": []
}
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
},
"/products/2020-08-26/products/{productId}": {
"get": {
"tags": [
"products"
],
"description": "Returns the product for a specified item in the Amazon catalog.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getCatalogItem",
"parameters": [
{
"name": "marketplaceIds",
"in": "query",
"description": "A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "inclusionsForProducts",
"in": "query",
"description": "A comma-delimited list of data sets to include in the response. Default: summaries.",
"type": "array",
"items": {
"type": "string",
"enum": [
"attributes",
"dimensions",
"identifiers",
"images",
"productTypes",
"relationships",
"salesRanks",
"summaries",
"vendorDetails",
"classifications",
"browseClassification",
"fulfillmentAvailability",
"prices",
"fees",
"offers",
"eligibilityStatus",
"asin",
"externalIds",
"productVariations",
"variationImages",
"legalInformation",
"manufacturerInfo",
"additionalAttributes"
]
},
"collectionFormat": "csv"
},
{
"name": "locale",
"in": "query",
"description": "Locale for retrieving data such as attributes, in the format language_territory, such as en_US.",
"type": "string"
},
{
"name": "productId",
"in": "path",
"description": "The identifier for the item in the Amazon catalog.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Success.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ProductResult"
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
},
"/products/2020-08-26/products/getProductsByAsins": {
"post": {
"tags": [
"products"
],
"description": "Returns a list of products and their attributes based on a list of ASIN values.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 2 |\n\nThe `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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"operationId": "getProductsByAsins",
"parameters": [
{
"name": "marketplaceIds",
"in": "query",
"description": "A comma-delimited list of Amazon marketplace identifiers for the request.",
"required": true,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "csv"
},
{
"name": "inclusionsForProducts",
"in": "query",
"description": "A comma-delimited list of data sets to include in the response. Default: summaries.",
"type": "array",
"items": {
"type": "string",
"enum": [
"attributes",
"dimensions",
"identifiers",
"images",
"productTypes",
"relationships",
"salesRanks",
"summaries",
"vendorDetails",
"classifications",
"browseClassification",
"fulfillmentAvailability",
"prices",
"fees",
"offers",
"eligibilityStatus",
"asin",
"externalIds",
"productVariations",
"variationImages",
"legalInformation",
"isCustomQuoteEligible",
"manufacturerInfo",
"additionalAttributes"
]
},
"collectionFormat": "csv"
},
{
"name": "locale",
"in": "query",
"description": "Locale for retrieving data such as attributes, in the format language_territory, such as en_US.",
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "The request body for the getProductsByAsins operation.",
"required": true,
"schema": {
"$ref": "#/definitions/GetProductsByAsinsRequest"
}
}
],
"responses": {
"200": {
"description": "Success.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/GetProductsByAsinsResponse"
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "Your rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"description": "Unique request reference identifier.",
"type": "string"
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
}
},
"definitions": {
"SearchCatalogItemsResponse": {
"description": "Response schema for the searchCatalogItems operation.",
"type": "object",
"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).",
"type": "integer"
},
"pagination": {
"description": "If available, the nextToken and/or previousToken values required to return paginated results.",
"$ref": "#/definitions/Pagination"
},
"refinements": {
"description": "Search refinements.",
"$ref": "#/definitions/Refinements"
},
"items": {
"description": "A list of items from the Amazon catalog.",
"type": "array",
"items": {
"$ref": "#/definitions/ProductResult"
}
}
},
"required": [
"numberOfResults",
"items"
]
},
"Pagination": {
"description": "The pagination tokens required to return paginated results.",
"type": "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.",
"type": "string"
}
}
},
"Refinements": {
"description": "Search refinements.",
"type": "object",
"properties": {
"brands": {
"description": "Brand search refinements.",
"type": "array",
"items": {
"$ref": "#/definitions/BrandRefinement"
}
},
"classifications": {
"description": "Classification search refinements.",
"type": "array",
"items": {
"$ref": "#/definitions/ClassificationRefinement"
}
}
},
"required": [
"brands",
"classifications"
]
},
"BrandRefinement": {
"description": "Description of a brand that can be used to get more fine-grained search results.",
"type": "object",
"properties": {
"numberOfResults": {
"description": "The approximate number of results that would still be returned if refinement key applied.",
"type": "integer"
},
"brandName": {
"description": "Brand name. For display and can be used as input for future searches.",
"type": "string"
}
},
"required": [
"numberOfResults",
"brandName"
]
},
"ClassificationRefinement": {
"description": "Description of a classification that can be used to get more fine-grained search results.",
"type": "object",
"properties": {
"numberOfResults": {
"description": "The approximate number of results that would still be returned if refinement key applied.",
"type": "integer"
},
"displayName": {
"description": "Display name for the classification.",
"type": "string"
},
"classificationId": {
"description": "Identifier for the classification that can be used for search refinement purposes.",
"type": "string"
}
},
"required": [
"numberOfResults",
"displayName",
"classificationId"
]
},
"ProductResult": {
"description": "An item in the Amazon catalog.",
"type": "object",
"properties": {
"asin": {
"description": "Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog.",
"type": "string"
},
"attributes": {
"description": "A JSON object that contains structured item attribute data keyed by attribute name.",
"type": "object"
},
"dimensions": {
"description": "Array of dimensions associated with the item in the Amazon catalog by Amazon marketplace.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemDimensionsByMarketplace"
}
},
"identifiers": {
"description": "Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemIdentifiersByMarketplace"
}
},
"images": {
"description": "Images for an item in the Amazon catalog.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemImagesByMarketplace"
}
},
"productTypes": {
"description": "Product types associated with the Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemProductTypeByMarketplace"
}
},
"relationships": {
"description": "Relationships by marketplace for an Amazon catalog item (for example, variations).",
"type": "array",
"items": {
"$ref": "#/definitions/ItemRelationshipsByMarketplace"
}
},
"salesRanks": {
"description": "Sales ranks of an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemSalesRanksByMarketplace"
}
},
"summaries": {
"description": "Summary details of an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemSummaryByMarketplace"
}
},
"vendorDetails": {
"description": "Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemVendorDetailsByMarketplace"
}
},
"classifications": {
"description": "Classification details by marketplace for the Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemClassificationsByMarketplace"
}
}
},
"required": [
"asin"
]
},
"ProductsResult": {
"description": "A product result containing product information and optional data sets.",
"type": "object",
"properties": {
"asin": {
"description": "Amazon Standard Identification Number (ASIN) is the unique identifier for an item in the Amazon catalog.",
"type": "string"
},
"attributes": {
"description": "A JSON object that contains structured item attribute data keyed by attribute name.",
"type": "object"
},
"summaries": {
"description": "Summary details of an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemSummaryByMarketplace"
}
},
"identifiers": {
"description": "Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemIdentifiersByMarketplace"
}
},
"images": {
"description": "Images for an item in the Amazon catalog.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemImagesByMarketplace"
}
},
"productTypes": {
"description": "Product types associated with the Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemProductTypeByMarketplace"
}
},
"relationships": {
"description": "Relationships by marketplace for an Amazon catalog item (for example, variations).",
"type": "array",
"items": {
"$ref": "#/definitions/ItemRelationshipsByMarketplace"
}
},
"salesRanks": {
"description": "Sales ranks of an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemSalesRanksByMarketplace"
}
},
"fulfillmentAvailability": {
"description": "Fulfillment availability for an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/FulfillmentAvailability"
}
},
"prices": {
"description": "Prices for an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemPrice"
}
},
"fees": {
"description": "Fees for an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemFees"
}
},
"offers": {
"description": "Offers for an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemOffers"
}
},
"eligibilityStatus": {
"description": "Eligibility status for an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemEligibilityStatus"
}
},
"externalIds": {
"description": "External identifiers for an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemExternalIdentifiersByMarketplace"
}
},
"productVariations": {
"description": "Product variations for an Amazon catalog item. Must be explicitly requested via inclusionsForProducts.",
"$ref": "#/definitions/ProductVariations"
},
"variationImages": {
"description": "Images associated with product variations, organized by dimension. Must be explicitly requested via inclusionsForProducts.",
"type": "array",
"items": {
"$ref": "#/definitions/VariationImageDimension"
}
},
"legalInformation": {
"description": "Legal information for an Amazon catalog item.",
"$ref": "#/definitions/LegalInformation"
},
"isCustomQuoteEligible": {
"description": "Indicates whether the item is eligible for custom quote.",
"type": "boolean"
},
"vendorDetails": {
"description": "Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemVendorDetailsByMarketplace"
}
},
"classifications": {
"description": "Classification details by marketplace for the Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemClassificationsByMarketplace"
}
},
"browseClassification": {
"description": "Browse classification associated with the Amazon catalog item.",
"$ref": "#/definitions/ItemBrowseClassification"
},
"manufacturerInfo": {
"description": "Manufacturer information for an Amazon catalog item.",
"$ref": "#/definitions/ManufacturerInfo"
},
"additionalAttributes": {
"description": "Additional attributes associated with the Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/AdditionalAttribute"
}
},
"dimensions": {
"description": "Array of dimensions associated with the item in the Amazon catalog by Amazon marketplace.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemDimensionsByMarketplace"
}
},
"vendorDetails2": {
"description": "Vendor details associated with an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemVendorDetailsByMarketplace"
}
}
},
"required": [
"asin",
"variationImages"
]
},
"GetProductsByAsinsRequest": {
"description": "Request schema for the getProductsByAsins operation.",
"type": "object",
"properties": {
"asins": {
"description": "A list of ASIN values for items in the Amazon catalog.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"asins"
]
},
"GetProductsByAsinsResponse": {
"description": "Response schema for the getProductsByAsins operation.",
"type": "object",
"properties": {
"items": {
"description": "A list of products from the Amazon catalog.",
"type": "array",
"items": {
"$ref": "#/definitions/ProductsResult"
}
},
"errors": {
"description": "A list of errors associated with the request.",
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
}
}
},
"ItemDimensionsByMarketplace": {
"description": "Physical dimensions associated with an item in the Amazon catalog for the indicated Amazon marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"item": {
"description": "Dimensions of an item.",
"$ref": "#/definitions/Dimensions"
},
"package": {
"description": "Dimensions of the item's package.",
"$ref": "#/definitions/Dimensions"
}
},
"required": [
"marketplaceId"
]
},
"Dimensions": {
"description": "The dimensions of an item or its packaging.",
"type": "object",
"properties": {
"height": {
"description": "The height of the item or its packaging.",
"$ref": "#/definitions/Dimension"
},
"length": {
"description": "The length of the item or its packaging.",
"$ref": "#/definitions/Dimension"
},
"weight": {
"description": "The weight of the item or its packaging.",
"$ref": "#/definitions/Dimension"
},
"width": {
"description": "The width of the item or its packaging.",
"$ref": "#/definitions/Dimension"
}
}
},
"Dimension": {
"description": "The value of a dimension measurement, such as height, length, width, or weight. exp. { unit: 'inches', value: 5.0, dimensionSymbol: 'color_name' }",
"type": "object",
"properties": {
"unit": {
"description": "The unit of measurement.",
"type": "string"
},
"value": {
"description": "The numeric value of the measurement.",
"type": "number"
},
"dimensionSymbol": {
"description": "A symbolic identifier for the dimension that links variations to their corresponding images. exp. color_name, size_name",
"type": "string"
}
}
},
"ItemIdentifiersByMarketplace": {
"description": "Identifiers associated with an item in the Amazon catalog for the indicated Amazon marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"identifiers": {
"description": "Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemIdentifier"
}
}
},
"required": [
"marketplaceId",
"identifiers"
]
},
"ItemIdentifier": {
"description": "An identifier associated with an item in the Amazon catalog.",
"type": "object",
"properties": {
"identifierType": {
"description": "Type of identifier, such as UPC, EAN, or ISBN.",
"type": "string"
},
"identifier": {
"description": "Identifier.",
"type": "string"
}
},
"required": [
"identifierType",
"identifier"
]
},
"ItemImagesByMarketplace": {
"description": "Images for an item in the Amazon catalog for the indicated Amazon marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"images": {
"description": "Images for an item in the Amazon catalog for the indicated Amazon marketplace.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemImage"
}
}
},
"required": [
"marketplaceId",
"images"
]
},
"ItemImage": {
"description": "An image associated with an item in the Amazon catalog.",
"type": "object",
"properties": {
"variant": {
"description": "Variant of the image, such as MAIN or PT01.",
"type": "string"
},
"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"
]
},
"ItemProductTypeByMarketplace": {
"description": "Product type associated with the Amazon catalog item for the indicated Amazon marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"productType": {
"description": "Name of the product type associated with the Amazon catalog item.",
"type": "string"
}
}
},
"ItemRelationshipsByMarketplace": {
"description": "Relationships by marketplace for an Amazon catalog item.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"relationships": {
"description": "Relationships for the Amazon catalog item for the indicated Amazon marketplace.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemRelationship"
}
}
},
"required": [
"marketplaceId",
"relationships"
]
},
"ItemRelationship": {
"description": "Relationship details for an Amazon catalog item.",
"type": "object",
"properties": {
"childAsins": {
"description": "Child ASINs that make up the relationship.",
"type": "array",
"items": {
"type": "string"
}
},
"parentAsins": {
"description": "Parent ASINs that make up the relationship.",
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"description": "Type of relationship.",
"type": "string",
"enum": [
"VARIATION",
"PACKAGE_HIERARCHY"
]
}
},
"required": [
"type"
]
},
"ItemSalesRanksByMarketplace": {
"description": "Sales ranks of an Amazon catalog item for the indicated Amazon marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"classificationRanks": {
"description": "Sales ranks of an Amazon catalog item for an Amazon marketplace by classification.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemClassificationSalesRank"
}
},
"displayGroupRanks": {
"description": "Sales ranks of an Amazon catalog item for an Amazon marketplace by website display group.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemDisplayGroupSalesRank"
}
}
},
"required": [
"marketplaceId"
]
},
"ItemClassificationSalesRank": {
"description": "Sales rank of an Amazon catalog item by classification.",
"type": "object",
"properties": {
"classificationId": {
"description": "Identifier of the classification associated with the sales rank.",
"type": "string"
},
"title": {
"description": "Title, or name, of the sales rank.",
"type": "string"
},
"link": {
"description": "Corresponding Amazon retail website link, or URL, for the sales rank.",
"type": "string"
},
"rank": {
"description": "Sales rank value.",
"type": "integer"
}
},
"required": [
"classificationId",
"title",
"rank"
]
},
"ItemDisplayGroupSalesRank": {
"description": "Sales rank of an Amazon catalog item by website display group.",
"type": "object",
"properties": {
"websiteDisplayGroup": {
"description": "Website display group associated with the sales rank.",
"type": "string"
},
"title": {
"description": "Title associated with the sales rank.",
"type": "string"
},
"link": {
"description": "Corresponding Amazon retail website link, or URL, for the sales rank.",
"type": "string"
},
"rank": {
"description": "Sales rank value.",
"type": "integer"
}
},
"required": [
"websiteDisplayGroup",
"title",
"rank"
]
},
"ItemSummaryByMarketplace": {
"description": "Summary details of an Amazon catalog item for the indicated Amazon marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"adultProduct": {
"description": "Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature.",
"type": "boolean"
},
"autographed": {
"description": "Identifies an Amazon catalog item is autographed by a player or celebrity.",
"type": "boolean"
},
"brand": {
"description": "Name of the brand associated with an Amazon catalog item.",
"type": "string"
},
"browseClassification": {
"description": "Classification (browse node) associated with an Amazon catalog item.",
"$ref": "#/definitions/ItemBrowseClassification"
},
"color": {
"description": "Name of the color associated with an Amazon catalog item.",
"type": "string"
},
"itemClassification": {
"description": "Classification type associated with the Amazon catalog item.",
"type": "string",
"enum": [
"BASE_PRODUCT",
"OTHER",
"PRODUCT_BUNDLE",
"SUB_PRODUCT",
"VARIATION_PARENT"
]
},
"itemName": {
"description": "Name, or title, associated with an Amazon catalog item.",
"type": "string"
},
"manufacturer": {
"description": "Name of the manufacturer associated with an Amazon catalog item.",
"type": "string"
},
"memorabilia": {
"description": "Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment.",
"type": "boolean"
},
"modelNumber": {
"description": "Model number associated with an Amazon catalog item.",
"type": "string"
},
"packageQuantity": {
"description": "Quantity of an Amazon catalog item in one package.",
"type": "integer"
},
"partNumber": {
"description": "Part number associated with an Amazon catalog item.",
"type": "string"
},
"releaseDate": {
"description": "First date on which an Amazon catalog item is shippable to customers.",
"type": "string",
"format": "date"
},
"size": {
"description": "Name of the size associated with an Amazon catalog item.",
"type": "string"
},
"style": {
"description": "Name of the style associated with an Amazon catalog item.",
"type": "string"
},
"tradeInEligible": {
"description": "Identifies an Amazon catalog item is eligible for trade-in.",
"type": "boolean"
},
"websiteDisplayGroup": {
"description": "Identifier of the website display group associated with an Amazon catalog item.",
"type": "string"
},
"websiteDisplayGroupName": {
"description": "Display name of the website display group associated with an Amazon catalog item.",
"type": "string"
}
},
"required": [
"marketplaceId"
]
},
"ItemBrowseClassification": {
"description": "Classification (browse node) associated with an Amazon catalog item.",
"type": "object",
"properties": {
"displayName": {
"description": "Display name for the classification.",
"type": "string"
},
"classificationId": {
"description": "Identifier of the classification (browse node identifier).",
"type": "string"
}
},
"required": [
"displayName",
"classificationId"
]
},
"ItemVendorDetailsByMarketplace": {
"description": "Vendor details associated with an Amazon catalog item for the indicated Amazon marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"brandCode": {
"description": "Brand code associated with an Amazon catalog item.",
"type": "string"
},
"categoryCode": {
"description": "Product category associated with an Amazon catalog item.",
"type": "string"
},
"manufacturerCode": {
"description": "Manufacturer code associated with an Amazon catalog item.",
"type": "string"
},
"manufacturerCodeParent": {
"description": "Parent vendor code of the manufacturer code.",
"type": "string"
},
"productGroup": {
"description": "Product group associated with an Amazon catalog item.",
"type": "string"
},
"replenishmentCategory": {
"description": "Replenishment category associated with an Amazon catalog item.",
"type": "string",
"enum": [
"ALLOCATED",
"BASIC_REPLENISHMENT",
"IN_SEASON",
"LIMITED_REPLENISHMENT",
"MANUFACTURER_OUT_OF_STOCK",
"NEW_PRODUCT",
"NON_REPLENISHABLE",
"NON_STOCKUPABLE",
"OBSOLETE",
"PLANNED_REPLENISHMENT"
]
},
"subcategoryCode": {
"description": "Product subcategory associated with an Amazon catalog item.",
"type": "string"
}
},
"required": [
"marketplaceId"
]
},
"ItemClassificationsByMarketplace": {
"description": "Classification details by marketplace for the Amazon catalog item.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"classifications": {
"description": "Array of classifications associated with the item in the Amazon catalog for the indicated Amazon marketplace.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemClassification"
}
}
},
"required": [
"marketplaceId",
"classifications"
]
},
"ItemClassification": {
"description": "Classification details for the Amazon catalog item.",
"type": "object",
"properties": {
"classificationId": {
"description": "Identifier of the item classification.",
"type": "string"
},
"displayName": {
"description": "Display name of the item classification.",
"type": "string"
},
"parent": {
"description": "Parent item classification.",
"$ref": "#/definitions/ItemClassification"
}
},
"required": [
"classificationId",
"displayName"
]
},
"FulfillmentAvailability": {
"description": "Fulfillment availability details for an Amazon catalog item.",
"type": "object",
"properties": {
"fulfillmentChannelCode": {
"description": "Fulfillment channel code.",
"type": "string"
},
"quantity": {
"description": "Quantity of the item available for fulfillment.",
"type": "integer"
}
},
"required": [
"fulfillmentChannelCode"
]
},
"ItemPrice": {
"description": "Price details for an Amazon catalog item.",
"type": "object",
"properties": {
"condition": {
"description": "Item condition.",
"type": "string"
},
"price": {
"description": "Price for an item.",
"$ref": "#/definitions/ItemOfferPrice"
},
"competitivePriceThreshold": {
"description": "Competitive price threshold for the item.",
"$ref": "#/definitions/ItemOfferPrice"
}
}
},
"ItemOfferPrice": {
"description": "Price details for an offer.",
"type": "object",
"properties": {
"currency": {
"description": "Currency of the price.",
"type": "string"
},
"amount": {
"description": "Amount of the price.",
"type": "number"
}
}
},
"ItemFees": {
"description": "Fees for an Amazon catalog item.",
"type": "object",
"properties": {
"feeType": {
"description": "Type of fee.",
"type": "string"
},
"feeAmount": {
"description": "Amount of the fee.",
"$ref": "#/definitions/ItemOfferPrice"
}
}
},
"ItemOffers": {
"description": "Offer details for an Amazon catalog item.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"buyBoxPrices": {
"description": "Buy box prices for the item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemPrice"
}
}
}
},
"ItemEligibilityStatus": {
"description": "Eligibility status for an Amazon catalog item.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"eligibilityStatus": {
"description": "Eligibility status for the item.",
"type": "string"
}
}
},
"ItemExternalIdentifiersByMarketplace": {
"description": "External identifiers for an Amazon catalog item by marketplace.",
"type": "object",
"properties": {
"marketplaceId": {
"description": "Amazon marketplace identifier.",
"type": "string"
},
"externalIds": {
"description": "External identifiers for the item.",
"type": "array",
"items": {
"$ref": "#/definitions/ItemExternalIdentifier"
}
}
}
},
"ItemExternalIdentifier": {
"description": "An external identifier for an Amazon catalog item.",
"type": "object",
"properties": {
"identifierType": {
"description": "Type of external identifier.",
"type": "string"
},
"identifier": {
"description": "External identifier value.",
"type": "string"
}
}
},
"ProductVariations": {
"description": "Product variation details for an Amazon catalog item.",
"type": "object",
"properties": {
"dimensions": {
"description": "Variation dimensions for an Amazon catalog item.",
"type": "array",
"items": {
"$ref": "#/definitions/Dimension2"
}
}
}
},
"Dimension2": {
"description": "A variation dimension with its possible values. exp. { index: 0, displayString: 'Color', dimensionSymbol: 'color_name', dimensionValues: [...] }",
"type": "object",
"properties": {
"index": {
"description": "Zero-based index of the dimension.",
"type": "integer"
},
"displayString": {
"description": "Display string of the dimension.",
"type": "string"
},
"dimensionSymbol": {
"description": "A symbolic identifier for the dimension that links variations to their corresponding images. exp. color_name, size_name",
"type": "string"
},
"dimensionValues": {
"description": "Values of the dimension.",
"type": "array",
"items": {
"$ref": "#/definitions/DimensionValue"
}
}
}
},
"DimensionValue": {
"description": "A value of a variation dimension.",
"type": "object",
"properties": {
"index": {
"description": "Zero-based index of the dimension value.",
"type": "integer"
},
"displayString": {
"description": "Display string of the dimension value.",
"type": "string"
},
"metadata": {
"description": "Optional metadata associated with this dimension value, such as color code information.",
"$ref": "#/definitions/DimensionValueMetadata"
}
}
},
"LegalInformation": {
"description": "Legal information for an Amazon catalog item.",
"type": "object",
"properties": {
"legalDisclaimer": {
"description": "Legal disclaimer for the item.",
"type": "string"
},
"warrantyText": {
"description": "Warranty text for the item.",
"type": "string"
}
}
},
"ManufacturerInfo": {
"description": "Manufacturer information for an Amazon catalog item.",
"type": "object",
"properties": {
"manufacturerName": {
"description": "Name of the manufacturer.",
"type": "string"
},
"manufacturerAddress": {
"description": "Address of the manufacturer.",
"type": "string"
},
"manufacturerContactInfo": {
"description": "Contact information for the manufacturer.",
"type": "string"
}
}
},
"AdditionalAttribute": {
"description": "An additional attribute associated with an Amazon catalog item.",
"type": "object",
"properties": {
"name": {
"description": "Name of the attribute.",
"type": "string"
},
"value": {
"description": "Value of the attribute.",
"type": "string"
}
}
},
"VariationImageDimension": {
"description": "A dimension with associated variation images, linking image data to a specific dimension like color.",
"type": "object",
"properties": {
"dimensionSymbol": {
"description": "The symbolic identifier for this dimension. exp. color_name",
"type": "string"
},
"variationImages": {
"description": "List of images for each value within this dimension.",
"type": "array",
"items": {
"$ref": "#/definitions/VariationImage"
}
}
}
},
"VariationImage": {
"description": "Image data for a specific variation dimension value, including thumbnail and large URLs.",
"type": "object",
"properties": {
"dimensionValue": {
"description": "The dimension value this image is associated with. exp. Red",
"type": "string"
},
"thumbnailUrl": {
"description": "URL of the thumbnail-sized image for this variation.",
"type": "string"
},
"largeUrl": {
"description": "URL of the large-sized image for this variation.",
"type": "string"
}
}
},
"DimensionValueMetadata": {
"description": "Metadata associated with a dimension value, containing additional information such as color codes.",
"type": "object",
"properties": {
"colorCode": {
"description": "Color code information for this dimension value.",
"$ref": "#/definitions/ColorCode"
}
}
},
"ColorCode": {
"description": "Color information represented as a hex value.",
"type": "object",
"properties": {
"primaryColor": {
"description": "The primary color hex value. exp. #F231212",
"type": "string"
}
}
},
"ErrorList": {
"description": "A list of error responses returned when a request is unsuccessful.",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
}
},
"required": [
"errors"
]
},
"Error": {
"description": "Error response returned when the request is unsuccessful.",
"type": "object",
"properties": {
"code": {
"description": "An error code that identifies the type of error that occurred.",
"type": "string"
},
"message": {
"description": "A message that describes the error condition in a human-readable form.",
"type": "string"
},
"details": {
"description": "Additional details that can help the caller understand or fix the issue.",
"type": "string"
}
},
"required": [
"code",
"message"
]
}
}
}
