Product Search API v1 model
{
"swagger": "2.0",
"info": {
"title": "Amazon Business API for Products",
"description": "With the Amazon Business API for Products, you can build applications that help Amazon Business customers search for products, get product information, and corresponding offer information.",
"version": "2020-08-26",
"contact": {
"name": "AB Support",
"url": "https://developer-docs.amazon.com/amazon-business/"
},
"license": {
"name": "Amazon Software License",
"url": "https://aws.amazon.com/asl/"
}
},
"externalDocs": {
"description": "Learn more about Amazon Business.",
"url": "https://business.amazon.com"
},
"host": "api.business.amazon.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/products/2020-08-26/products": {
"get": {
"operationId": "searchProductsRequest",
"description": "Searches for products in the Amazon Business catalog using keywords or item identifiers.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.",
"summary": "Search for a list of products by keyword and additional filter criteria.",
"parameters": [
{
"name": "x-amz-user-email",
"in": "header",
"description": "The email address of the customer requesting this resource.",
"required": true,
"type": "string"
},
{
"name": "productRegion",
"in": "query",
"description": "The region where the customer wants to purchase the product.",
"required": true,
"type": "string",
"enum": ["DE", "FR", "UK", "IT", "ES", "IN", "US", "CA", "MX", "JP", "AU"],
"x-docgen-enum-table-extension": [
{"value": "DE", "description": "Germany"},
{"value": "FR", "description": "France"},
{"value": "UK", "description": "United Kingdom"},
{"value": "IT", "description": "Italy"},
{"value": "ES", "description": "Spain"},
{"value": "IN", "description": "India"},
{"value": "US", "description": "United States of America"},
{"value": "CA", "description": "Canada"},
{"value": "MX", "description": "Mexico"},
{"value": "JP", "description": "Japan"},
{"value": "AU", "description": "Australia"}
]
},
{
"name": "locale",
"in": "query",
"description": "The locale of the request in the form of an IETF language tag. The format is [two-letter language code]-[Two-letter country code], such as en-US for American English. This value should comply with java.util.Locale.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z_-]+$"
},
{
"name": "keywords",
"in": "query",
"description": "A list of keywords to use for finding products based on indexed data.",
"required": false,
"type": "string"
},
{
"name": "shippingRegion",
"in": "query",
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"required": false,
"type": "string"
},
{
"name": "shippingPostalCode",
"in": "query",
"description": "The shipping postal or zip code for the customer's request. This parameter doesn't support geocode.",
"required": false,
"type": "string"
},
{
"name": "facets",
"in": "query",
"description": "A list of data facets to include in the response. Separate each facet with a comma.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["OFFERS", "IMAGES"]
}
},
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number. Maximum pages that can be fetched: 13.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Requested number of products per page. Maximum: 24.",
"required": false,
"type": "integer",
"default": 24
},
{
"name": "groupTag",
"in": "query",
"description": "A value that identifies the group within the business account that a customer belongs to. GroupTag is necessary only if the customer account belongs to more than one group.",
"required": false,
"type": "string"
},
{
"name": "category",
"in": "query",
"description": "Restricts results to the specified category. Categories found under refinements->categories->id in the response.",
"required": false,
"type": "string"
},
{
"name": "subCategory",
"in": "query",
"description": "Restricts results to the specified subcategory ID. Found under refinements->subcategories->id.",
"required": false,
"type": "string"
},
{
"name": "availability",
"in": "query",
"description": "Restricts results by availability: 2661600011 (In Stock only) or 2661601011 (Include Out of Stock).",
"required": false,
"type": "string"
},
{
"name": "deliveryDay",
"in": "query",
"description": "Refines results by delivery date. Use the ID from response refinements.",
"required": false,
"type": "string"
},
{
"name": "eligibleForFreeShipping",
"in": "query",
"description": "Filters results to products with 'Free Shipping by Amazon Business' only.",
"required": false,
"type": "string"
},
{
"name": "primeEligible",
"in": "query",
"description": "Filters results to prime eligible products only.",
"required": false,
"type": "string"
},
{
"name": "upc",
"in": "query",
"description": "Restricts results to the specified Universal Product Code (UPC).",
"required": false,
"type": "string"
},
{
"name": "isbn",
"in": "query",
"description": "Restricts results to the specified ISBN (International Standard Book Number).",
"required": false,
"type": "string"
},
{
"name": "sku",
"in": "query",
"description": "Restricts results to the specified Stock Keeping Unit (SKU). Merchant-specific identifier.",
"required": false,
"type": "string"
},
{
"name": "ean",
"in": "query",
"description": "Restricts results to the specified EAN (European Article Number).",
"required": false,
"type": "string"
},
{
"name": "partNumber",
"in": "query",
"description": "Restricts results to the specified part number.",
"required": false,
"type": "string"
},
{
"name": "oemPartNumber",
"in": "query",
"description": "Restricts results to the specified OEM (Original Equipment Manufacturer) part number.",
"required": false,
"type": "string"
},
{
"name": "searchRefinements",
"in": "query",
"description": "A list of search refinements to narrow keyword search results. Example: brandtextbin#GE,brandtextbin#Sony,review-rating#2661618011",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {"type": "string"}
},
{
"name": "productFilters",
"in": "query",
"description": "Filters results by specific response field values. Format: fieldName#value. Example: isCustomQuoteEligible#true,bundleQuantity#10",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {"type": "string"}
},
{
"name": "inclusionsForProducts",
"in": "query",
"description": "A list specifying the product fields for inclusion in the response object. Excluding this query parameter returns response with all inclusions except upcValues, eanValues, modelNumber, and manufacturerName.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["ALL", "bookInformation", "byLine", "customerReviewsSummary", "editorialReviews", "features", "format", "mediaInformation", "productDescription", "productDetails", "productOverview", "productVariations", "taxonomies", "packageTypeNames", "title", "upcValues", "eanValues", "modelNumber", "manufacturerName", "bundleQuantity", "isCustomQuoteEligible", "badges", "isBundledAsin", "legalInformation"]
}
},
{
"name": "inclusionsForOffers",
"in": "query",
"description": "A list specifying the offer fields for inclusion in the response object. Excluding this query parameter results in the response including all inclusions.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["ALL", "availability", "buyingGuidance", "buyingGuidanceV2", "buyingRestrictions", "condition", "fulfillmentType", "merchant", "merchantCertificates", "price", "productCondition", "productConditionNote", "quantityLimits", "quantityPrice", "taxExclusivePrice", "deliveryInformation", "listPrice", "shippingOptions", "quantityInStock", "badges", "fulfiller"]
}
}
],
"responses": {
"200": {
"description": "The products were successfully retrieved.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/SearchProductsResult"
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"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": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
},
"/products/2020-08-26/products/{productId}": {
"get": {
"operationId": "productsRequest",
"description": "Retrieves a product with its ASIN identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.",
"summary": "Retrieves product data based on an ASIN identifier.",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "The Amazon Standard Item Identifier (ASIN) for the product.",
"required": true,
"type": "string"
},
{
"name": "productRegion",
"in": "query",
"description": "The region where the customer wants to purchase the product.",
"required": true,
"type": "string",
"enum": ["DE", "FR", "UK", "IT", "ES", "US", "CA", "MX", "JP", "AU"],
"x-docgen-enum-table-extension": [
{"value": "DE", "description": "Germany"},
{"value": "FR", "description": "France"},
{"value": "UK", "description": "United Kingdom"},
{"value": "IT", "description": "Italy"},
{"value": "ES", "description": "Spain"},
{"value": "US", "description": "United States of America"},
{"value": "CA", "description": "Canada"},
{"value": "MX", "description": "Mexico"},
{"value": "JP", "description": "Japan"},
{"value": "AU", "description": "Australia"}
]
},
{
"name": "locale",
"in": "query",
"description": "The locale of the request in the form of an IETF language tag. The format is [two-letter language code]-[Two-letter country code], such as en-US for American English. This value should comply with java.util.Locale.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z_-]+$"
},
{
"name": "x-amz-user-email",
"in": "header",
"description": "The email address of the customer requesting this resource.",
"required": true,
"type": "string"
},
{
"name": "shippingRegion",
"in": "query",
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"required": false,
"type": "string"
},
{
"name": "shippingPostalCode",
"in": "query",
"description": "The shipping postal or zip code for the customer's request. This parameter doesn't support geocode.",
"required": false,
"type": "string"
},
{
"name": "quantity",
"in": "query",
"description": "The number of units the customer intends to purchase. This helps Amazon Business determine quantity-based discounts if an eligible offer is present.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "facets",
"in": "query",
"description": "A list of data facets to include in the response. Separate each facet with a comma.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["OFFERS", "IMAGES"]
}
},
{
"name": "inclusionsForProducts",
"in": "query",
"description": "A list specifying the product fields for inclusion in the response object. Excluding this query parameter returns response with all inclusions except upcValues, eanValues, modelNumber, and manufacturerName.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["ALL", "bookInformation", "byLine", "customerReviewsSummary", "editorialReviews", "features", "format", "mediaInformation", "productDescription", "productDetails", "productOverview", "productVariations", "taxonomies", "packageTypeNames", "title", "upcValues", "eanValues", "modelNumber", "manufacturerName", "bundleQuantity", "badges", "isBundledAsin", "legalInformation"]
}
},
{
"name": "inclusionsForOffers",
"in": "query",
"description": "A list specifying the offer fields for inclusion in the response object. Excluding this query parameter results in the response including all inclusions.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["ALL", "availability", "buyingGuidance", "buyingGuidanceV2", "buyingRestrictions", "condition", "fulfillmentType", "merchant", "merchantCertificates", "price", "productCondition", "productConditionNote", "quantityLimits", "quantityPrice", "taxExclusivePrice", "deliveryInformation", "listPrice", "shippingOptions", "quantityInStock", "badges", "fulfiller"]
}
},
{
"name": "groupTag",
"in": "query",
"description": "A value that identifies the group within the business account that a customer belongs to. GroupTag is necessary only if the customer account belongs to more than one group.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The product was successfully retrieved.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ProductsResult"
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"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": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
},
"/products/2020-08-26/products/getProductsByAsins": {
"post": {
"operationId": "getProductsByAsins",
"description": "Retrieves products for the ASIN identifiers present in the list of ASINs.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.",
"summary": "Retrieves product data for a list of ASIN identifiers.",
"parameters": [
{
"name": "x-amz-user-email",
"in": "header",
"description": "The email address of the customer requesting this resource.",
"required": true,
"type": "string"
},
{
"name": "productsByAsins",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ProductsByAsinsRequest"
}
},
{
"name": "inclusionsForProducts",
"in": "query",
"description": "A list specifying the product fields for inclusion in the response object.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["ALL", "bookInformation", "byLine", "customerReviewsSummary", "editorialReviews", "features", "format", "mediaInformation", "productDescription", "productDetails", "productOverview", "productVariations", "taxonomies", "packageTypeNames", "title", "upcValues", "eanValues", "modelNumber", "manufacturerName", "bundleQuantity", "badges", "isBundledAsin", "legalInformation"]
}
},
{
"name": "inclusionsForOffers",
"in": "query",
"description": "A list specifying the offer fields for inclusion in the response object.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["ALL", "availability", "buyingGuidance", "buyingGuidanceV2", "buyingRestrictions", "condition", "fulfillmentType", "merchant", "merchantCertificates", "price", "productCondition", "productConditionNote", "quantityLimits", "quantityPrice", "taxExclusivePrice", "deliveryInformation", "listPrice", "shippingOptions", "quantityInStock", "badges", "fulfiller"]
}
},
{
"name": "groupTag",
"in": "query",
"description": "A value that identifies the group within the business account that a customer belongs to.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The products were successfully retrieved.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ProductsByAsinsResponse"
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"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": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
},
"/products/2020-08-26/products/{productId}/offers": {
"get": {
"operationId": "searchOffersRequest",
"description": "Searches for offers for a specific product using its ASIN.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 0.5 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.",
"summary": "Paginated and filtered search for offers of a specific product.",
"parameters": [
{
"name": "productId",
"in": "path",
"description": "The Amazon Standard Item Identifier (ASIN) for the product.",
"required": true,
"type": "string"
},
{
"name": "productRegion",
"in": "query",
"description": "The region where the customer wants to purchase the product.",
"required": true,
"type": "string",
"enum": ["DE", "FR", "UK", "IT", "ES", "IN", "US", "CA", "MX", "JP", "AU"],
"x-docgen-enum-table-extension": [
{"value": "DE", "description": "Germany"},
{"value": "FR", "description": "France"},
{"value": "UK", "description": "United Kingdom"},
{"value": "IT", "description": "Italy"},
{"value": "ES", "description": "Spain"},
{"value": "IN", "description": "India"},
{"value": "US", "description": "United States of America"},
{"value": "CA", "description": "Canada"},
{"value": "MX", "description": "Mexico"},
{"value": "JP", "description": "Japan"},
{"value": "AU", "description": "Australia"}
]
},
{
"name": "locale",
"in": "query",
"description": "The locale of the request in the form of an IETF language tag. The format is [two-letter language code]-[Two-letter country code], such as en-US for American English. This value should comply with java.util.Locale.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z_-]+$"
},
{
"name": "x-amz-user-email",
"in": "header",
"description": "The email address of the customer requesting this resource.",
"required": true,
"type": "string"
},
{
"name": "shippingRegion",
"in": "query",
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"required": false,
"type": "string"
},
{
"name": "shippingPostalCode",
"in": "query",
"description": "The shipping postal or zip code for the customer's request. This parameter doesn't support geocode.",
"required": false,
"type": "string"
},
{
"name": "pageNumber",
"in": "query",
"description": "Zero-based page number. Maximum pages that can be fetched: 13.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Number of offers per page. Maximum: 24.",
"required": false,
"type": "integer",
"default": 24
},
{
"name": "groupTag",
"in": "query",
"description": "A value that identifies the group within the business account that a customer belongs to. GroupTag is necessary only if the customer account belongs to more than one group.",
"required": false,
"type": "string"
},
{
"name": "filterIds",
"in": "query",
"description": "A list of filter IDs to query results.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {"type": "string"}
},
{
"name": "quantity",
"in": "query",
"description": "The number of units the customer intends to purchase. This helps Amazon Business determine quantity-based discounts if an eligible offer is present.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "inclusionsForOffers",
"in": "query",
"description": "A list specifying the offer fields for inclusion in the response object. Excluding this query parameter results in the response including all inclusions.",
"required": false,
"type": "array",
"collectionFormat": "csv",
"items": {
"type": "string",
"enum": ["ALL", "availability", "buyingGuidance", "buyingGuidanceV2", "buyingRestrictions", "condition", "fulfillmentType", "merchant", "merchantCertificates", "price", "productCondition", "productConditionNote", "quantityLimits", "quantityPrice", "taxExclusivePrice", "deliveryInformation", "listPrice", "shippingOptions", "quantityInStock", "badges", "fulfiller"]
}
}
],
"responses": {
"200": {
"description": "The offers were successfully retrieved.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/OffersResult"
}
},
"400": {
"description": "Request has missing or invalid parameters and cannot be parsed.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"401": {
"description": "The request's Authorization header is not formatted correctly or does not contain a valid token.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"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": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"404": {
"description": "The resource specified does not exist.",
"headers": {
"x-amzn-RateLimit-Limit": {
"type": "string",
"description": "Your rate limit (requests per second) for this operation."
},
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"413": {
"description": "The request size exceeded the maximum accepted size.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"415": {
"description": "The request payload is in an unsupported format.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"500": {
"description": "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"headers": {
"x-amzn-RequestId": {
"type": "string",
"description": "Unique request reference identifier."
}
},
"schema": {
"$ref": "#/definitions/ErrorList"
}
}
}
}
}
},
"definitions": {
"ProductsByAsinsRequest": {
"type": "object",
"description": "The request object to use when searching for a list of ASINs.",
"required": ["locale", "productIds", "productRegion"],
"properties": {
"productIds": {
"type": "array",
"description": "Accepts a list of ASINs as input. The response will return product information for each of the ASINs provided. The maximum number of ASINs allowed for each call is 30.",
"items": {"type": "string"}
},
"productRegion": {
"type": "string",
"description": "The region where the customer wants to purchase the product.",
"enum": ["DE", "FR", "UK", "IT", "ES", "IN", "US", "CA", "MX", "JP", "AU"]
},
"locale": {
"type": "string",
"description": "The locale of the request in the form of an IETF language tag. This value should comply with java.util.Locale.",
"pattern": "^[a-zA-Z_-]+$"
},
"shippingRegion": {
"type": "string",
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode."
},
"shippingPostalCode": {
"type": "string",
"description": "The shipping postal or zip code for customer's request. This parameter doesn't support geocode."
},
"quantity": {
"type": "integer",
"description": "The number of units the customer intends to purchase."
},
"facets": {
"type": "array",
"description": "A list of data facets to include in the response.",
"items": {
"type": "string",
"enum": ["OFFERS", "IMAGES"]
}
}
}
},
"ProductsByAsinsResponse": {
"type": "object",
"description": "The data that describes the results for the list of ASIN search.",
"required": ["matchingProductCount", "products", "notFoundAsins"],
"properties": {
"matchingProductCount": {
"type": "integer",
"description": "The number of products that matches the search query."
},
"products": {
"type": "array",
"description": "A list of products that matches the search criteria.",
"items": {"$ref": "#/definitions/ProductsResult"}
},
"notFoundAsins": {
"type": "array",
"description": "A list of ASINs for which no product was found.",
"items": {"type": "string"}
}
}
},
"SearchProductsResult": {
"type": "object",
"description": "The data that describes the results of the search query.",
"required": ["matchingProductCount", "numberOfPages", "products"],
"properties": {
"matchingProductCount": {
"type": "integer",
"description": "The number of products that matches the search query."
},
"numberOfPages": {
"type": "integer",
"description": "The number of pages of results."
},
"legalInformation": {
"type": "array",
"description": "Common structure to display legal information.",
"items": {"$ref": "#/definitions/Fragment"}
},
"products": {
"type": "array",
"description": "A list of products that matches the search criteria.",
"items": {"$ref": "#/definitions/ProductsResult"}
},
"refinements": {
"$ref": "#/definitions/RefinementResult",
"description": "Search refinements available for the search result."
},
"searchRefinements": {
"type": "array",
"description": "Search refinements used to narrow down results.",
"items": {"$ref": "#/definitions/SearchRefinementResult"}
}
}
},
"OffersResult": {
"type": "object",
"description": "The data that describes the results of the offer query.",
"properties": {
"offerCount": {
"type": "integer",
"description": "The number of offers for the ASIN after filters are applied."
},
"numberOfPages": {
"type": "integer",
"description": "The number of pages of results."
},
"featuredOffer": {
"description": "A featured offer selected based on eligibility requirements and criteria.",
"$ref": "#/definitions/Offer"
},
"offers": {
"type": "array",
"description": "A list of offers in a page.",
"items": {"$ref": "#/definitions/Offer"}
},
"filterGroups": {
"type": "array",
"description": "A list of filter groups.",
"items": {"$ref": "#/definitions/OfferFilterGroup"}
}
}
},
"ProductsResult": {
"type": "object",
"description": "The result of a request for product data.",
"required": ["asin", "asinType", "signedProductId", "title", "url"],
"properties": {
"asin": {
"type": "string",
"description": "The Amazon Business ASIN product identifier."
},
"asinType": {
"type": "string",
"description": "The type of ASIN returned in the request.\n\n**Possible values:**\n- `STANDARD` : A standard, standalone product.\n- `VARIATION_PARENT` : A parent ASIN that groups variation children.\n- `VARIATION_CHILD` : A child ASIN that belongs to a variation parent.",
"enum": ["STANDARD", "VARIATION_PARENT", "VARIATION_CHILD"],
"x-docgen-enum-table-extension": [
{"value": "STANDARD", "description": "A standard, standalone product."},
{"value": "VARIATION_PARENT", "description": "A parent ASIN that groups variation children."},
{"value": "VARIATION_CHILD", "description": "A child ASIN that belongs to a variation parent."}
]
},
"signedProductId": {
"type": "string",
"description": "Product id signed with information about the request for which it was returned."
},
"legalInformation": {
"type": "array",
"description": "Common structure to display legal information.",
"items": {"$ref": "#/definitions/Fragment"}
},
"includedDataTypes": {
"type": "object",
"description": "A list of additional data groups, as specified in the request.",
"additionalProperties": {"type": "array", "items": {"type": "object"}}
},
"features": {
"type": "array",
"description": "A list of descriptive features of the product, typically shown as a bulleted list.",
"items": {"type": "string"}
},
"editorialReviews": {
"type": "array",
"description": "A list of editorial reviews for the product.",
"items": {"$ref": "#/definitions/EditorialReview"}
},
"taxonomies": {
"type": "array",
"description": "A list of taxonomy classifications for the product.",
"items": {"$ref": "#/definitions/Taxonomy"}
},
"packageTypeNames": {
"type": "array",
"description": "A list of package type names.",
"items": {"$ref": "#/definitions/PackageTypeName"}
},
"title": {
"type": "string",
"description": "The title of the product shown at the top of an Amazon Business product page."
},
"url": {
"type": "string",
"description": "A URL to the product on the Amazon Business website."
},
"format": {
"type": "string",
"description": "The type of product on the Amazon Business website. For books, this is the binding."
},
"bookInformation": {
"description": "If applicable, book-specific details for the product.",
"$ref": "#/definitions/BookInformation"
},
"byLine": {
"type": "array",
"description": "A product's by-line contributor information such as brand, author, and editor.",
"items": {"$ref": "#/definitions/Contributor"}
},
"mediaInformation": {
"description": "If applicable, media type information for the product.",
"$ref": "#/definitions/MediaInformation"
},
"productOverview": {
"type": "object",
"description": "The general descriptive fields for the product.",
"additionalProperties": {"type": "string"}
},
"productDetails": {
"type": "object",
"description": "The nested key or value pairs indicating additional information for product parts.",
"additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}
},
"productVariations": {
"description": "The variations (child products) for this product.",
"$ref": "#/definitions/ProductVariations"
},
"customerReviewsSummary": {
"description": "The information on the product's rating count and star rating.",
"$ref": "#/definitions/CustomerReviewsSummary"
},
"productDescription": {
"type": "string",
"description": "The description for the given product."
},
"upcValues": {
"type": "array",
"description": "A list of 12-digit Universal Product Codes (UPC).",
"items": {"type": "string"}
},
"eanValues": {
"type": "array",
"description": "A list of 13-digit European Article Numbers (EAN).",
"items": {"type": "string"}
},
"modelNumber": {
"type": "string",
"description": "The model number of the product."
},
"manufacturerName": {
"type": "string",
"description": "The manufacturer name of the product."
},
"bundleQuantity": {
"type": "integer",
"format": "int64",
"description": "The number of items in a bundled unit."
},
"isCustomQuoteEligible": {
"type": "boolean",
"description": "A boolean that describes whether the product is available for pre-purchase quoting."
},
"badges": {
"type": "array",
"description": "Collection of applicable badges for the ASIN.",
"items": {"$ref": "#/definitions/Badge"}
},
"isBundledAsin": {
"type": "boolean",
"description": "A boolean that describes whether the product is a bundled ASIN or not."
}
}
},
"Offer": {
"type": "object",
"description": "An offer for a product being sold by a merchant.",
"required": ["availability", "buyingGuidance", "buyingRestrictions", "fulfillmentType", "merchant", "offerId", "price", "productCondition", "condition", "quantityLimits", "shippingOptions", "badges"],
"properties": {
"availability": {
"type": "string",
"description": "Displays the available dates to ship the product after purchased."
},
"buyingGuidance": {
"type": "string",
"description": "Guided buying policy value.\n\n**Possible values:**\n- `PREFERRED` : The product is preferred by the organization.\n- `RESTRICTED` : The product is restricted by the organization.\n- `BLOCKED` : The product is blocked by the organization.\n- `NONE` : No buying guidance policy applies.\n- `NEGOTIATED` : The product has a negotiated price.\n- `UNKNOWN` : The buying guidance status is unknown.",
"enum": ["PREFERRED", "RESTRICTED", "BLOCKED", "NONE", "NEGOTIATED", "UNKNOWN"],
"x-docgen-enum-table-extension": [
{"value": "PREFERRED", "description": "The product is preferred by the organization."},
{"value": "RESTRICTED", "description": "The product is restricted by the organization."},
{"value": "BLOCKED", "description": "The product is blocked by the organization."},
{"value": "NONE", "description": "No buying guidance policy applies."},
{"value": "NEGOTIATED", "description": "The product has a negotiated price."},
{"value": "UNKNOWN", "description": "The buying guidance status is unknown."}
]
},
"buyingGuidanceV2": {
"type": "object",
"description": "Fragment-based guided buying policy.",
"properties": {
"buyingGuidance": {
"type": "array",
"description": "Collection of applicable buying guidance policies.",
"items": {"$ref": "#/definitions/Fragment"}
}
}
},
"buyingRestrictions": {
"type": "array",
"description": "When present, entries describe the reasons a buyer is restricted from buying.",
"items": {"$ref": "#/definitions/BuyingRestriction"}
},
"fulfillmentType": {
"type": "string",
"description": "The fulfillment system to use for the purchased product.",
"enum": ["AMAZON_FULFILLMENT", "MERCHANT_FULFILLMENT", "OTHER"],
"x-docgen-enum-table-extension": [
{"value": "AMAZON_FULFILLMENT", "description": "Fulfilled by Amazon."},
{"value": "MERCHANT_FULFILLMENT", "description": "Fulfilled by the merchant."},
{"value": "OTHER", "description": "Other fulfillment type."}
]
},
"merchant": {
"$ref": "#/definitions/Merchant"
},
"fulfiller": {
"$ref": "#/definitions/Fulfiller"
},
"offerId": {
"type": "string",
"description": "The Amazon Business offer identifier to use when purchasing a product."
},
"price": {
"$ref": "#/definitions/Price"
},
"shippingOptions": {
"type": "array",
"description": "The options for shipping a product offer.",
"items": {"$ref": "#/definitions/ShippingOption"}
},
"badges": {
"type": "array",
"description": "The types of badges available for a product offer.",
"items": {"$ref": "#/definitions/Badge"}
},
"quantityInStock": {
"type": "integer",
"format": "int64",
"description": "The number of items in stock for a product offer."
},
"listPrice": {
"$ref": "#/definitions/Price"
},
"productCondition": {
"type": "string",
"description": "The possible condition of the product being sold by the merchant.",
"enum": ["NEW", "USED", "COLLECTIBLE", "REFURBISHED", "OTHER", "UNKNOWN"]
},
"productConditionNote": {
"type": "string",
"description": "Additional details on the product's condition."
},
"condition": {
"$ref": "#/definitions/Condition"
},
"quantityLimits": {
"$ref": "#/definitions/OfferQuantityLimits"
},
"quantityPrice": {
"$ref": "#/definitions/QuantityPrice"
},
"taxExclusivePrice": {
"$ref": "#/definitions/TaxExclusivePrice"
},
"deliveryInformation": {
"type": "string",
"description": "Information regarding the estimated delivery time and delivery price."
}
}
},
"Merchant": {
"type": "object",
"description": "Information about the merchant selling the product.",
"required": ["merchantId", "name", "meanFeedbackRating", "totalFeedbackCount"],
"properties": {
"merchantId": {
"type": "string",
"description": "The unique id of the merchant."
},
"name": {
"type": "string",
"description": "The displayable name of the merchant."
},
"meanFeedbackRating": {
"type": "number",
"format": "double",
"description": "The mean of the total ratings given to the merchant."
},
"totalFeedbackCount": {
"type": "integer",
"description": "The total number of reviews for the merchant."
},
"certificates": {
"type": "array",
"description": "List of merchant-owned certifications.",
"items": {"type": "string"}
}
}
},
"Fulfiller": {
"type": "object",
"description": "Information about the fulfiller of the product.",
"required": ["name", "fulfillmentType"],
"properties": {
"name": {
"type": "string",
"description": "The displayable name of the product fulfiller."
},
"fulfillmentType": {
"type": "string",
"description": "The fulfillment system to use for the purchased product.",
"enum": ["AMAZON_FULFILLMENT", "MERCHANT_FULFILLMENT", "OTHER"]
}
}
},
"Price": {
"type": "object",
"description": "The actual price the customers pay for the product.",
"required": ["value", "formattedPrice", "priceType"],
"properties": {
"value": {
"$ref": "#/definitions/Money"
},
"formattedPrice": {
"type": "string",
"description": "A displayable version of the price and currency code."
},
"priceType": {
"type": "string",
"description": "A description of the type of price."
}
}
},
"Money": {
"type": "object",
"description": "An object that holds the numerical value and the currency code.",
"required": ["amount", "currencyCode"],
"properties": {
"amount": {
"type": "number",
"format": "double",
"description": "The numerical value of the money."
},
"currencyCode": {
"type": "string",
"description": "The currency code for the price amount."
}
}
},
"TaxExclusivePrice": {
"type": "object",
"description": "The price of the product without tax.",
"required": ["displayString", "formattedPrice", "label", "taxExclusiveAmount"],
"properties": {
"taxExclusiveAmount": {
"$ref": "#/definitions/Money"
},
"displayString": {
"type": "string",
"description": "A displayable message about the tax exclusion."
},
"formattedPrice": {
"type": "string",
"description": "A displayable version of the price and currency code."
},
"label": {
"type": "string",
},
"label": {
"description": "A displayable description of the type of tax exclusion.",
"type": "string"
}
},
"type": "object"
},
"EditorialReview": {
"description": "An editorial review for the product.",
"required": [
"content",
"source"
],
"properties": {
"content": {
"description": "The editorial review content.",
"type": "string"
},
"source": {
"description": "The editorial review content source.",
"type": "string"
}
},
"type": "object"
},
"Taxonomy": {
"description": "A taxonomy data entry for the product.",
"required": [
"taxonomyCode",
"title",
"type"
],
"properties": {
"taxonomyCode": {
"description": "The taxonomy code.",
"type": "string"
},
"title": {
"description": "A displayable string with the name of product category.",
"type": "string"
},
"type": {
"description": "The taxonomy types supported by Amazon Business.",
"type": "string",
"enum": [
"UNSPSC",
"ECLASS"
],
"x-docgen-enum-table-extension": [
{
"value": "UNSPSC",
"description": "United Nations Standard Products and Services Code (UNSPSC) taxonomy differs from ECLASS. Products belonging to one category in UNSPSC are in several segments in ECLASS."
},
{
"value": "ECLASS",
"description": "A standard requirement for a number of European customers, especially in Germany. ECLASS combines different product types together."
}
]
}
},
"type": "object"
},
"PackageTypeName": {
"description": "A package type name. For example: One product is a box of 120 water bottles. The package type name would be \"bottle\".",
"required": [
"displayString"
],
"properties": {
"displayString": {
"description": "The package type name. For example: One product is a box of 120 water bottles. The package type name would be \"bottle\".",
"type": "string"
}
},
"type": "object"
},
"ISBN": {
"description": "International Standard Book Number (ISBN) associated with the product.",
"properties": {
"isbn10": {
"description": "A 10-digit ISBN associated with the product.",
"type": "string"
},
"isbn13": {
"description": "A 13-digit ISBN associated with the product.",
"type": "string"
}
},
"type": "object"
},
"BookInformation": {
"description": "Book details (if applicable).",
"properties": {
"isbn": {
"$ref": "#/definitions/ISBN",
"description": "A 10 or 13-digit ISBN associated with the product."
},
"publicationDate": {
"description": "The date the book was published.",
"type": "string",
"format": "date-time"
},
"publishedLanguage": {
"description": "The language used for publishing the book.",
"type": "string"
}
},
"type": "object"
},
"Contributor": {
"description": "A contributor's entry for the product.",
"properties": {
"name": {
"description": "The name of the contributor.",
"type": "string"
},
"roles": {
"description": "The role or roles of the contributor in the context of the product.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"MediaInformation": {
"description": "If applicable, media type information of the product.",
"properties": {
"editions": {
"description": "Available editions of the product.",
"type": "array",
"items": {
"type": "string"
}
},
"mediaFormats": {
"description": "Available formats of the media product.",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"CustomerReviewsSummary": {
"description": "Information on the product's rating count and star rating.",
"required": [
"starRating"
],
"type": "object",
"properties": {
"numberOfRatings": {
"description": "The number of customer ratings for a product.",
"type": "integer"
},
"starRating": {
"description": "The star rating for a product.",
"type": "number",
"format": "double"
}
}
},
"DimensionValue": {
"description": "The value of a dimension and its index. \n exp. {index:0, displayString:red}",
"properties": {
"index": {
"description": "index of the value",
"type": "integer"
},
"displayString": {
"description": "The string of the dimension value in its readable form. \n exp. red, sm, 12-packs",
"type": "string"
}
},
"type": "object"
},
"Dimension": {
"description": "A dimension with its index, categorical name in its readable form, and a list of values. \n exp. [{index:0, displayString:color, dimensionValues: [{index:0, displayString:red}, ...]}, ...]",
"type": "object",
"properties": {
"index": {
"description": "The index of the dimension.",
"type": "integer"
},
"displayString": {
"description": "The categorical name of the dimension in its readable form. \n exp. color, size",
"type": "string"
},
"dimensionValues": {
"type": "array",
"description": "The value of a dimension and its index. \n exp. {index:0, displayString:red}",
"items": {
"$ref": "#/definitions/DimensionValue"
}
}
}
},
"VariationValue": {
"description": "Contains index that maps to a dimension and value maps to a dimensionValue to represent the variation properties for a child product. \n exp. {index:0, value: 0}",
"type": "object",
"properties": {
"index": {
"description": "The index of the dimension.",
"type": "integer"
},
"value": {
"description": "The value that maps to dimensionValue.",
"type": "integer"
}
}
},
"Variation": {
"description": "A child product (variation) that contains its ASIN and a list of variationValues showing its variation properties. \n exp. [ASIN: B07J3G6312: [{index:0, value: 0}, ...]]",
"type": "object",
"properties": {
"asin": {
"description": "The ASIN of the child product. \n exp. B07J3G6312",
"type": "string"
},
"variationValues": {
"type": "array",
"description": "Contains index that maps to a dimension and value maps to a dimensionValue to represent the variation properties for a child product. \n exp. {index:0, value: 0}",
"items": {
"$ref": "#/definitions/VariationValue"
}
}
}
},
"ProductVariations": {
"description": "Variations (Child products) for the products including all of the categorical dimensions and their values. exp. \n Dimensions: [{index:0, displayString:color, dimensionValues: [{index:0, displayString:red}, ...]}, ...], Variations: [ASIN: B07J3G6312: [{index:0, value: 0}, ...]] \n should be interpret as B07J3G6312: [color: red]",
"type": "object",
"required": [
"dimensions",
"variations"
],
"properties": {
"dimensions": {
"description": "A list of dimensions with their index, categorical names in their readable form, and lists of values for these dimensions. \n exp. [{index:0, displayString:color, dimensionValues: [{index:0, displayString:red}, ...]}, ...]",
"type": "array",
"items": {
"$ref": "#/definitions/Dimension"
}
},
"variations": {
"description": "A list of child products (variations) which contain their ASINs and lists of variationValues showing their variation properties. \n exp. [ASIN: B07J3G6312: [{index:0, value: 0}, ...], ...]",
"type": "array",
"items": {
"$ref": "#/definitions/Variation"
}
}
}
},
"ProductsResult": {
"description": "The result of a request for product data.",
"required": [
"asin",
"asinType",
"signedProductId",
"legalInformation",
"includedDataTypes",
"features",
"taxonomies",
"packageTypeNames",
"title",
"url",
"format",
"bookInformation",
"byLine",
"mediaInformation",
"productDescription",
"productOverview",
"productDetails",
"customerReviewsSummary",
"productVariations",
"upcValues",
"eanValues",
"modelNumber",
"manufacturerName",
"blackCurtainKey",
"specialDeliveryRequirements",
"bundleQuantity",
"isCustomQuoteEligible",
"isBundledAsin"
],
"properties": {
"asin": {
"description": "The Amazon Business ASIN product identifier.",
"type": "string"
},
"asinType": {
"description": "The type ASIN returned in the request.",
"$ref": "#/definitions/AsinType"
},
"signedProductId": {
"description": "Product id signed with information about the request for which it was returned.",
"type": "string"
},
"legalInformation": {
"description": "Common structure to display legal Information.",
"type": "array",
"items": {
"$ref": "#/definitions/Fragment"
}
},
"includedDataTypes": {
"additionalProperties": {
"type": "array",
"items": {
"type": "object"
}
},
"description": "A list of additional data groups, as specified in the request. Each facet contains a logic grouping of data about the product.",
"type": "object"
},
"features": {
"description": "A list descriptive features of the product, typically shown as a bulleted list.",
"items": {
"type": "string"
},
"type": "array"
},
"editorialReviews": {
"description": "A list of editorial reviews for the product.",
"items": {
"$ref": "#/definitions/EditorialReview"
},
"type": "array"
},
"taxonomies": {
"description": "A list taxonomy classifications for the product.",
"items": {
"$ref": "#/definitions/Taxonomy"
},
"type": "array"
},
"packageTypeNames": {
"description": "A list of package type names.",
"items": {
"$ref": "#/definitions/PackageTypeName"
},
"type": "array"
},
"title": {
"description": "The title of the product shown at the top of an Amazon Business product page.",
"type": "string"
},
"url": {
"description": "A URL to the product on the Amazon Business website.",
"type": "string"
},
"format": {
"description": "The type of product on the Amazon Business website. For books, this is the binding.",
"type": "string"
},
"bookInformation": {
"description": "If applicable, a book-specific details for the product.",
"$ref": "#/definitions/BookInformation"
},
"byLine": {
"description": "A product's by-line contributor information such as brand, author, and editor.",
"type": "array",
"items": {
"$ref": "#/definitions/Contributor"
}
},
"mediaInformation": {
"description": "If applicable, a media type information for the product.",
"$ref": "#/definitions/MediaInformation"
},
"productOverview": {
"description": "The general descriptive fields for the product.",
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"productDetails": {
"description": "The nested key or value pairs indicating additional information for product parts.",
"additionalProperties": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "object"
},
"productVariations": {
"description": "The variations (Child products) for this products and dimensions for all variations exp. \n {dimensions: {color: {0:red, 1:blue, ...}, size: {0:xs, 1:sm, ...}, ...}, \n variations: {B07J3G6312: [1,0], B07J348978: [0,0], ...}}",
"$ref": "#/definitions/ProductVariations"
},
"customerReviewsSummary": {
"description": "The information on the product's rating count and star rating.",
"$ref": "#/definitions/CustomerReviewsSummary"
},
"productDescription": {
"description": "The description for the given product.",
"type": "string"
},
"upcValues": {
"description": "A list of 12-digit Universal Product Codes (UPC) printed on retail product packaging for easy identification. UPC is used only in the US and Canada.",
"items": {
"type": "string"
},
"type": "array"
},
"eanValues": {
"description": "A list of 13-digit European Article Numbers (EAN) printed on retail product packaging for easy identification. EAN is used globally except in US and Canada.",
"items": {
"type": "string"
},
"type": "array"
},
"modelNumber": {
"description": "The model number of the product. The manufacturer assigns this number for identification and management.",
"type": "string"
},
"manufacturerName": {
"description": "The manufacturer name of the product.",
"type": "string"
},
"blackCurtainKey": {
"description": "The Black Curtain category of a product. A product's Black Curtain Key, if present, indicates a requirement for the customer to acknowledge that they have the qualifications to proceed to view the details of said product.",
"type": "string"
},
"specialDeliveryRequirements": {
"description": "The special delivery requirements of a product.",
"type": "string"
},
"bundleQuantity": {
"description": "The number of items in a bundled unit. Example: A bundled unit of one product contains 120 water bottles. The bundle quantity is 120.",
"type": "integer",
"format": "int64"
},
"isCustomQuoteEligible": {
"description": "A boolean that describes whether the product is available for pre-purchase quoting. It is only included in the response for the searchProducts operation.",
"type": "boolean"
},
"badges": {
"description": "Collection of applicable badges for the ASIN. Badges indicate the product’s membership, status, or other identifiers, such as its sustainability features.",
"type": "array",
"items": {
"$ref": "#/definitions/Badge"
}
},
"isBundledAsin": {
"description": "A boolean that describes whether the product is bundled ASIN or not.",
"type": "boolean"
}
},
"title": "Products Result",
"type": "object"
},
"QuantityPrice": {
"description": "Provides information about the different prices a customer can get for higher quantities.",
"type": "object",
"properties": {
"quantityPriceTiers": {
"description": "A collection of quantity price tier.",
"items": {
"$ref": "#/definitions/QuantityPriceTier"
},
"type": "array"
}
}
},
"QuantityPriceTier": {
"description": "Defines the price for items if the quantity being purchased falls within the quantities specified in quantityDisplay field.",
"required": [
"quantityDisplay",
"unitPrice"
],
"properties": {
"quantityDisplay": {
"description": "A localized string indicating the quantity range for which the price in the tier applies.",
"type": "string"
},
"unitPrice": {
"description": "The price for each unit of item in this quantity tier.",
"$ref": "#/definitions/Money"
},
"minQuantity": {
"description": "[DEPRECATED: Please use unitPrice and quantityDisplay instead] The minimum quantity of items that a customer needs to buy to reach this price tier.",
"format": "int64",
"type": "integer"
},
"price": {
"description": "[DEPRECATED: Please use unitPrice and quantityDisplay instead]",
"$ref": "#/definitions/Price"
},
"savingMessage": {
"description": "[DEPRECATED: Please use unitPrice and quantityDisplay instead] The savings message of the tier. This exists only when the tier's price is lower than the basis price of the current buying option.",
"type": "string"
},
"taxExclusivePrice": {
"description": "[DEPRECATED: Please use unitPrice and quantityDisplay instead]",
"$ref": "#/definitions/TaxExclusivePrice"
}
},
"type": "object"
},
"RefinementResult": {
"description": "The data that describes the refinements used to narrow down results. These values remain the same for all pages in the result.",
"required": [
"categories",
"subCategories",
"availabilityOptions",
"deliveryDayOptions",
"eligibleForFreeShippingOptions",
"primeEligible"
],
"properties": {
"categories": {
"description": "A list of categories that matches the search keyword. A category id is sent in the subsequent request to get a shorter list of relevant search results.",
"items": {
"$ref": "#/definitions/Category"
},
"type": "array"
},
"subCategories": {
"description": "A list of sub categories that matches a given category. A search subcategory Id is sent in the next request to get a shorter list of relevant products.",
"items": {
"$ref": "#/definitions/SubCategory"
},
"type": "array"
},
"availabilityOptions": {
"description": "Two availability ids for 'in stock only' and 'include out of stock' would appear in the search refinement. Availability Id is sent as parameter in the next request to get filtered list of products. The availability filtering returns products whose offers are aligned with the availability ID request.",
"type": "array",
"items": {
"$ref": "#/definitions/Availability"
}
},
"deliveryDayOptions": {
"description": "Two delivery day ids for 'Get It Today' and 'Get It by Tomorrow' would appear in the search refinement.",
"type": "array",
"items": {
"$ref": "#/definitions/DeliveryDay"
}
},
"eligibleForFreeShippingOptions": {
"description": "One eligibleForFreeShippingOption Id would appear in the search refinement. EligibleForFreeShippingOption ID is sent as parameter in the next request to get a more filtered list of products. This filtering returns products with 'Free Shipping by Amazon Business.'",
"type": "array",
"items": {
"$ref": "#/definitions/EligibleForFreeShipping"
}
},
"primeEligible": {
"description": "This can be used as a query parameter to fetch only prime eligible items.",
"type": "array",
"items": {
"$ref": "#/definitions/PrimeEligible"
}
}
},
"title": "Refinement Result",
"type": "object"
},
"SearchFacetType": {
"description": "A list of supported data facets for product search.",
"enum": [
"OFFERS",
"IMAGES"
],
"type": "string"
},
"ProductsByAsinsResponse": {
"description": "The data that describes the results for the list of ASIN search.",
"required": [
"matchingProductCount",
"products",
"notFoundAsins"
],
"properties": {
"matchingProductCount": {
"description": "The number of products that matches the search query. This number can be larger than the number of matching products the customer can view. The value is the same for all the pages in the result.",
"type": "integer"
},
"products": {
"description": "A list of products that matches the search criteria.",
"items": {
"$ref": "#/definitions/ProductsResult"
},
"type": "array"
},
"notFoundAsins": {
"description": "A list of ASIN for which their is no product found.",
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "GetProductsByAsins API Search results",
"type": "object"
},
"GetOffersByOfferIdsResponse": {
"description": "The results of a request to search for offers by offer IDs.",
"required": [
"offers",
"notFoundOfferIds"
],
"properties": {
"offers": {
"description": "A list of offers.",
"items": {
"$ref": "#/definitions/Offer"
},
"type": "array"
},
"notFoundOfferIds": {
"description": "A list of offer IDs for which no offer is found.",
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "GetOffersByOfferIds API Search results",
"type": "object"
},
"ProductsByAsinsRequest": {
"description": "The request object to use when searching for a list of ASINs.",
"type": "object",
"required": [
"locale",
"productIds",
"productRegion"
],
"properties": {
"productIds": {
"description": "Accepts a list of ASINs as input. The response will return product information for each of the ASINs provided. The maximum number of ASINs allowed for each call is 30.",
"type": "array",
"items": {
"type": "string"
}
},
"productRegion": {
"description": "The region where the customer wants to purchase the product.",
"type": "string",
"enum": [
"DE",
"FR",
"UK",
"IT",
"ES",
"IN",
"US",
"CA",
"MX",
"JP",
"AU"
],
"x-docgen-enum-table-extension": [
{
"value": "DE",
"description": "Germany"
},
{
"value": "FR",
"description": "France"
},
{
"value": "UK",
"description": "United Kingdom"
},
{
"value": "IT",
"description": "Italy"
},
{
"value": "ES",
"description": "Spain"
},
{
"value": "IN",
"description": "India"
},
{
"value": "US",
"description": "United States of America"
},
{
"value": "CA",
"description": "Canada"
},
{
"value": "MX",
"description": "Mexico"
},
{
"value": "JP",
"description": "Japan"
},
{
"value": "AU",
"description": "Australia"
}
]
},
"shippingRegion": {
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"type": "string"
},
"locale": {
"description": "The locale of the request in the form of an IETF language tag. Each ProductRegion supports one or more locales. This value should comply with java.util.Locale.",
"type": "string",
"pattern": "^[a-zA-Z_-]+$"
},
"shippingPostalCode": {
"description": "The shipping postal or zip code for customer's request. This parameter doesn't support geocode.",
"type": "string"
},
"quantity": {
"description": "The number of units the customer intends to purchase. This helps Amazon Business determine quantity-based discounts if an eligible offer is present. Defaults to 1.",
"type": "integer"
},
"facets": {
"description": "A list of data facets to include in the response. Separate each facet with a comma.",
"type": "array",
"items": {
"type": "string",
"enum": [
"OFFERS",
"IMAGES"
],
"x-docgen-enum-table-extension": [
{
"value": "OFFERS",
"description": "Offers for an item in the Amazon Business catalog."
},
{
"value": "IMAGES",
"description": "Images for an item in the Amazon Business catalog."
}
]
}
}
}
},
"getOffersByOfferIdsRequest": {
"description": "The request object to use when searching for a list of offers.",
"type": "object",
"required": [
"locale",
"offersByOfferIdsRequest",
"productRegion"
],
"properties": {
"offersByOfferIdsRequest": {
"description": "Accepts a list offer IDs as input. The response will return offer information for each ID provided. The maximum number of IDs allowed for each call is 30.",
"type": "array",
"items": {
"$ref": "#/definitions/OfferByOfferIdRequest"
}
},
"productRegion": {
"description": "The region where the customer wants to purchase the product.",
"type": "string",
"enum": [
"DE",
"FR",
"UK",
"IT",
"ES",
"IN",
"US",
"CA",
"MX",
"JP",
"AU"
],
"x-docgen-enum-table-extension": [
{
"value": "DE",
"description": "Germany"
},
{
"value": "FR",
"description": "France"
},
{
"value": "UK",
"description": "United Kingdom"
},
{
"value": "IT",
"description": "Italy"
},
{
"value": "ES",
"description": "Spain"
},
{
"value": "IN",
"description": "India"
},
{
"value": "US",
"description": "United States of America"
},
{
"value": "CA",
"description": "Canada"
},
{
"value": "MX",
"description": "Mexico"
},
{
"value": "JP",
"description": "Japan"
},
{
"value": "AU",
"description": "Australia"
}
]
},
"shippingRegion": {
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"type": "string"
},
"locale": {
"description": "The locale of the request in the form of an IETF language tag. Each ProductRegion supports one or more locales. This value should comply with java.util.Locale.",
"type": "string",
"pattern": "^[a-zA-Z_-]+$"
},
"shippingPostalCode": {
"description": "The shipping postal or zip code for customer's request. This parameter doesn't support geocode.",
"type": "string"
}
}
},
"SearchProductsResult": {
"description": "The data that describes the results of the search query.",
"required": [
"matchingProductCount",
"numberOfPages",
"legalInformation",
"products",
"refinements",
"searchRefinements"
],
"properties": {
"matchingProductCount": {
"description": "The number of products that matches the search query. This number can be larger than the number of matching products the customer can view. The value is the same for all the pages in the result.",
"type": "integer"
},
"searchRefinements": {
"description": "Search refinements are used to share the refinements available for search result. Use searchRefinements in subsequent request to narrow down the results. For example: Search category is a type of search refinement. If a search category refinement is used in the request, the search result will limit to a given search category.",
"items": {
"$ref": "#/definitions/SearchRefinementResult"
},
"type": "array"
},
"refinements": {
"$ref": "#/definitions/RefinementResult",
"description": "Search refinements is used to share the refinements available for search result. Use searchRefinements in subsequent request to narrow down the results. For example: Search category is a type of search refinement. If a search category refinement is used in the request, the search result will limit to a given search category."
},
"numberOfPages": {
"description": "The number of pages of results.",
"type": "integer"
},
"products": {
"description": "A list of products that matches the search criteria.",
"items": {
"$ref": "#/definitions/ProductsResult"
},
"type": "array"
}
},
"title": "Search products result",
"type": "object"
},
"SearchRefinementResult": {
"description": "Search refinements are used to share the refinements available for search result. Use searchRefinements in subsequent request to narrow down the results. For example: Search category is a type of search refinement. If a search category refinement is used in the request, the search result will limit to a given search category.",
"type": "object",
"required": [
"displayValue",
"refinementValues",
"selectionType"
],
"properties": {
"selectionType": {
"description": "SelectionType is used to identify selection allowed for a given refinement. For example: MultiSelect allows to search with multiple values of a refinement. InsteadSelect allows to search with only a single refinement value.",
"type": "string"
},
"displayValue": {
"description": "Human friendly name of a given refinement type.",
"type": "string"
},
"refinementValues": {
"description": "RefinementValues holds items for a given refinement. For example: If \"Brand\" is a refinement, the refinementValues will have different brands available for a given product.",
"type": "array",
"items": {
"$ref": "#/definitions/RefinementValue"
}
}
}
},
"RefinementValue": {
"description": "RefinementValue holds items for a given refinement. For example: If \"Brand\" is a refinement, the refinementValues will have different brands available for a given product.",
"type": "object",
"required": ["displayName", "searchRefinementValue"],
"properties": {
"displayName": {
"description": "The name of the item in a refinement.",
"type": "string"
},
"searchRefinementValue": {
"description": "The searchRefinementValue is used to make search request for a given refinement.",
"type": "string"
}
},
"title": "RefinementValue"
},
"OfferByOfferIdRequest": {
"description": "The data contains offerId",
"type": "object",
"required": [
"offerId"
],
"properties": {
"offerId": {
"description": "The Amazon Business offer identifier.",
"type": "string"
}
}
},
"SubCategory": {
"description": "The search subcategory provides information on relevant search subcategories for products within a category. Use subcategory to limit the results for a particular search subcategory in subsequent requests.",
"type": "object",
"required": [
"displayName",
"id"
],
"properties": {
"displayName": {
"description": "Display name is used to share more human friendly readable description of sub category.",
"type": "string"
},
"id": {
"description": "Identifies a search subcategory across a product region.",
"type": "string"
}
},
"title": "SubCategory"
},
"Availability": {
"description": "Limits the product offers by 'in stock only' or 'include out of stock'. Use availability to limit the subsequent search requests.",
"type": "object",
"required": ["displayName", "id"],
"properties": {
"displayName": {
"description": "Availability display name would be more user friendly to illustrate the meaning of its id.",
"type": "string"
},
"id": {
"description": "Identifies the availability option for the product. Use the Id to filter ASINs belonging to given availability option.",
"type": "string"
}
},
"title": "Availability"
},
"DeliveryDay": {
"description": "The deliveryDay is used to limit the product offers to be Get It Today or Get It by Tomorrow.",
"type": "object",
"required": ["displayName", "id"],
"properties": {
"displayName": {
"description": "DeliveryDay display name is used to share more human friendly readable description.",
"type": "string"
},
"id": {
"description": "Identifies the product offers with 'Get It Today' or 'Get It by Tomorrow' option.",
"type": "string"
}
},
"title": "DeliveryDay"
},
"EligibleForFreeShipping": {
"description": "The EligibleForFreeShipping is used to limit the product with only 'Free Shipping by Amazon Business.' Use EligibleForFreeShipping to limit the subsequent search requests.",
"type": "object",
"required": ["displayName", "id"],
"properties": {
"displayName": {
"description": "EligibleForFreeShipping display name is used to share more human friendly readable description.",
"type": "string"
},
"id": {
"description": "Identifies the search with only 'Free Shipping by Amazon Business.'",
"type": "string"
}
},
"title": "EligibleForFreeShipping"
},
"PrimeEligible": {
"description": "The prime eligible refinement is used to give information about relevant prime eligible products.",
"type": "object",
"required": ["displayName", "id"],
"properties": {
"displayName": {
"description": "The prime eligible refinement is used to give information about relevant prime eligible products.",
"type": "string"
},
"id": {
"description": "Identifies a prime eligible option.",
"type": "string"
}
},
"title": "PrimeEligible"
},
"Region" : {
"description": "A region where a product can be purchased.",
"enum": [
"DE",
"FR",
"UK",
"IT",
"ES",
"IN",
"US",
"CA",
"MX",
"JP",
"AU"
],
"type": "string"
},
"OffersResult": {
"description": "The data that describes the results of the offer query.",
"type": "object",
"properties": {
"offerCount": {
"description": "The number of offers for the ASIN after filters are applied.",
"type": "integer"
},
"numberOfPages": {
"description": "The number of pages of results.",
"type": "integer"
},
"legalInformation": {
"description": "Common structure to display legal Information.",
"type": "array",
"items": {
"$ref": "#/definitions/Fragment"
}
},
"featuredOffer": {
"description": "A featured offer that is selected based on eligibility requirements and criteria.",
"$ref": "#/definitions/Offer",
"type": "object"
},
"offers": {
"description": "A list of offers in a page.",
"items": {
"$ref": "#/definitions/Offer"
},
"type": "array"
},
"filterGroups": {
"description": "A list of filter groups.",
"items": {
"$ref": "#/definitions/OfferFilterGroup"
},
"type": "array"
}
}
},
"OfferFilterGroup": {
"description": "A grouping of related filters.",
"type": "object",
"properties": {
"displayName": {
"description": "Displayable and localized filter group description.",
"type": "string"
},
"filters": {
"description": "A list of filters for the group.",
"items": {
"$ref": "#/definitions/OfferFilter"
},
"type": "array"
}
}
},
"OfferFilter": {
"description": "A filter to apply when getting offers for a product.",
"type": "object",
"properties": {
"id" : {
"description": "Filter identifier. Pass on filterIds request parameter to apply this filter on the search request.",
"type": "string"
},
"displayName" : {
"description": "Displayable and localized filter description.",
"type": "string"
}
}
}
Updated about 1 month ago
Did this page help you?