Product Search API v1 model
{
"swagger": "2.0",
"info": {
"description": "An API for getting data about products available to Amazon Business customers. This includes information such as the product title, the merchant selling the product, and the current price.",
"license": {
"name": "Amazon Software License",
"url": "https://aws.amazon.com/asl/"
},
"title": "Amazon Business API for Products",
"version": "2020-08-26"
},
"externalDocs": {
"description": "Learn more about Amazon Business",
"url": "https://business.amazon.com"
},
"host": "api.business.amazon.com",
"schemes": [
"https"
],
"paths": {
"/products/2020-08-26/products": {
"get": {
"produces": [
"application/json"
],
"parameters": [
{
"description": "A list of keywords to use for finding products based on indexed data.",
"in": "query",
"name": "keywords",
"required": false,
"type": "string"
},
{
"description": "The region where the customer wants to purchase the product.",
"enum": [
"DE",
"FR",
"UK",
"IT",
"ES",
"US",
"CA",
"JP"
],
"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": "JP",
"description": "Japan"
}
],
"in": "query",
"name": "productRegion",
"required": true,
"type": "string"
},
{
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"in": "query",
"name": "shippingRegion",
"required": false,
"type": "string"
},
{
"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.",
"pattern": "^[a-zA-Z_-]+$",
"in": "query",
"name": "locale",
"required": true,
"type": "string"
},
{
"description": "The shipping postal or zip code for customer's request. This parameter doesn't hold geocode.",
"in": "query",
"name": "shippingPostalCode",
"required": false,
"type": "string"
},
{
"collectionFormat": "csv",
"description": "A list of data facets to include in the response. Separate each facet with a comma.",
"in": "query",
"enum": [
"OFFERS",
"IMAGES"
],
"name": "facets",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?facets=FOO,BAR"
},
{
"description": "The zero-based number of the page being requested. If not specified, a default value of 0 will be used. When passed, the value must be equal or greater than zero, and less than the number of pages returned in the response. The maximum number of pages that can be fetched is 13.",
"in": "query",
"name": "pageNumber",
"required": false,
"type": "integer"
},
{
"description": "The requested number of products per page (default 24). Max 24 without privilege.",
"in": "query",
"name": "pageSize",
"required": false,
"type": "integer"
},
{
"description": "A value that identifies the group within the business account that a customer belongs to. The customer can set this in Amazon Business account information. GroupTag is necessary only if the account associated with x-amz-user-email belongs to more than one group.",
"in": "query",
"name": "groupTag",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned result to this specified category. Categories can be found under refinements->categories->id of this API call's response. Sample categories: 'Electronics', 'Appliances', or 'Baby'",
"in": "query",
"name": "category",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned result to this specified subcategory ID. Subcategory IDs can be found under refinements->subcategories->id of this API call's response when a category or subcategory is specified. Note: there can be multiple levels of subcategories in a category. Sample subcategory IDs: '4997' or '4799'",
"in": "query",
"name": "subCategory",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned results to one of the following specified availability IDs: \n2661600011 (In Stock only) \n2661601011 (Include Out of Stock)",
"in": "query",
"name": "availability",
"required": false,
"type": "string"
},
{
"description": "The deliveryDay feature is used to refine the keyword search results. By default, the search returns results with all the available delivery dates. In the returned result refinement, there should be one 'Get It Today' ID, and one 'Get It Tomorrow' ID. If the customer sets the deliveryDay with 'Get It Today' ID, the results will return products that could arrive today or zero matching if no product could arrive today. If the customer sets the deliveryDay with 'Get It Tomorrow' ID, the results will return products that could arrive tomorrow or zero matching if no product could arrive tomorrow.",
"in": "query",
"name": "deliveryDay",
"required": false,
"type": "string"
},
{
"description": "The eligibleForFreeShipping is used to refine the keyword search results. By default, the search should return results with both 'Free Shipping' and not 'Free Shipping by Amazon Business.' In the returned result refinement, there should be one eligibleForFreeShipping Id. It represents 'Free Shipping by Amazon Business.' If the customer sets the eligibleForFreeShipping as this ID, the result will only return products with 'Free Shipping by Amazon Business.'",
"in": "query",
"name": "eligibleForFreeShipping",
"required": false,
"type": "string"
},
{
"description": "The prime eligible refinement is used to filter prime eligible products. By default, the search returns results with prime eligible and non-prime eligible products.",
"in": "query",
"name": "primeEligible",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned result to this specified Universal Product Code (UPC). UPC is printed on product packaging.",
"in": "query",
"name": "upc",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned results to this specified ISBN (International Standard Book Number). ISBN is a 13-digit number that uniquely identifies a book.",
"in": "query",
"name": "isbn",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned results to this specified Stock Keeping Unit (SKU). SKU is a merchant-specific identifier.",
"in": "query",
"name": "sku",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned results to this specified EAN (European Article Number). EAN is a 13-digit product identifier.",
"in": "query",
"name": "ean",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned results to this specified part number. Part number is a unique number issued by manufacturers to identify individual products.",
"in": "query",
"name": "partNumber",
"required": false,
"type": "string"
},
{
"description": "This field restricts the returned results to this specified OEM (Original Equipment Manufacturer) part number. OEM part number is an identifier that indicates the original manufacturer of the part of the product.",
"in": "query",
"name": "oemPartNumber",
"required": false,
"type": "string"
},
{
"collectionFormat": "csv",
"description": "A list of search refinements to refine keyword search for relevant results. Separate each refinement with a comma.",
"in": "query",
"name": "searchRefinements",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "brandtextbin#GE,brandtextbin#Sony,review-rating#2661618011"
},
{
"collectionFormat": "csv",
"description": "A list of filters to filter the results for a product by certain values in the response fields. Input the field name, followed by # and the filter value. Separate filters by commas. Use of filters may result in fewer products returned than expected. The filter is currently only implemented for isCustomQuoteEligible.",
"in": "query",
"name": "productFilters",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "isCustomQuoteEligible#true,bundleQuantity#10"
},
{
"description": "The email address of the customer requesting this resource.",
"in": "header",
"name": "x-amz-user-email",
"required": true,
"type": "string"
},
{
"collectionFormat": "csv",
"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.",
"enum": [
"ALL",
"bookInformation",
"byLine",
"customerReviewsSummary",
"editorialReviews",
"features",
"format",
"mediaInformation",
"productDescription",
"productDetails",
"productOverview",
"productVariations",
"taxonomies",
"packageTypeNames",
"title",
"upcValues",
"eanValues",
"modelNumber",
"manufacturerName",
"bundleQuantity",
"isCustomQuoteEligible",
"badges"
],
"in": "query",
"name": "inclusionsForProducts",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?inclusionsForProducts=FOO,BAR"
},
{
"collectionFormat": "csv",
"description": "A list specifying the offer fields for inclusion in the response object. Excluding this parameter results in response returning all inclusions.",
"enum": [
"ALL",
"availability",
"buyingGuidance",
"buyingGuidanceV2",
"buyingRestrictions",
"condition",
"fulfillmentType",
"merchant",
"merchantCertificates",
"price",
"productCondition",
"productConditionNote",
"quantityLimits",
"quantityPrice",
"taxExclusivePrice",
"deliveryInformation",
"listPrice",
"shippingOptions",
"quantityInStock",
"badges",
"fulfiller"
],
"in": "query",
"name": "inclusionsForOffers",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?inclusionsForOffers=FOO,BAR"
}
],
"responses": {
"200": {
"description": "Search success",
"schema": {
"$ref": "#/definitions/SearchProductsResult"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
},
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"productRegion": {
"value": "US"
},
"locale": {
"value": "en_US"
},
"facets": {
"value": [
"OFFERS"
]
},
"keywords": {
"value": "keyword"
}
}
},
"response": {
"matchingProductCount": 4,
"searchRefinements": [
{
"selectionType": null,
"displayValue": "Department",
"refinementValues": [
{
"displayName": "Electronics",
"searchRefinementValue": "search-alias#electronics"
},
{
"displayName": "Automotive Parts & Accessories",
"searchRefinementValue": "search-alias#automotive"
},
{
"displayName": "Home & Kitchen",
"searchRefinementValue": "search-alias#garden"
},
{
"displayName": "Sports & Outdoors",
"searchRefinementValue": "search-alias#sporting"
},
{
"displayName": "Industrial & Scientific",
"searchRefinementValue": "search-alias#industrial"
},
{
"displayName": "Toys & Games",
"searchRefinementValue": "search-alias#toys-and-games"
},
{
"displayName": "Tools & Home Improvement",
"searchRefinementValue": "search-alias#tools"
},
{
"displayName": "Everything Else",
"searchRefinementValue": "search-alias#misc"
},
{
"displayName": "Office Products",
"searchRefinementValue": "search-alias#office-products"
},
{
"displayName": "Health, Household & Baby Care",
"searchRefinementValue": "search-alias#hpc"
},
{
"displayName": "Beauty & Personal Care",
"searchRefinementValue": "search-alias#beauty"
},
{
"displayName": "Cell Phones & Accessories",
"searchRefinementValue": "search-alias#mobile"
},
{
"displayName": "Baby",
"searchRefinementValue": "search-alias#baby-products"
},
{
"displayName": "Garden & Outdoor",
"searchRefinementValue": "search-alias#lawngarden"
},
{
"displayName": "Arts, Crafts & Sewing",
"searchRefinementValue": "search-alias#arts-crafts"
},
{
"displayName": "Pet Supplies",
"searchRefinementValue": "search-alias#pets"
},
{
"displayName": "Grocery & Gourmet Food",
"searchRefinementValue": "search-alias#grocery"
},
{
"displayName": "Video Games",
"searchRefinementValue": "search-alias#videogames"
},
{
"displayName": "Appliances",
"searchRefinementValue": "search-alias#appliances"
},
{
"displayName": "Handmade",
"searchRefinementValue": "search-alias#handmade"
},
{
"displayName": "Musical Instruments",
"searchRefinementValue": "search-alias#mi"
},
{
"displayName": "Books",
"searchRefinementValue": "search-alias#stripbooks"
},
{
"displayName": "Gift Cards",
"searchRefinementValue": "search-alias#gift-cards"
},
{
"displayName": "Kindle Store",
"searchRefinementValue": "search-alias#digital-text"
},
{
"displayName": "Apps & Games",
"searchRefinementValue": "search-alias#mobile-apps"
},
{
"displayName": "Collectibles & Fine Art",
"searchRefinementValue": "search-alias#collectibles"
},
{
"displayName": "Home & Business Services",
"searchRefinementValue": "search-alias#local-services"
}
]
},
{
"selectionType": "MultiSelectOR",
"displayValue": "Company policies",
"refinementValues": []
},
{
"selectionType": "InsteadSelect",
"displayValue": "Delivery Day",
"refinementValues": [
{
"displayName": "1",
"searchRefinementValue": "delivery_day#1"
}
]
},
{
"selectionType": null,
"displayValue": "Availability",
"refinementValues": [
{
"displayName": "0",
"searchRefinementValue": "availability#0"
},
{
"displayName": "1",
"searchRefinementValue": "availability#1"
},
{
"displayName": "2",
"searchRefinementValue": "availability#2"
}
]
},
{
"selectionType": "MultiSelectOR",
"displayValue": "Prime Campus",
"refinementValues": []
},
{
"selectionType": "MultiSelectOR",
"displayValue": "Prime Free Same-Day",
"refinementValues": []
},
{
"selectionType": "MultiSelectOR",
"displayValue": "Prime One-Day",
"refinementValues": []
},
{
"selectionType": null,
"displayValue": "Prime Delivery",
"refinementValues": []
},
{
"selectionType": null,
"displayValue": "dds_huffman",
"refinementValues": []
}
],
"refinements": {
"categories": [
{
"displayName": "Electronics",
"id": "ELECTRONICS"
},
{
"displayName": "Automotive Parts & Accessories",
"id": "AUTOMOTIVE"
},
{
"displayName": "Home & Kitchen",
"id": "HOME_AND_KITCHEN"
},
{
"displayName": "Sports & Outdoors",
"id": "SPORTS_AND_OUTDOORS"
},
{
"displayName": "Industrial & Scientific",
"id": "INDUSTRIAL"
},
{
"displayName": "Toys & Games",
"id": "TOYS_AND_GAMES"
},
{
"displayName": "Tools & Home Improvement",
"id": "TOOLS_AND_HOME_IMPROVEMENT"
},
{
"displayName": "Everything Else",
"id": "EVERYTHING_ELSE"
},
{
"displayName": "Office Products",
"id": "OFFICE_PRODUCTS"
},
{
"displayName": "Health, Household & Baby Care",
"id": "HEALTH_PERSONAL_CARE"
},
{
"displayName": "Beauty & Personal Care",
"id": "BEAUTY"
},
{
"displayName": "Cell Phones & Accessories",
"id": "MOBILE_AND_ACCESSORIES"
},
{
"displayName": "Baby",
"id": "BABY"
},
{
"displayName": "Garden & Outdoor",
"id": "GARDEN_AND_OUTDOOR"
},
{
"displayName": "Arts, Crafts & Sewing",
"id": "ARTS_AND_CRAFTS"
},
{
"displayName": "Pet Supplies",
"id": "PET_SUPPLIES"
},
{
"displayName": "Grocery & Gourmet Food",
"id": "GROCERY_AND_GOURMET_FOOD"
},
{
"displayName": "Video Games",
"id": "VIDEO_GAMES"
},
{
"displayName": "Appliances",
"id": "APPLIANCES"
},
{
"displayName": "Handmade",
"id": "HANDMADE"
},
{
"displayName": "Musical Instruments",
"id": "MUSICAL_INSTRUMENTS"
},
{
"displayName": "Books",
"id": "BOOKS"
},
{
"displayName": "Gift Cards",
"id": "GIFT_CARDS"
},
{
"displayName": "Kindle Store",
"id": "KINDLE_STORE"
},
{
"displayName": "Apps & Games",
"id": "MOBILE_APPS"
},
{
"displayName": "Collectibles & Fine Art",
"id": "COLLECTIBLES"
},
{
"displayName": "Home & Business Services",
"id": "LOCAL_SERVICES"
}
],
"subCategories": [],
"availabilityOptions": [
{
"displayName": "0",
"id": "0"
},
{
"displayName": "1",
"id": "1"
},
{
"displayName": "2",
"id": "2"
}
],
"deliveryDayOptions": [
{
"displayName": "1",
"id": "1"
}
],
"eligibleForFreeShippingOptions": [],
"primeEligible": []
},
"numberOfPages": 1,
"products": [
{
"asin": "0199393214",
"asinType": "STANDARD",
"signedProductId": "amzn1.business.asin.LCYX26RZZ5DEIUZAEEWWI2LRMFZG423ZORUGOZLEG5ZGMY3BONQ7DTTPFW2DX2PWNIPNCL3MKH2RQUEWHZOWTBSOGZUCUGMZUNEN7CUISPOEBIAP54U56K6I2XTVFLTXI5WSECCPTUR3MK2XMPS7PFO7GQS24X5RFM6DQCOYIYXANRRB6YDA",
"includedDataTypes": {
"OFFERS": [
{}
]
},
"features": [],
"editorialReviews": [],
"taxonomies": [
{
"taxonomyCode": "55101500",
"title": "Printed publications",
"type": "UNSPSC"
}
],
"title": "Keywords: A Vocabulary of Culture and Society",
"url": "https://www.amazon.com/dp/0199393214?ref_=ab_psdp",
"format": null,
"bookInformation": {
"isbn": {
"isbn10": null,
"isbn13": null
},
"publicationDate": null,
"publishedLanguage": null
},
"byLine": [],
"mediaInformation": {
"editions": [],
"mediaFormats": []
},
"productOverview": {},
"productDetails": {},
"productVariations": {
"dimensions": [],
"variations": []
},
"customerReviewsSummary": {
"numberOfRatings": null,
"starRating": null
},
"productDescription": "First published in 1976, Raymond Williams' highly acclaimed Keywords: A Vocabulary of Culture and Society is a collection of lively essays on words that are critical to understanding the modern world. In these essays, Williams, a renowned cultural critic, demonstrates how these key words take on new meanings and how these changes reflect the political bent and values of our past and current society. He chose words both essential and intangible--words like nature, underprivileged, industry, liberal, violence, to name a few--and, by tracing their etymology and evolution, grounds them in a wider political and cultural framework. The result is an illuminating account of the central vocabulary of ideological debate in English in the modern period. \n\nThis edition features a new original foreword by Colin MacCabe, Distinguished Professor of English and Literature, University of Pittsburgh, that reflects on the significance of Williams' life and work. Keywords remains as relevant today as it was over thirty years ago, offering a provocative study of our language and an insightful look at the society in which we live.",
"upcValues": [],
"eanValues": [],
"badges": [
{
"name": null,
"fragment": {
"title": "#1 Best Seller",
"message": null,
"link": {
"text": "Office Products",
"url": "https://www.amazon.com/gp/bestsellers/office-products"
},
"type": "BESTSELLER_BADGE",
"fragments": null
}
}
]
},
{
"asin": "B0BVLCJHX8",
"asinType": "STANDARD",
"signedProductId": "amzn1.business.asin.A7MUCIMZWX4FJWCTPMAWI2LRMFZG423ZORUGOZLEG5ZGMY3BONQRAEIX32JOPPN7ZCMS2BW7ZHXPXV5ZYEN6HIS6GOCKSGFHZ7QJMDLU7BV6M6LWC5MOG7O7V6DFDPFIEEKGCVFWY6DQIBJZVCGZOADRVVMOMUMS37QKIQRD6WVJYCR7BQVQ",
"includedDataTypes": {
"OFFERS": [
{}
]
},
"features": [
"[2023 Upgraded Game Console Adapter] AIMVICE adopts the most advanced keyboard and mouse adapter technology. This keyboard and mouse adapter supports shortcut keys to customize key mapping and adjust sensitivity, and supports one-to-many key mapping. Ideal for game consoles like FPS, TPS and RTS, etc.",
"[Plug and Play] The product is functionally compatible and supports most keyboards, mice, third-party wired games. No need to download additional software. There is a keyboard mark on the converter, which corresponds to the connection. The converter needs to be connected to the game console and the controller at the same time to work.",
"[Multi-Platform Compatibility] AIMVICE keyboard and mouse adapter is compatible with Xbox360, Xbox One, Xbox Series X/S, PlayStation 3, PlayStation 4, Nintendo Switch and other platforms. If you are buying BLADER to play on PS5, we do not recommend buying it.",
"[Game Experience Like PC] Keyboard mouse adapter allows you to experience the perspective of network gaming mouse and keyboard control, low latency, easy to use, fast and flexible connection to wired game console adapter. The appearance of the product is novel and beautiful, and the size is convenient to place.",
"[Must Read Before Use] 1. Set the game sensitivity to the highest for best game control. 2. The mouse that needs to install the driver to use it is not supported. 3. New packaging changed the brand name to AIMZENIX 4. We provide a 365-day support, repair or replacement warranty, if you have any questions about the item, please feel free to contact us."
],
"editorialReviews": [],
"taxonomies": [
{
"taxonomyCode": "43210000",
"title": "Computer Equipment and Accessories",
"type": "UNSPSC"
}
],
"title": "Keyword and Mouse Adapter for Nintendo Switch/Xbox One/PS4/PS3, AIMVICE Keyboard Adapter & Xbox Keyboard Adapter, Perfect for Games Consoles for FPS, TPS and RTS [2023 Upgrade Version]",
"url": "https://www.amazon.com/dp/B0BVLCJHX8?ref_=ab_psdp",
"format": null,
"bookInformation": {
"isbn": {
"isbn10": null,
"isbn13": null
},
"publicationDate": null,
"publishedLanguage": null
},
"byLine": [],
"mediaInformation": {
"editions": [],
"mediaFormats": []
},
"productOverview": {
"": "",
"Date First Available": "February 13, 2023",
"Nominal Power": "",
"Compatible Devices": "PlayStation4, PlayStation3, XBOX ONE, XBOX Series S/X, Nintendo Switch, PC",
"Unit Count": "1.0 Count",
"Specific Uses For Product": "Video Game Console",
"ASIN": "B0BVLCJHX8",
"Product Dimensions": "4.53 x 4.53 x 0.94 inches; 2.4 Ounces",
"Item Package Quantity": "1",
"Warranty Type": "Limited",
"Number of Ports": "4",
"Manufacturer": "AIMVICETEK",
"Connector Type": "",
"Power Plug Type": "No Plug",
"Cable Length": "",
"UNSPSC Code": "",
"Number of Items": "",
"Finish Type": "",
"Color": "Black",
"Item model number": "BLADER",
"Current Rating": "",
"Input Voltage": "4 Volts",
"Brand": "AIMVICETEK",
"null": "",
"Item Dimensions LxWxH": "4.53 x 4.53 x 0.94 inches",
"Country of Origin": "",
"Item Weight": "0.07 Kilograms"
},
"productDetails": {},
"productVariations": {
"dimensions": [],
"variations": []
},
"customerReviewsSummary": {
"numberOfRatings": null,
"starRating": null
},
"productDescription": "1. Are you still use the game joystick play the console games, and you are always missing the beat while you operate the game joystick without accurate. 2. Now, the BLADER Keyboard & Mouse Converter allows you use the keyboard & mouse play console games with high accurate and rapid fire trigger. 3. It compatible with XBOX S/X/XBOX Series X/S, PS4, Switch Platform perfectly. 4. Plug and play, no driver need. 5. If customers have any questions about the button settings can send an email to AIMVICETEK, we will solve your problem as soon as possible, thank you",
"upcValues": [],
"eanValues": [],
"badges": []
},
{
"asin": "B0CNSBTCKV",
"asinType": "STANDARD",
"signedProductId": "amzn1.business.asin.VMFBTHYL445CMZYZ7SDGI2LRMFZG423ZORUGOZLEG5ZGMY3BONQ6ZDOKT2LTK5NVG3BQAQGLAXTGAAX2DGLNK7JERVIB7VRTVYNNT2HODVK2TTSEAILTEQM3NYH3YIVLY2GHJORSC5Y5WQ6KWCMEXF2WC44OGVOAARDSKTOPX3GMUZYIUOTA",
"includedDataTypes": {
"OFFERS": [
{}
]
},
"features": [
"SHIELD, INDESTRUCTIBLE, LIFELINK, TRAMPLE, REACH, MENACE",
"DOUBLE STRIKE, FIRST STRIKE, DEATHTOUCH, FLYING, HEXPROOF, VIGILANCE",
"Keyword Counters Designed For Magic: The Gathering",
"Large and Easy to See!"
],
"editorialReviews": [],
"taxonomies": [
{
"taxonomyCode": "49100000",
"title": "Collectibles and awards",
"type": "UNSPSC"
}
],
"title": "10x Deluxe 12 Sided Large Keyword & Shield Counters Compatible with Magic: The Gathering MTG CCG",
"url": "https://www.amazon.com/dp/B0CNSBTCKV?ref_=ab_psdp",
"format": null,
"bookInformation": {
"isbn": {
"isbn10": null,
"isbn13": null
},
"publicationDate": null,
"publishedLanguage": null
},
"byLine": [],
"mediaInformation": {
"editions": [],
"mediaFormats": []
},
"productOverview": {
"": "",
"Team Name": "",
"Grade Rating": "",
"Unit Count": "",
"Size": "",
"Included Components": "",
"ASIN": "B0CNSBTCKV",
"Sub Brand": "",
"Product Dimensions": "",
"Athlete": "",
"Sport": "",
"Manufacturer": "Rook Robot",
"UNSPSC Code": "",
"Manufacturer recommended age": "16 years and up",
"League": "",
"Is Autographed": "",
"Package Dimensions": "8 x 6 x 1 inches; 8 Ounces",
"Parallel Type": "",
"Color": "",
"Material": "",
"Brand": "Rook Robot",
"Authenticity By": "",
"null": "",
"Year": "",
"Graded By": "",
"Theme": "",
"Age Range (Description)": "",
"Item Weight": "8 ounces",
"Country of Origin": ""
},
"productDetails": {
"": {
"Manufacturer recommended age:": "16 years and up"
}
},
"productVariations": {
"dimensions": [],
"variations": []
},
"customerReviewsSummary": {
"numberOfRatings": null,
"starRating": null
},
"productDescription": "10 Deluxe 12 Sided Large Keyword Counters. Keyword counters were first introduced in the Magic: The Gathering Set of Ikoria: Lair of Behemoths. \n\nThe keywords listed on the 12 dice sides are:\n\n LIFELINK\n TRAMPLE\n REACH\n MENACE\n FIRST STRIKE\n DOUBLE STRIKE\n DEATHTOUCH\n FLYING\n HEXPROOF\n VIGILANCE\n INDESTRUCTIBLE\n SHIELD\n\n Thanks for looking! I also made the original +1/+1 Counters and Planeswalker Loyalty Counters, check out my other items if you're interested in those! \n\nThese are 25mm dice, they are 22.5mm from face to face.",
"upcValues": [],
"eanValues": [],
"badges": []
},
{
"asin": "B0CDWFCSDT",
"asinType": "STANDARD",
"signedProductId": "amzn1.business.asin.ANUMOBRL3UCYKXNSGV7GI2LRMFZG423ZORUGOZLEG5ZGMY3BONQTIZXF5UHJRCQTF3GJYKP3KDLW6QE5KACR3FYENIUNGACYMMELAH5QK7Q3TJ4RCKZWRINVYYJYVXG5GIW5CSNZSNRIBY4YO4YCDODIP5674GDSAZGEQCVJCQMOFJMP7K3A",
"includedDataTypes": {
"OFFERS": [
{}
]
},
"features": [
"What's in the box: Compatible Replacement for HP 210X Toner Cartridge 4 Pack (1 x W2100X High Yield black, 1 x W2101X Cyan, 1 x W2102X Yellow , 1 x W2103X Magenta)and 1 x User's manual",
"High Page Yield: Up to 7,500 pages per black 210X toner , 5,500 pages for Color Toner Cartridges (W2101X,W2102X,W2103X) at 5% coverage",
"Compatible Printer: Compatible for hp Color Pro MFP 4301fdw 4301fdn, Color Pro 4201dw 4201dn printer",
"Tips: 210X toner cartridges adapt latest upgraded chip that can be quickly recognized by the printer.",
"All 210X toner cartridge are recycled from empty Original cartridges which only used once, cleaned, adhere to the concept of environmental protection and energy saving, Delivers Sharp Texts, Crisp Images and Stable Compatibility, No Fading, No powder leakage, No Streak."
],
"editorialReviews": [],
"taxonomies": [
{
"taxonomyCode": "44103103",
"title": "Printer or facsimile toner",
"type": "UNSPSC"
}
],
"title": "210X 210A Toner Cartridges Replacement for HP Color MFP 4301fdw 4301fdn Pro 4201dw 4201dn Series Printer Toner (Black Cyan Yellow Magenta 4 Pack)",
"url": "https://www.amazon.com/dp/B0CDWFCSDT?ref_=ab_psdp",
"format": null,
"bookInformation": {
"isbn": {
"isbn10": null,
"isbn13": null
},
"publicationDate": null,
"publishedLanguage": null
},
"byLine": [],
"mediaInformation": {
"editions": [],
"mediaFormats": []
},
"productOverview": {
"": "",
"Date First Available": "August 7, 2023",
"Compatible Devices": "",
"Package Dimensions": "12.5 x 7.5 x 7 inches; 6.7 Pounds",
"Included Components": "Toner Cartridge",
"Dual-sided printing": "",
"Controller Type": "",
"Color": "210X toner",
"ASIN": "B0CDWFCSDT",
"Duplex": "",
"Brand": "OFFICE-COLOR",
"null": "",
"Manufacturer": "OFFICE-COLOR",
"UNSPSC Code": "",
"Country of Origin": "",
"Page Yield": "7500",
"Item Weight": "6.7 Pounds",
"Special Feature": "High Yield"
},
"productDetails": {},
"productVariations": {
"dimensions": [],
"variations": []
},
"customerReviewsSummary": {
"numberOfRatings": null,
"starRating": null
},
"productDescription": null,
"upcValues": [],
"eanValues": [],
"badges": []
}
]
}
}
]
},
"400": {
"description": "The service was unable to process the request. Reasons for the error are described in an error response object.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
},
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"productRegion": {
"value": "US"
},
"keywords": {
"value": "pen"
},
"facets": {
"value": [
"OFFERS",
"IMAGES"
]
}
}
},
"response": {
"errors": [
{
"code": "INVALID_REQUEST_PARAMETER",
"message": "Missing required request parameters: [locale]"
}
]
}
}
]
},
"401": {
"description": "The request's authorization header isn't formatted correctly or doesn't contain a valid authorization input.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"404": {
"description": "The resource specified doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
}
},
"tags": [
"search"
],
"description": "Search for a list of products by querying on their attributes and indexed fields.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst | \n| ---- | ---- |\n| .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.",
"operationId": "searchProductsRequest",
"summary": "Search for a list products by keyword, and by other additional filter criteria."
}
},
"/products/2020-08-26/products/{productId}": {
"get": {
"produces": [
"application/json"
],
"parameters": [
{
"description": "The Amazon Standard Item Identifier (ASIN) for the product.",
"in": "path",
"name": "productId",
"required": true,
"type": "string"
},
{
"description": "The region where the customer wants to purchase the product.",
"enum": [
"DE",
"FR",
"UK",
"IT",
"ES",
"US",
"CA",
"JP"
],
"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": "JP",
"description": "Japan"
}
],
"in": "query",
"name": "productRegion",
"required": true,
"type": "string"
},
{
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"in": "query",
"name": "shippingRegion",
"required": false,
"type": "string"
},
{
"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.",
"pattern": "^[a-zA-Z_-]+$",
"in": "query",
"name": "locale",
"required": true,
"type": "string"
},
{
"description": "The shipping postal or zip code for the customer's request. This parameter doesn't support geocode.",
"in": "query",
"name": "shippingPostalCode",
"required": false,
"type": "string"
},
{
"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.",
"in": "query",
"name": "quantity",
"required": false,
"type": "integer",
"default": 1
},
{
"collectionFormat": "csv",
"description": "A list of data facets to include in the response. Separate each facet with a comma.",
"in": "query",
"enum": [
"OFFERS",
"IMAGES"
],
"name": "facets",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?facets=FOO,BAR"
},
{
"description": "The email address of the customer requesting this resource.",
"in": "header",
"name": "x-amz-user-email",
"required": true,
"type": "string"
},
{
"collectionFormat": "csv",
"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.",
"enum": [
"ALL",
"bookInformation",
"byLine",
"customerReviewsSummary",
"editorialReviews",
"features",
"format",
"mediaInformation",
"productDescription",
"productDetails",
"productOverview",
"productVariations",
"taxonomies",
"packageTypeNames",
"title",
"upcValues",
"eanValues",
"modelNumber",
"manufacturerName",
"bundleQuantity",
"badges"
],
"in": "query",
"name": "inclusionsForProducts",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?inclusionsForProducts=FOO,BAR"
},
{
"collectionFormat": "csv",
"description": "A list specifying the offer fields for inclusion in the response object. Excluding this query parameter results in the response including all inclusions.",
"enum": [
"ALL",
"availability",
"buyingGuidance",
"buyingGuidanceV2",
"buyingRestrictions",
"condition",
"fulfillmentType",
"merchant",
"merchantCertificates",
"price",
"productCondition",
"productConditionNote",
"quantityLimits",
"quantityPrice",
"taxExclusivePrice",
"deliveryInformation",
"listPrice",
"shippingOptions",
"quantityInStock",
"badges",
"fulfiller"
],
"in": "query",
"name": "inclusionsForOffers",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?inclusionsForOffers=FOO,BAR"
},
{
"description": "A value that identifies the group within the business account that a customer belongs to. The customer can set this in Amazon Business account information. GroupTag is necessary only if the customer account belongs to more than one group.",
"in": "query",
"name": "groupTag",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Product successfully retrieved.",
"schema": {
"$ref": "#/definitions/ProductsResult"
},
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
},
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"productId": {
"value": "B007VC9DKI"
},
"productRegion": {
"value": "US"
},
"locale": {
"value": "es_US"
},
"facets": {
"value": [
"OFFERS"
]
},
"shippingPostalCode": {
"value": "99999"
}
}
},
"response": {
"asin": "B007VC9DKI",
"asinType": "STANDARD",
"signedProductId": "amzn1.business.asin.KKWVAZ4AV7NVQBLCPNUGI2LRMFZG423ZORUGOZLEG5ZGMY3BONQUOL5X5WUIKF5XKBXIUSPMM7CGIVCAMA4LPZVRH2DRSHLUZZLGP27FDTAOST3HBGTLAIGD5PTKLREQHVNV3VJV6D72UQT6ZNDMBPPAMRBKYH3SMJACMU6LOFHZFN6Y5BLA",
"includedDataTypes": {
"OFFERS": [
{}
]
},
"features": [
"Incluye un (1) 1.75 onzas. Gold Bond - Barra de defensa de fricción con aloe",
"Gold Bond Friction Defense Stick reduce la fricción y reconforta la piel",
"Esta barra de fácil aplicación reduce la fricción mientras hidrata y calma la piel",
"Gold Bond Friction Defense Stick no es grasoso, sin perfume y suave para la piel sensible",
"Este palo fácil de usar se puede aplicar libremente a las zonas afectadas según sea necesario para la defensa por fricción",
"Crea una cuenta TerraCycle y comienza a reciclar tu embalaje Gold Bond vacío"
],
"editorialReviews": [],
"taxonomies": [
{
"taxonomyCode": "53131600",
"title": "Baño y cuerpo",
"type": "UNSPSC"
}
],
"title": "Loción para defensa de fricción Gold Bond, 1.75 onzas, 775387, 1, 1",
"url": "https://www.amazon.com/dp/B007VC9DKI?ref_=ab_psdp",
"format": null,
"bookInformation": {
"isbn": {
"isbn10": null,
"isbn13": null
},
"publicationDate": null,
"publishedLanguage": null
},
"byLine": [],
"mediaInformation": {
"editions": [],
"mediaFormats": []
},
"productOverview": {
"": "",
"Instrucciones": "Aplicar generosamente tan a menudo como sea necesario para reducir la fricción y calmar la piel.",
"Rango de edad (descripción)": "Adultos",
"Ingredientes activos.": "Triglicérido caprílico/cáprico, tribehenina, ésteres cetílicos, alcohol estearílico, polietileno, óxido de zinc, sílice, etilhexilglicerina, extracto de hoja de aloe barbadensis, miristato de isopropilo, bisabolol, acetato de tocoferilo, palmitato de isopropilo, extracto de raíz de Zingiber Officinale (jengibre)",
"Peso del artículo": "",
"ASIN": "B007VC9DKI",
"Producto en amazon.com desde": "Abril 18, 2012",
"Recuento de unidades": "1 Count",
"Descatalogado por el fabricante": "No",
"Usos Recomendados Para Producto": "Calmante",
"Tono de piel": "Piel sensible",
"País de origen": "",
"Usado para": "Todo el Cuerpo",
"Característica del material": "Fragrance Free",
"Nivel de resistencia al agua": "",
"Código UNSPSC": "",
"Tipo de piel": "Áspero, Sensible",
"Fragancia": "Sin fragancia",
"Dimensiones del artículo LxWxH": "2,25 x 1,25 x 4,5 pulgadas",
"Factor de protección solar": "",
"Género objetivo": "Unisex",
"Fabricante": "Gold Bond",
"Material libre de": "Sin fragancia",
"Dimensiones del producto": "2,25 x 1,25 x 4,5 pulgadas; 1,76 Onzas",
"País/región de origen": "",
"Forma del producto": "Stick",
"Volumen del artículo": "1,75 Onzas de líquido",
"Marca": "Gold Bond",
"Ingredientes": "Triglicérido caprílico/cáprico, tribehenina, ésteres cetílicos, alcohol estearílico, polietileno, óxido de zinc, sílice, etilhexilglicerina, extracto de hoja de aloe barbadensis, miristato de isopropilo, bisabolol, acetato de tocoferilo, palmitato de isopropilo, extracto de raíz de Zingiber Officinale (jengibre)",
"Beneficios del producto": "Hidratante, calmante,",
"Número de modelo del producto": "775387",
"Número de artículos": "1"
},
"productDetails": {},
"productVariations": {
"dimensions": [],
"variations": []
},
"customerReviewsSummary": {
"numberOfRatings": null,
"starRating": null
},
"productDescription": "La fricción de la piel puede ser toda una aflicción. Pero no con el palo de defensa de fricción Gold Bond Cuando generas fricción, las cosas se calientan, ¡especialmente cuando se trata de tu piel! Gold Bond Friction Defense es la fórmula calmante que reduce la fricción mientras hidrata tu piel áspera. No tiene perfume y es perfecto para la prevención de fricción diaria. Diseñado para parecerse a un desodorante en barra, es fácil aplicar esta solución calmante cuando la necesites. Mantén una en tu bolsa de gimnasio o en casa para calmar la piel áspera causada por la fricción cuando y donde más lo necesites.",
"upcValues": [],
"eanValues": [],
"badges": [
{
"name": null,
"fragment": {
"title": "#1 Best Seller",
"message": null,
"link": {
"text": "Office Products",
"url": "https://www.amazon.com/gp/bestsellers/office-products"
},
"type": "BESTSELLER_BADGE",
"fragments": null
}
}
]
}
}
]
},
"400": {
"description": "The service was unable to process your request. Reasons for the error are described in an error response object.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"productId": {
"value": "B07VDJ5RVF"
},
"locale": {
"value": "en_US"
},
"facets": {
"value": [
"OFFERS"
]
},
"shippingPostalCode": {
"value": "99999"
}
}
},
"response": {
"errors": [
{
"code": "INVALID_REQUEST_PARAMETER",
"message": "Missing required request parameters: [productRegion]"
}
]
}
}
]
},
"401": {
"description": "The request's authorization header isn't formatted correctly or doesn't contain a valid authorization input.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"404": {
"description": "The resource specified doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
}
},
"tags": [
"products"
],
"description": "Retrieves a product with its ASIN identifier.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| .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.",
"operationId": "productsRequest",
"summary": "Retrieves product data based on an ASIN identifier."
}
},
"/products/2020-08-26/products/{productId}/offers": {
"get": {
"produces": [
"application/json"
],
"parameters": [
{
"description": "The Amazon Standard Item Identifier (ASIN) for the product.",
"in": "path",
"name": "productId",
"required": true,
"type": "string"
},
{
"description": "The region where the customer wants to purchase the product.",
"enum": [
"DE",
"FR",
"UK",
"IT",
"ES",
"US",
"CA",
"JP"
],
"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": "JP",
"description": "Japan"
}
],
"in": "query",
"name": "productRegion",
"required": true,
"type": "string"
},
{
"description": "This field determines the region where to ship the product based on the value in the shippingPostalCode.",
"in": "query",
"name": "shippingRegion",
"required": false,
"type": "string"
},
{
"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.",
"pattern": "^[a-zA-Z_-]+$",
"in": "query",
"name": "locale",
"required": true,
"type": "string"
},
{
"description": "The shipping postal or zip code for customer's request. This parameter doesn't hold geocode.",
"in": "query",
"name": "shippingPostalCode",
"required": false,
"type": "string"
},
{
"description": "The zero-based number of the page being requested. If not specified, a default value of 0 will be used. When passed, the value must be equal or greater than zero, and less than the number of pages returned in the response. The maximum number of pages that can be fetched is 13.",
"in": "query",
"name": "pageNumber",
"required": false,
"type": "integer"
},
{
"description": "The requested number of products per page (default 24). Max 24 without privilege.",
"in": "query",
"name": "pageSize",
"required": false,
"type": "integer"
},
{
"description": "A value that identifies the group within the business account that a customer belongs to. The customer can set this in Amazon Business account information. GroupTag is necessary only if the customer account belongs to more than one group.",
"in": "query",
"name": "groupTag",
"required": false,
"type": "string"
},
{
"collectionFormat": "csv",
"description": "A list of filter ids for use to query results.",
"in": "query",
"name": "filterIds",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"description": "The number of units the customer intends to purchase. This helps Amazon Business determines quantity-based discounts if an eligible offer is present. Defaults to 1.",
"in": "query",
"name": "quantity",
"required": false,
"type": "integer",
"default": 1
},
{
"description": "The email address of the customer requesting this resource",
"in": "header",
"name": "x-amz-user-email",
"required": true,
"type": "string"
},
{
"collectionFormat": "csv",
"description": "A list specifying the offer fields for inclusion in the response object. Excluding this query parameter results in the response including all inclusions.",
"enum": [
"ALL",
"availability",
"buyingGuidance",
"buyingGuidanceV2",
"buyingRestrictions",
"condition",
"fulfillmentType",
"merchant",
"merchantCertificates",
"price",
"productCondition",
"productConditionNote",
"quantityLimits",
"quantityPrice",
"taxExclusivePrice",
"deliveryInformation",
"listPrice",
"shippingOptions",
"quantityInStock",
"badges",
"fulfiller"
],
"in": "query",
"name": "inclusionsForOffers",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?inclusionsForOffers=FOO,BAR"
}
],
"responses": {
"200": {
"description": "Search success",
"schema": {
"$ref": "#/definitions/OffersResult"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
},
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"productRegion": {
"value": "US"
},
"locale": {
"value": "en_US"
},
"productId": {
"value": "B07VDJ5RVF"
},
"pageNumber": {
"value": 1
},
"pageSize": {
"value": 12
},
"filterIds": {
"value": [
"NEW",
"PRIME"
]
}
}
},
"response": {
"offerCount": 22,
"numberOfPages": 2,
"featuredOffer": null,
"offers": [
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "AllThatUNeed",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "AllThatUNeed",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsSsadQtnL%2FbhsHQQEJPNVWt771eG25WpFwbYAwj%2F97KOJGPxwDOMjY61SHBjPg%2BL163YfNSELBZkaHHn6oiwjRKIboywyiAybT0UOQCZbxnd8B%2BP2Z22Lew%2BawOPrzdu8p",
"price": {
"value": {
"amount": 12.45,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 10,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery December 28 - 29"
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "Starsandstripes0321",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "Starsandstripes0321",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsSsU7fTgLW5s0f7lq3K4644FuejEaWJjmQczRqcn%2FoAm91YSrEo7ViOP7Y20vUkiu5i7m4oseC6P3YS5S14h5vfxRj6ourO1rVjI2yXnBah5cNfkh5nuM3%2FYGXLttUMpmX",
"price": {
"value": {
"amount": 12.64,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 1,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery December 29 - January 3"
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "Otc Box",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "Otc Box",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsS%2BfiSeS12hCfGHjDSjR7OYxKjjSiJk75KAixpUjpIX6u8TQAe1XEMxnevHvad8eWPZ19jL4mY56U4yl%2BUvPSGl9APSeaWhzWKjJfFBsf7jTkklnvNFSZfdOoNTA9gpnqBpY6FmBtvRIo%3D",
"price": {
"value": {
"amount": 12.88,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 30,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery January 3 - 4"
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "overstockdrugstore",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "overstockdrugstore",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsSP6IwxbGhw0AWv8bUecngCwyIP4IGtz6jhOy4XokVI7ETQt%2FTVGA6bCUQIqSXsTn2xl7Zoa3w8MAYlTlcOisGEkFTDusAimLCh1o%2BOKkT6at6jMIEfZ7csA%3D%3D",
"price": {
"value": {
"amount": 12.88,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 30,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery December 27 - January 4"
},
{
"availability": "",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "AMAZON_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "Welldent",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "Welldent",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsSm2LlnYF6lMeujPXRPQxgq57yCzX9iWt%2F3az%2BG%2BgHeLOqftb9z7ScGXA7NgiqoQSA3kTakQmlieleZhPyWBg4vAKQHmk%2Fz%2FbbgH3VYcmHJ2XjaemNvoAB4q9jbF4ITEte",
"price": {
"value": {
"amount": 6.97,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 1,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": ""
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "global-wholesale",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "global-wholesale",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsSFOT3qxHsGdSJoqyGjDG7m9EjRfEQcBgLM041n4nFVRH9SUZJhOwGlDhqxm9cYFLoGIWCCk3iylLiKohFhkDMK1hGfEgJR%2Bf19d0YlYygacuRYd1IZb1hqj5bgGT4xhrZ",
"price": {
"value": {
"amount": 13.29,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 1,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery December 29 - January 5"
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "The Customer Land",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "The Customer Land",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsSKJZao6b2VliUvroZFYlkABkORAUMR4f%2BDDhsR4rFJAj%2Fcj9l%2BuAArSb1ajwPLrnK8YqU7YYYP3jiCtEIqXrsLA4xzS8DTmxp9c3zGV6E0yjhvypE%2Bmm1SkYcytGe8S6w",
"price": {
"value": {
"amount": 13.85,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 5,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery January 4 - 8"
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "brigita",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "brigita",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsS9YZhYNK3iJm91Ra4VVTx%2FIunZ55%2FmLfP7OMraHHKy61i9NvtGs9MQx8TKjt2xnsVvPBt03bska3ZUDMDWercRbBh8FzdGWPW7DqyyeyfFUt0OxM9PJzhjw%3D%3D",
"price": {
"value": {
"amount": 8.99,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 1,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "$4.99 delivery December 27 - January 12"
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "AMAZON_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "Zoéh",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "Zoéh",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5EmsUjegBOwOAsplZfqIKsSNrEVngjcCaRFECnCmS1vw7fP%2Bki3Sr0vjB3EVCek4exgnSBBeVHLa%2FHBhC4dUPAmATmT5zje0JU%2FYFi2etKpHP3jOjyJWI1t1becKFJJT3Vy5UzcbSnpN%2FHjva0pWRrE",
"price": {
"value": {
"amount": 8,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "NEW"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 1,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery Wednesday, December 27 on orders shipped by Amazon over $35"
},
{
"availability": "In Stock.",
"buyingGuidance": "UNKNOWN",
"buyingGuidanceV2": {
"buyingGuidance": [
{
"title": "NONE",
"message": null,
"link": null,
"type": "NONE",
"fragments": []
}
]
},
"buyingRestrictions": [],
"fulfillmentType": "MERCHANT_FULFILLMENT",
"merchant": {
"merchantId": null,
"name": "OTC Meds",
"meanFeedbackRating": null,
"totalFeedbackCount": null,
"certificates": []
},
"fulfiller": {
"name": "OTC Meds",
"fulfillmentType": "MERCHANT_FULFILLMENT"
},
"offerId": "qAxlAatZj5Hq6hF5xiHfnoaJdUkM0JxDGiXXmBZxqxPIeq5xXzmAu6bc2ANiBcO8mUmCxjnUb7gRePaE8q87fI1kPACHBMGkfy6j%2B17rT%2BnsU7RpKs0C97t2CDBXsENfqtCHhXcoNKEd0N40Lq6NC78EzRRyX0FBVXepQUdANjGRvfTxXif%2B%2BYd6zR4LOosi",
"price": {
"value": {
"amount": 13.99,
"currencyCode": "USD"
},
"formattedPrice": null,
"priceType": "BUSINESS"
},
"badges": [],
"quantityInStock": null,
"listPrice": {
"value": null,
"formattedPrice": null,
"priceType": null
},
"productCondition": "NEW",
"productConditionNote": "",
"condition": {
"conditionValue": "NEW",
"conditionNote": "",
"subCondition": "UNKNOWN"
},
"quantityLimits": {
"maxQuantity": 30,
"minQuantity": 1
},
"quantityPrice": {
"quantityPriceTiers": []
},
"taxExclusivePrice": {
"taxExclusiveAmount": null,
"displayString": "",
"formattedPrice": "",
"label": ""
},
"deliveryInformation": "FREE delivery December 22 - 28"
}
],
"filterGroups": [
{
"displayName": "Delivery",
"filters": [
{
"id": "PRIME_ELIGIBLE",
"displayName": "Prime"
},
{
"id": "FREE_SHIPPING",
"displayName": "Free delivery"
}
]
},
{
"displayName": "Business Discounts",
"filters": [
{
"id": "QUANTITY_DISCOUNTS",
"displayName": "Quantity discounts"
}
]
},
{
"displayName": "Seller details",
"filters": [
{
"id": "MYC_TYPE_DIV_MIN_BUSINESS",
"displayName": "Seller Credentials - Minority-Owned Business"
},
{
"id": "MYC_TYPE_DIV_REG_SMALL_BUSINESS",
"displayName": "Seller Credentials - Registered Small Business"
}
]
},
{
"displayName": "Condition",
"filters": [
{
"id": "NEW",
"displayName": "New"
}
]
}
]
}
}
]
},
"400": {
"description": "The service was unable to process the request. Reasons for the error are described in an error response object.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
},
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"productRegion": {
"value": "US"
},
"productId": {
"value": "B07VDJ5RVF"
}
}
},
"response": {
"errors": [
{
"code": "INVALID_REQUEST_PARAMETER",
"message": "Missing required request parameters: [locale]"
}
]
}
}
]
},
"401": {
"description": "The request's authorization header isn't formatted correctly or doesn't contain a valid authorization input.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"404": {
"description": "The resource specified doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
}
},
"tags": [
"search"
],
"description": "Search for offers of a specific product.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| .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.",
"operationId": "searchOffersRequest",
"summary": "Paginated and filtered search for offers of a specific product."
}
},
"/products/2020-08-26/products/getProductsByAsins": {
"post": {
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "productsByAsins",
"schema": {
"$ref": "#/definitions/ProductsByAsinsRequest"
}
},
{
"description": "The email address of the customer requesting this resource.",
"in": "header",
"name": "x-amz-user-email",
"required": true,
"type": "string"
},
{
"collectionFormat": "csv",
"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.",
"enum": [
"ALL",
"bookInformation",
"byLine",
"customerReviewsSummary",
"editorialReviews",
"features",
"format",
"mediaInformation",
"productDescription",
"productDetails",
"productOverview",
"productVariations",
"taxonomies",
"packageTypeNames",
"title",
"upcValues",
"eanValues",
"modelNumber",
"manufacturerName",
"bundleQuantity",
"badges"
],
"in": "query",
"name": "inclusionsForProducts",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?inclusionsForProducts=FOO,BAR"
},
{
"collectionFormat": "csv",
"description": "A list specifying the offer fields for inclusion in the response object. Excluding this query parameter results in the response including all inclusions.",
"enum": [
"ALL",
"availability",
"buyingGuidance",
"buyingGuidanceV2",
"buyingRestrictions",
"condition",
"fulfillmentType",
"merchant",
"merchantCertificates",
"price",
"productCondition",
"productConditionNote",
"quantityLimits",
"quantityPrice",
"taxExclusivePrice",
"deliveryInformation",
"listPrice",
"shippingOptions",
"quantityInStock",
"badges",
"fulfiller"
],
"in": "query",
"name": "inclusionsForOffers",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"x-example": "/path?inclusionsForOffers=FOO,BAR"
},
{
"description": "A value that identifies the group within the business account that a customer belongs to. The customer can set this in Amazon Business account information. GroupTag is necessary only if the customer account belongs to more than one group.",
"in": "query",
"name": "groupTag",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Products successfully retrieved.",
"schema": {
"$ref": "#/definitions/ProductsByAsinsResponse"
},
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
},
"x-amazon-spds-sandbox-behaviors": [
{
"request": {
"parameters": {
"body": {
"value": {
"locale": "en_US",
"productRegion": "US",
"productIds": [
"B007VC9DKI",
"B007VC9DKI",
"B007VC9DKI"
]
}
}
}
},
"response": {
"matchingProductCount": 1,
"products": [
{
"asin": "B007VC9DKI",
"asinType": "STANDARD",
"signedProductId": "amzn1.business.asin.RDI2VWGXWAI4MW2BA2MGI2LRMFZG423ZORUGOZLEG5ZGMY3BONQYIXK7CHIQUKIOC55HZRMI6QOP2RK2FJDOFJ7VJAFC6XTT25D5VFERXCAC2B3REYAEVGF2PKFPGEJMWHVN7JOKUYAXHNDTQDEQIOB225VXRNDKQGFQX2XQC6ENUQREF5NQ",
"includedDataTypes": {},
"features": [
"Includes one (1) 1.75-oz. Gold Bond Friction Defense Stick With Aloe",
"Gold Bond Friction Defense Stick reduces friction and comforts skin",
"This easy application stick reduces friction while moisturizing and soothing skin",
"Gold Bond Friction Defense Stick is nongreasy, unscented and gentle on sensitive skin",
"This easy to use stick can be applied liberally to affected areas as needed for friction defense",
"Create a TerraCycle account and start recycling your empty Gold Bond packaging"
],
"editorialReviews": [],
"taxonomies": [
{
"taxonomyCode": "53131600",
"title": "Bath and body",
"type": "UNSPSC"
}
],
"title": "Gold Bond Friction Defense Stick, 1.75 oz., With Aloe to Soothe, Comfort & Moisturize Rough Skin",
"url": "https://www.amazon.com/dp/B007VC9DKI?ref_=ab_psdp",
"format": null,
"bookInformation": {
"isbn": {
"isbn10": null,
"isbn13": null
},
"publicationDate": null,
"publishedLanguage": null
},
"byLine": [],
"mediaInformation": {
"editions": [],
"mediaFormats": []
},
"productOverview": {
"": "",
"Date First Available": "April 18, 2012",
"Sun Protection Factor": "",
"Unit Count": "1 Count",
"Material Type Free": "Fragrance Free",
"Directions": "Apply liberally as often as needed to reduce friction and soothe skin.",
"Recommended Uses For Product": "Soothing",
"Country/Region Of Origin": "",
"ASIN": "B007VC9DKI",
"Product Dimensions": "2.25 x 1.25 x 4.5 inches; 1.76 Ounces",
"Is Discontinued By Manufacturer": "No",
"Active Ingredients": "Caprylic/Capric Triglyceride, Tribehenin, Cetyl Esters, Stearyl Alcohol, Polyethylene, Zinc Oxide, Silica, Ethylhexylglycerin, Aloe Barbadensis Leaf Extract, Isopropyl Myristate, Bisabolol, Tocopheryl Acetate, Isopropyl Palmitate, Zingiber Officinale (Ginger) Root Extract",
"Manufacturer": "Gold Bond",
"Target Gender": "Unisex",
"UNSPSC Code": "",
"Number of Items": "1",
"Use for": "Whole Body",
"Skin Type": "Sensitive, Rough",
"Ingredients": "Caprylic/Capric Triglyceride, Tribehenin, Cetyl Esters, Stearyl Alcohol, Polyethylene, Zinc Oxide, Silica, Ethylhexylglycerin, Aloe Barbadensis Leaf Extract, Isopropyl Myristate, Bisabolol, Tocopheryl Acetate, Isopropyl Palmitate, Zingiber Officinale (Ginger) Root Extract",
"Item model number": "775387",
"Material Feature": "",
"Skin Tone": "Sensitive skin",
"Brand": "Gold Bond",
"Item Volume": "1.75 Fluid Ounces",
"Item Form": "Stick",
"Water Resistance Level": "",
"Item Dimensions LxWxH": "2.25 x 1.25 x 4.5 inches",
"Age Range (Description)": "Adult",
"Scent": "Unscented",
"Product Benefits": "Moisturizing, Soothing,",
"Country of Origin": "",
"Item Weight": "1.76 Ounces"
},
"productDetails": {},
"productVariations": {
"dimensions": [],
"variations": []
},
"customerReviewsSummary": {
"numberOfRatings": null,
"starRating": null
},
"productDescription": "Skin friction can be quite an affliction. But not with Gold Bond Friction Defense Stick. When you generate friction, things heat up –– especially when it comes to your skin! Gold Bond Friction Defense is the soothing formula that reduces friction while moisturizing your roughed-up skin. It’s unscented and perfect for daily friction prevention. Designed to look like a deodorant stick, it's easy to apply this soothing solution whenever you need it. Keep one in your gym bag or at home to soothe rough skin caused by friction whenever and wherever you need it most.",
"upcValues": [],
"eanValues": [],
"badges": [
{
"name": null,
"fragment": {
"title": "#1 Best Seller",
"message": null,
"link": {
"text": "Office Products",
"url": "https://www.amazon.com/gp/bestsellers/office-products"
},
"type": "BESTSELLER_BADGE",
"fragments": null
}
}
]
}
],
"notFoundAsins": [
"ATVPDKIKX0"
]
}
}
]
},
"400": {
"description": "The service was unable to process your request. Reasons for the error are described in an error response object.",
"schema": {
"$ref": "#/definitions/ErrorList"
}
},
"401": {
"description": "The request's authorization header isn't formatted correctly or doesn't contain a valid authorization input.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"403": {
"description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"404": {
"description": "The resource specified doesn't exist.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"429": {
"description": "The frequency of requests was greater than allowed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"500": {
"description": "Encountered an unexpected condition which prevented the server from fulfilling the request.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
},
"503": {
"description": "Temporary overloading or maintenance of the server.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
},
"headers": {
"x-amzn-RateLimit-Limit": {
"description": "The rate limit (requests per second) for this operation.",
"type": "string"
},
"x-amzn-requestid": {
"description": "A unique request reference identifier.",
"type": "string"
}
}
}
},
"tags": [
"products"
],
"description": "Retrieves products for the ASIN identifier present in the list of ASINs.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| .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.",
"operationId": "getProductsByAsins",
"summary": "The result for list of ASIN search."
}
}
},
"definitions": {
"AsinType": {
"description": "The type of ASIN returned in the request.",
"type": "string",
"enum": [
"STANDARD",
"VARIATION_PARENT",
"VARIATION_CHILD"
],
"x-docgen-enum-table-extension": [
{
"value": "STANDARD",
"description": "Available for direct purchase."
},
{
"value": "VARIATION_PARENT",
"description": "Not available for direct purchase but is linked to one or more VARIATION_CHILD."
},
{
"value": "VARIATION_CHILD",
"description": "Has specific settings for certain attributes such as the size and color of a shirt. This type of ASIN can have different prices and can be offered by different merchants."
}
]
},
"Category": {
"description": "The search category is used to give information about relevant categories a product belongs to. Use category to limit the results for a particular category in subsequent requests.",
"required": [
"displayName",
"id"
],
"properties": {
"displayName": {
"description": "Display name is used to share more human friendly readable description of category.",
"type": "string"
},
"id": {
"description": "Identifies a search category within a product region.",
"type": "string"
}
},
"title": "Category",
"type": "object"
},
"ErrorResponse": {
"description": "The response returned for unsuccessful request.",
"properties": {
"errors": {
"description": "A list of errors encountered while processing the request.",
"$ref": "#/definitions/ErrorList"
}
},
"type": "object"
},
"ErrorList": {
"description": "A list of errors in the response.",
"type": "array",
"items": {
"$ref": "#/definitions/Error"
}
},
"Error": {
"description": "Provides the error detail as part of the error response.",
"properties": {
"code": {
"description": "The error code in the error response.",
"type": "string",
"enum": [
"PRODUCT_NOT_FOUND",
"PAGE_NOT_FOUND",
"INVALID_REQUEST_PARAMETER",
"SERVICE_ERROR",
"EMAIL_ID_NOT_FOUND",
"UNAUTHORIZED",
"REQUEST_RATE_LIMIT_EXCEEDED"
],
"x-docgen-enum-table-extension": [
{
"value": "PRODUCT_NOT_FOUND",
"description": "The product doesn't exist in the product catalog."
},
{
"value": "PAGE_NOT_FOUND",
"description": "The page or resource can't be found."
},
{
"value": "INVALID_REQUEST_PARAMETER",
"description": "Some parameters are missing or incorrect."
},
{
"value": "SERVICE_ERROR",
"description": "The service was unable to process the request."
},
{
"value": "EMAIL_ID_NOT_FOUND",
"description": "The email ID doesn't exist or there's missing characters or numbers."
},
{
"value": "UNAUTHORIZED",
"description": "The request lacks valid authentication credentials for the requested resource."
},
{
"value": "REQUEST_RATE_LIMIT_EXCEEDED",
"description": "The request rate exceeds the maximum allowed transactions per second (TPS) rate."
}
]
},
"message": {
"description": "A message that describes the error condition.",
"type": "string"
},
"details": {
"description": "Additional details that can help the customer understand or fix the issue.",
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"BuyingRestriction": {
"description": "If present, this object shows restrictions that would prevent the customer from buying the product.",
"required": [
"title",
"type"
],
"properties": {
"title": {
"description": "A displayable string which explains the restriction.",
"type": "string"
},
"type": {
"description": "The type of buying restrictions that exist for a product. Possible value: PROFESSIONAL_USE",
"type": "string"
}
},
"type": "object"
},
"ImageData": {
"description": "A structure which holds the data for a given image.",
"required": [
"height",
"url",
"width"
],
"properties": {
"height": {
"description": "The height of the image in pixels.",
"type": "integer"
},
"url": {
"description": "The URL to use when retrieving an image.",
"type": "string"
},
"width": {
"description": "The width of the image in pixels.",
"type": "integer"
}
},
"type": "object"
},
"ImageItem": {
"description": "A structure which holds the data for a given image.",
"required": [
"altText"
],
"properties": {
"altText": {
"description": "The text to use for the image's alt property.",
"type": "string"
},
"original": {
"$ref": "#/definitions/ImageData",
"description": "The data for original rendering of the image. The image resolution is 2560px x 2560px, but can vary."
},
"large": {
"$ref": "#/definitions/ImageData",
"description": "The data for a large rendering of the image. The image resolution is 500px x 500px, but can vary."
},
"medium": {
"$ref": "#/definitions/ImageData",
"description": "The data for a medium rendering of the image. The image resolution is 250px x 250px, but can vary."
},
"small": {
"$ref": "#/definitions/ImageData",
"description": "The data for a small rendering of the image. The image resolution is 160px x 160px, but can vary."
},
"thumbnail": {
"$ref": "#/definitions/ImageData",
"description": "The data for a very small rendering of the image. The image resolution is 40px x 40px, but can vary."
}
},
"type": "object"
},
"ImagesFacet": {
"description": "A list of image data for the product. The first item in the list is the product's primary image as shown on the Amazon Business website. Additional images show different views of the product or other visual information useful to the customer.",
"items": {
"$ref": "#/definitions/ImageItem"
},
"type": "array"
},
"Link": {
"description": "Parent structure that holds the URL and its display text.",
"required": [
"url"
],
"properties": {
"text": {
"description": "The display text to use for the link.",
"type": "string"
},
"url": {
"description": "The URL of the link.",
"type": "string"
}
},
"type": "object"
},
"Fragment": {
"description": "Common structure to denote information like badges and guided buying policies.",
"type": "object",
"required": [
"type"
],
"properties": {
"title": {
"description": "The fragment title or header.",
"type": "string"
},
"message": {
"description": "A custom message or description for the fragment, such as an admin note for a guided buying policy.",
"type": "string"
},
"link": {
"description": "URL link to the fragment’s detail page.",
"$ref": "#/definitions/Link"
},
"type": {
"description": "Locale independent identifier for the fragment.",
"type": "string",
"enum": [
"SUSTAINABILITY_BADGE",
"SUSTAINABILITY_ATTRIBUTE",
"BUSINESS_INVOICE_BADGE",
"JCT_BADGE",
"PREFERRED",
"RESTRICTED",
"BLOCKED",
"NONE",
"NEGOTIATED",
"UNKNOWN",
"BESTSELLER_BADGE"
],
"x-docgen-enum-table-extension": [{
"value": "SUSTAINABILITY_BADGE",
"description": "The product is available with sustainability certifications."
},
{
"value": "SUSTAINABILITY_ATTRIBUTE",
"description": "Attributes associated with sustainability certification of the product."
},
{
"value": "BUSINESS_INVOICE_BADGE",
"description": "The offer has a business invoice badge."
},
{
"value": "JCT_BADGE",
"description": "The offer has a Japan Consumption Tax (JCT) badge"
},
{
"value": "PREFERRED",
"description": "Buying guidance for this product is prefered."
},
{
"value": "RESTRICTED",
"description": "Buying guidance for this product is restricted."
},
{
"value": "BLOCKED",
"description": "Buying guidance for this product is blocked."
},
{
"value": "NONE",
"description": "Buying guidance has not been specified for the product."
},
{
"value": "NEGOTIATED",
"description": "The product has buying guidance as negotiated."
},
{
"value": "UNKNOWN",
"description": "Buying guidance for this product is unknown"
},
{
"value": "BESTSELLER_BADGE",
"description": "The product has a bestseller badge."
},
{
"value": "PRIME_BADGE",
"description": "The product has a Prime badge."
}
]
},
"fragments": {
"description": "List of fragments to share additional information.",
"type": "array",
"items": {
"$ref": "#/definitions/Fragment"
}
}
},
"example": {
"title": "Sample title",
"message": "Sample message",
"link": [
{
"text": "Link text",
"url": "Link url"
}
],
"type": "SAMPLE_TYPE",
"fragments": [
{
"title": "Sample fragment title",
"message": null,
"link": null,
"type": "SAMPLE_FRAGMENT_TYPE",
"fragments": [
{
"title": "Sample nested fragment title",
"message": null,
"link": null,
"type": "SAMPLE_NESTED_FRAGMENT_TYPE",
"fragments": null
}
]
}
]
}
},
"Merchant": {
"description": "Information about the merchant selling the product.",
"required": [
"merchantId",
"name",
"meanFeedbackRating",
"totalFeedbackCount"
],
"properties": {
"merchantId": {
"description": "The unique id of the merchant selling the product.",
"type": "string"
},
"name": {
"description": "The displayable name of the merchant selling the product.",
"type": "string"
},
"meanFeedbackRating": {
"description": "The mean of the total ratings given to the merchant selling the product.",
"type": "number",
"format": "double"
},
"totalFeedbackCount": {
"description": "The total number of reviews for the merchant selling the product.",
"type": "number",
"format": "integer"
},
"certificates": {
"description": "List of merchant-owned certifications, such as “Registered Small Business” or “Women-Owned Business Enterprise.”",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
},
"Fulfiller": {
"description": "Information about the fulfiller of the product.",
"required": [
"name",
"fulfillmentType"
],
"properties": {
"name": {
"description": "The displayable name of the product fulfiller.",
"type": "string"
},
"fulfillmentType": {
"description": "The fulfillment system to use for the purchased product.",
"type": "string",
"enum": [
"AMAZON_FULFILLMENT",
"MERCHANT_FULFILLMENT",
"OTHER"
],
"x-docgen-enum-table-extension": [
{
"value": "AMAZON_FULFILLMENT",
"description": "Amazon Business picks, packs, and ships the product directly to the buyer on behalf of the seller."
},
{
"value": "MERCHANT_FULFILLMENT",
"description": "Sellers pick, pack, and ship the product directly to the buyer."
},
{
"value": "OTHER",
"description": "Amazon Business or the third-party sellers ship the product from their own sources of inventory directly to buyer."
}
]
}
},
"type": "object"
},
"Condition": {
"description": "Information about the condition of the product.",
"required": [
"conditionValue",
"conditionNote",
"subCondition"
],
"properties": {
"conditionValue": {
"description": "The possible condition of the product being sold by the merchant.",
"$ref": "#/definitions/ConditionValue"
},
"conditionNote": {
"description": "Additional details on the product's condition.",
"type": "string"
},
"subCondition": {
"description": "The possible sub condition of the product being sold by the merchant.",
"$ref": "#/definitions/SubCondition"
}
},
"type": "object"
},
"ConditionValue": {
"description": "The possible condition of the product being sold by the merchant.",
"type": "string",
"enum": [
"NEW",
"USED",
"COLLECTIBLE",
"REFURBISHED",
"OTHER",
"UNKNOWN"
],
"x-docgen-enum-table-extension": [
{
"value": "NEW",
"description": "A brand-new, unused item in perfect condition."
},
{
"value": "USED",
"description": "A used item may be fairly worn or in perfect condition but still works perfectly."
},
{
"value": "COLLECTIBLE",
"description": "Collectible items are rare, signed, out of print or distribution, or unique. The Seller should provide details why the product is collectible."
},
{
"value": "REFURBISHED",
"description": "A product that's professionally restored to working condition before resale. The product is inspected, cleaned, and repaired to meet manufacturer specifications. The product might not be in its original packaging. The manufacturer warranty or warranty of the refurbishing service company might apply. The warranty should be in the Condition comments."
},
{
"value": "OTHER",
"description": "Refers to the condition of the product that isn't new, used, collectible, refurbished, or unknown."
},
{
"value": "UNKNOWN",
"description": "The condition of the product is unknown."
}
]
},
"SubCondition": {
"description": "The possible sub condition of the product being sold by the merchant.",
"type": "string",
"enum": [
"ACCEPTABLE",
"CLUB",
"GOOD",
"LIKE_NEW",
"NEW",
"OEM",
"OPEN_BOX",
"REFURBISHED",
"UNKNOWN",
"VERY_GOOD"
],
"x-docgen-enum-table-extension": [
{
"value": "ACCEPTABLE",
"description": "The product is fairly worn but it continues to work perfectly. The signs of wear can include scratches, dents, and other aesthetic problems. The product might be marked or have identifying information on it, and show other signs of previous use."
},
{
"value": "CLUB",
"description": "A product or service that is communal or has collective ownership-consumption arrangement."
},
{
"value": "GOOD",
"description": "The product shows wear from consistent use but remains in good condition. The product might be marked or have identifying information on it, and show other signs of previous use. The product works perfectly."
},
{
"value": "LIKE_NEW",
"description": "An item in perfect working condition. The original plastic wrap might be missing. The original packaging might have minor damage or item might have been repackaged. All accessories are present."
},
{
"value": "NEW",
"description": "An apparently untouched product in perfect condition. The original plastic wrap might be missing but the original packaging is intact and pristine; instructions are included. There are absolutely no signs of wear. Suitable for presenting as a gift."
},
{
"value": "OEM",
"description": "Original Equipment Manufacturer (OEM) is defined as a company that provides parts for the finished products of other companies."
},
{
"value": "OPEN_BOX",
"description": "The product is in the box either with original, visible, or slightly visible UPC."
},
{
"value": "REFURBISHED",
"description": "A refurbished product in used condition. The manufacturer warranty no longer applies."
},
{
"value": "UNKNOWN",
"description": "The condition of the product is unknown."
},
{
"value": "VERY_GOOD",
"description": "A well-cared product with limited use but still in great condition. The product is complete, unmarked, and undamaged but might show some limited signs of wear. The product works perfectly."
}
]
},
"Offer": {
"description": "An offer for a product being sold by a merchant. This object contains details that would help a buyer decide whether to purchase or not to purchase a product.",
"required": [
"availability",
"buyingGuidance",
"buyingRestrictions",
"fulfillmentType",
"merchant",
"offerId",
"price",
"productCondition",
"productConditionNote",
"condition",
"quantityLimits",
"taxExclusivePrice",
"deliveryInformation",
"listPrice",
"shippingOptions",
"quantityInStock",
"badges"
],
"properties": {
"availability": {
"description": "Displays the available dates to ship the product after purchased.",
"type": "string"
},
"buyingGuidance": {
"description": "Some organizations establish guided buying policies to inform Amazon Business whether their organization supports the purchase of specified types of products. If an organization hasn't configured such policies, an API call returns the value \"NONE\" for the BuyingGuidance property.",
"type": "string",
"enum": [
"PREFERRED",
"RESTRICTED",
"BLOCKED",
"NONE",
"NEGOTIATED",
"UNKNOWN"
],
"x-docgen-enum-table-extension": [
{
"value": "PREFERRED",
"description": "Your organization has identified this item as preferred and wants you to choose it over similar products."
},
{
"value": "RESTRICTED",
"description": "Your organization has identified this item as non-compliant with your organization's purchasing standards."
},
{
"value": "BLOCKED",
"description": "Your organization has blocked the purchase of this item."
},
{
"value": "NONE",
"description": "Your organization didn't specify a buying guidance for this product."
},
{
"value": "NEGOTIATED",
"description": "This item has a custom offer that’s included in a pricing deal for your organization and is shown as featured offer. Your organization encourages you to buy this offer."
},
{
"value": "UNKNOWN",
"description": "The buying guidance is unknown."
}
]
},
"buyingGuidanceV2": {
"description": "Some organizations establish guided buying policies to inform Amazon Business whether their organization supports the purchase of specified product types. If an organization hasn't configured such policies, an API call returns a Fragment object with value \"NONE\" for the title property.",
"properties": {
"buyingGuidance": {
"description": "Collection of applicable buying guidance policies for this product offer.",
"type": "array",
"items": {
"$ref": "#/definitions/Fragment"
}
}
},
"type": "object"
},
"buyingRestrictions": {
"description": "When present, entries in this property describe the reasons a buyer is restricted from buying a product.",
"items": {
"$ref": "#/definitions/BuyingRestriction"
},
"type": "array"
},
"fulfillmentType": {
"description": "The fulfillment system to use for the purchased product purchase.",
"type": "string",
"enum": [
"AMAZON_FULFILLMENT",
"MERCHANT_FULFILLMENT",
"OTHER"
],
"x-docgen-enum-table-extension": [
{
"value": "AMAZON_FULFILLMENT",
"description": "Amazon Business picks, packs, and ships the product directly to the buyer on behalf of the seller."
},
{
"value": "MERCHANT_FULFILLMENT",
"description": "Sellers pick, pack, and ship the product directly to the buyer."
},
{
"value": "OTHER",
"description": "Amazon Business or the third-party sellers ship the product from their own sources of inventory directly to buyer."
}
]
},
"merchant": {
"$ref": "#/definitions/Merchant"
},
"fulfiller": {
"$ref": "#/definitions/Fulfiller"
},
"offerId": {
"description": "The Amazon Business offer identifier to use when purchasing a product.",
"type": "string"
},
"price": {
"$ref": "#/definitions/Price"
},
"shippingOptions": {
"description": "The options for shipping a product offer.",
"items": {
"$ref": "#/definitions/ShippingOption"
},
"type": "array"
},
"badges": {
"description": "The types of badges available for a product offer, such as Invoice by Amazon (IBA) or Japan Consumption Tax (JCT).",
"type": "array",
"items": {
"$ref": "#/definitions/Badge"
}
},
"quantityInStock": {
"description": "The number of items in stock for a product offer.",
"type": "integer",
"format": "int64"
},
"listPrice": {
"$ref": "#/definitions/Price"
},
"productCondition": {
"description": "The possible condition of the product being sold by the merchant.",
"type": "string",
"enum": [
"NEW",
"USED",
"COLLECTIBLE",
"REFURBISHED",
"OTHER",
"UNKNOWN"
],
"x-docgen-enum-table-extension": [
{
"value": "NEW",
"description": "A brand-new, unused item in perfect condition."
},
{
"value": "USED",
"description": "A used item may be fairly worn or in perfect condition but still works perfectly."
},
{
"value": "COLLECTIBLE",
"description": "Collectible items are rare, signed, out of print or distribution, or unique. The Seller should provide details why the product is collectible."
},
{
"value": "REFURBISHED",
"description": "A product that's professionally restored to working condition before resale. The product is inspected, cleaned, and repaired to meet manufacturer specifications. The product might not be in its original packaging. The manufacturer warranty or warranty of the refurbishing service company might apply. The warranty should be in the Condition comments."
},
{
"value": "OTHER",
"description": "Refers to the condition of the product that isn't new, used, collectible, refurbished, or unknown."
},
{
"value": "UNKNOWN",
"description": "The condition of the product is unknown."
}
]
},
"productConditionNote": {
"description": "Additional details on the product's condition.",
"type": "string"
},
"condition": {
"description": "Information about the condition of the product.",
"$ref": "#/definitions/Condition"
},
"quantityLimits": {
"$ref": "#/definitions/OfferQuantityLimits"
},
"quantityPrice": {
"$ref": "#/definitions/QuantityPrice"
},
"taxExclusivePrice": {
"$ref": "#/definitions/TaxExclusivePrice"
},
"deliveryInformation": {
"description": "Information regarding the estimated delivery time and delivery price.",
"type": "string"
}
},
"type": "object"
},
"ShippingOption": {
"description": "The available options for shipping a product offer.",
"required": [
"shippingCost",
"deliveryRange",
"deliveryInformation",
"thresholdCost"
],
"properties": {
"shippingCost": {
"description": "The cost related to shipping an item.",
"$ref": "#/definitions/ShippingDetails"
},
"deliveryRange": {
"description": "The delivery window for shipping a product offer.",
"$ref": "#/definitions/DeliveryDateRange"
},
"deliveryInformation": {
"description": "String representation of the estimated delivery time and delivery price.",
"type": "string"
},
"thresholdCost": {
"description": "The threshold for free shipping. When the total cost of the order exceeds this cost, shipping is free.",
"$ref": "#/definitions/ThresholdPrice"
}
},
"type": "object"
},
"Badge": {
"description": "Common structure to denote badges.",
"required": [
"name"
],
"properties": {
"name": {
"description": "The name of a badge for a product offer.",
"type": "string"
},
"fragment": {
"$ref": "#/definitions/Fragment"
}
},
"type": "object"
},
"ShippingDetails": {
"description": "The charges related to shipping a product offer.",
"required": [
"value"
],
"properties": {
"value": {
"description": "An object that contains numerical amount value and the currency code.",
"$ref": "#/definitions/Money"
}
},
"type": "object"
},
"DeliveryDateRange": {
"description": "Indicates the minimum and maximum delivery date and time to ship a product offer.",
"required": [
"max",
"min"
],
"properties": {
"max": {
"description": "The maximum local delivery date and time to ship a product offer.",
"type": "string",
"format": "date-time"
},
"min": {
"description": "The minimum local delivery date and time to ship a product offer.",
"type": "string",
"format": "date-time"
}
},
"type": "object"
},
"ThresholdPrice": {
"description": "The threshold for free shipping. The shipping cost is applicable when the value of the order is below this cost. When the order value exceeds this cost, shipping is free.",
"required": [
"value"
],
"properties": {
"value": {
"description": "An object that contains numerical amount value and the currency code.",
"$ref": "#/definitions/Money"
}
},
"type": "object"
},
"OfferQuantityLimits": {
"description": "The number of items allowed to purchase a product in a single order. Some products have both a min and max quantity.",
"required": [
"maxQuantity",
"minQuantity"
],
"properties": {
"maxQuantity": {
"description": "The largest number of products the customer can buy in an order.",
"format": "int64",
"type": "integer"
},
"minQuantity": {
"description": "The smallest number of products the customer can buy in an order.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"ProductOffersFacet": {
"description": "A list of product offers, showing who is selling the product and at what price. This data is returned in the facets property, referenced by the key \"OFFERS\". The response returns, at most, 10 offers.",
"items": {
"$ref": "#/definitions/Offer"
},
"type": "array"
},
"SearchOffersFacet": {
"description": "For searches, the response returns a single offer for each matching product in the result.",
"items": {
"$ref": "#/definitions/Offer"
},
"type": "array"
},
"Money": {
"description": "An object that holds the numerical value and the currency code associated with the money.",
"required": [
"amount",
"currencyCode"
],
"properties": {
"amount": {
"description": "The numerical value of the money.",
"format": "double",
"type": "number"
},
"currencyCode": {
"description": "The currency code for that price amount depending on the requested locale",
"type": "string"
}
},
"type": "object"
},
"Price": {
"description": "The actual price the customers pay for the product.",
"required": [
"value",
"formattedPrice",
"priceType"
],
"properties": {
"value": {
"description": "An object that contains numerical amount value and the currency code.",
"$ref": "#/definitions/Money"
},
"formattedPrice": {
"description": "A displayable version of the price and currency code.",
"type": "string"
},
"priceType": {
"description": "A description of the type of price. Some prices are indicative of special business pricing for a customer.",
"type": "string"
}
},
"type": "object"
},
"TaxExclusivePrice": {
"description": "The price of the product without tax.",
"required": [
"displayString",
"formattedPrice",
"label",
"taxExclusiveAmount"
],
"properties": {
"taxExclusiveAmount": {
"description": "An object that contains numerical amount value and the currency code.",
"$ref": "#/definitions/Money"
},
"displayString": {
"description": "A displayable message about the tax exclusion.",
"type": "string"
},
"formattedPrice": {
"description": "A displayable version of the price and currency code.",
"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",
"includedDataTypes",
"features",
"taxonomies",
"packageTypeNames",
"title",
"url",
"format",
"bookInformation",
"byLine",
"mediaInformation",
"productDescription",
"productOverview",
"productDetails",
"customerReviewsSummary",
"productVariations",
"upcValues",
"eanValues",
"modelNumber",
"manufacturerName",
"bundleQuantity",
"isCustomQuoteEligible"
],
"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"
},
"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"
},
"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"
}
}
},
"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"
},
"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",
"US",
"CA",
"JP"
],
"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": "JP",
"description": "Japan"
}
]
},
"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."
}
]
}
}
}
},
"SearchProductsResult": {
"description": "The data that describes the results of the search query.",
"required": [
"matchingProductCount",
"numberOfPages",
"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"
},
"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",
"US",
"CA",
"JP"
],
"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"
},
"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"
}
}
}
},
"tags": [
{
"description": "Get data about a particular product.",
"name": "products"
}
],
"x-components": {}
}
Updated about 13 hours ago
Did this page help you?