diff --git a/models/catalog-items-api-model/catalogItems_2020-12-01.json b/models/catalog-items-api-model/catalogItems_2020-12-01.json index 114709d..887201e 100644 --- a/models/catalog-items-api-model/catalogItems_2020-12-01.json +++ b/models/catalog-items-api-model/catalogItems_2020-12-01.json @@ -24,6 +24,545 @@ "application/json" ], "paths": { + "/catalog/2020-12-01/items": { + "get": { + "tags": [ + "catalog" + ], + "description": "Search for and return a list of Amazon catalog items and associated information.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 1 | 5 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "searchCatalogItems", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "keywords", + "description": "A comma-delimited list of words or item identifiers to search the Amazon catalog for.", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "shoes" + }, + { + "name": "marketplaceIds", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "in": "query", + "required": true, + "type": "array", + "maxItems": 1, + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "ATVPDKIKX0DER" + }, + { + "name": "includedData", + "description": "A comma-delimited list of data sets to include in the response. Default: summaries.", + "in": "query", + "required": false, + "type": "array", + "items": { + "enum": [ + "identifiers", + "images", + "productTypes", + "salesRanks", + "summaries", + "variations", + "vendorDetails" + ], + "type": "string", + "x-docgen-enum-table-extension": [ + { + "value": "identifiers", + "description": "Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers." + }, + { + "value": "images", + "description": "Images for an item in the Amazon catalog. All image variants are provided to brand owners; a thumbnail of the \"MAIN\" image variant is provided otherwise." + }, + { + "value": "productTypes", + "description": "Product types associated with the Amazon catalog item." + }, + { + "value": "salesRanks", + "description": "Sales ranks of an Amazon catalog item." + }, + { + "value": "summaries", + "description": "Summary details of an Amazon catalog item." + }, + { + "value": "variations", + "description": "Variation details of an Amazon catalog item (variation relationships)." + }, + { + "value": "vendorDetails", + "description": "Vendor details associated with an Amazon catalog item. Vendor details are available to vendors only." + } + ] + }, + "collectionFormat": "csv", + "x-example": "summaries", + "default": "summaries" + }, + { + "name": "brandNames", + "description": "A comma-delimited list of brand names to limit the search to.", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "Beautiful Boats" + }, + { + "name": "classificationIds", + "description": "A comma-delimited list of classification identifiers to limit the search to.", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "12345678" + }, + { + "name": "pageSize", + "description": "Number of results to be returned per page.", + "in": "query", + "required": false, + "type": "integer", + "maximum": 20, + "default": 10, + "x-example": 9 + }, + { + "name": "pageToken", + "description": "A token to fetch a certain page when there are multiple pages worth of results.", + "in": "query", + "required": false, + "type": "string", + "x-example": "sdlkj234lkj234lksjdflkjwdflkjsfdlkj234234234234" + }, + { + "name": "keywordsLocale", + "description": "The language the keywords are provided in. Defaults to the primary locale of the marketplace.", + "in": "query", + "required": false, + "type": "string", + "x-example": "en_US" + }, + { + "name": "locale", + "description": "Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.", + "in": "query", + "required": false, + "type": "string", + "x-example": "en_US" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ItemSearchResults" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "examples": { + "application/json": { + "numberOfResults": 3097, + "pagination": { + "nextPage": "xsdflkj324lkjsdlkj3423klkjsdfkljlk2j34klj2l3k4jlksdjl234", + "previousPage": "ilkjsdflkj234lkjds234234lkjl234lksjdflkj234234lkjsfsdflkj333d" + }, + "refinements": { + "brands": [ + { + "numberOfResults": 1, + "brandName": "Truly Teague" + }, + { + "numberOfResults": 20, + "brandName": "Always Awesome Apparel" + } + ], + "categories": [ + { + "numberOfResults": 300, + "displayName": "Electronics", + "classificationId": "493964" + }, + { + "numberOfResults": 4000, + "displayName": "Tools & Home Improvement", + "classificationId": "468240" + } + ] + }, + "items": [ + { + "asin": "B07N4M94X4", + "identifiers": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "identifiers": [ + { + "type": "ean", + "identifier": "0887276302195" + }, + { + "type": "upc", + "identifier": "887276302195" + } + ] + } + ], + "images": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "images": [ + { + "variant": "MAIN", + "link": "https://m.media-amazon.com/images/I/51DZzp3w3vL.jpg", + "height": 333, + "width": 500 + } + ] + } + ], + "productTypes": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "productType": "TELEVISION" + } + ], + "salesRanks": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "ranks": [ + { + "title": "OLED TVs", + "link": "http://www.amazon.com/gp/bestsellers/electronics/6463520011", + "rank": 3 + }, + { + "title": "Electronics", + "link": "http://www.amazon.com/gp/bestsellers/electronics", + "rank": 1544 + } + ] + } + ], + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "brandName": "Samsung Electronics", + "browseNode": "6463520011", + "colorName": "Black", + "itemName": "Samsung QN82Q60RAFXZA Flat 82-Inch QLED 4K Q60 Series (2019) Ultra HD Smart TV with HDR and Alexa Compatibility", + "manufacturer": "Samsung", + "modelNumber": "QN82Q60RAFXZA", + "sizeName": "82-Inch", + "styleName": "TV only" + } + ], + "variations": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "asins": [ + "B08J7TQ9FL" + ], + "type": "PARENT" + } + ], + "vendorDetails": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "brandCode": "SAMF9", + "categoryCode": "50400100", + "manufacturerCode": "SAMF9", + "manufacturerCodeParent": "SAMF9", + "productGroup": "Home Entertainment", + "replenishmentCategory": "NEW_PRODUCT", + "subcategoryCode": "50400150" + } + ] + } + ] + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + } + }, + "response": { + "numberOfResults": 12247, + "pagination": { + "nextToken": "9HkIVcuuPmX_bm51o3-igBfN45pxW4Ru7ElIM6GCECYCuXJKzT26f-AlJJZYjIPp8wkOEmQdma1wt_JvE7qiRmNsKy7hH" + }, + "refinements": { + "brands": [ + { + "numberOfResults": 91, + "brandName": "Polo Ralph Lauren" + }, + { + "numberOfResults": 79, + "brandName": "Eddie Bauer" + }, + { + "numberOfResults": 46, + "brandName": "Cutter & Buck" + }, + { + "numberOfResults": 39, + "brandName": "FILA" + }, + { + "numberOfResults": 37, + "brandName": "Orvis" + } + ], + "classifications": [ + { + "numberOfResults": 1243, + "displayName": "Clothing, Shoes & Jewelry", + "classificationId": "7141124011" + }, + { + "numberOfResults": 126, + "displayName": "Sports & Outdoors", + "classificationId": "3375301" + } + ] + }, + "items": [ + { + "asin": "B002N36Q3M", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "brandName": "Fred Perry", + "colorName": "Wht/Brt Red/Nvy", + "itemName": "Fred Perry Men's Twin Tipped Polo Shirt-M1200, WHT/BRT RED/NVY, X-Large", + "manufacturer": "Fred Perry Men's Apparel", + "modelNumber": "M1200", + "sizeName": "X-Large", + "styleName": "Twin Tipped Polo Shirt-m1200" + } + ] + }, + { + "asin": "B002N3ABSI", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "brandName": "Fred Perry", + "colorName": "White/Bright Red/Navy", + "itemName": "Fred Perry Men's Twin Tipped Polo, White/Bright Red/Navy, SM", + "manufacturer": "Fred Perry Apparel Mens", + "modelNumber": "M1200-748", + "sizeName": "SM", + "styleName": "Twin Tipped Fred Perry Polo" + } + ] + }, + { + "asin": "B01N5B3598", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "brandName": "NHL", + "colorName": "Red", + "itemName": "NHL New Jersey Devils Men's Polo, Small, Red", + "manufacturer": "Knight's Apparel", + "modelNumber": "H0MEE3ZAMZ", + "sizeName": "Small" + } + ] + }, + { + "asin": "B00HIVDUXI", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "brandName": "adidas", + "colorName": "Bold Red/White", + "itemName": "Adidas Golf Men's Puremotion Textured Stripe Polo, Bold Red/White, Large", + "manufacturer": "TaylorMade - Adidas Golf Apparel", + "modelNumber": "TM3010S4", + "sizeName": "Large" + } + ] + }, + { + "asin": "B005ZZ12YS", + "summaries": [ + { + "marketplaceId": "ATVPDKIKX0DER", + "brandName": "RALPH LAUREN", + "colorName": "Black / Red Pony", + "itemName": "Polo Ralph Lauren Men's Long-sleeved T-shirt / Sleepwear / Thermal in Black, Red Pony (Large / L)", + "sizeName": "Large" + } + ] + } + ] + } + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "404": { + "description": "The resource specified does not exist.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + } + } + } + }, "/catalog/2020-12-01/items/{asin}": { "get": { "tags": [ @@ -59,7 +598,7 @@ }, { "name": "includedData", - "description": "A comma-delimited list of data sets to include in the response.", + "description": "A comma-delimited list of data sets to include in the response. Default: summaries.", "in": "query", "required": false, "type": "array", @@ -78,7 +617,7 @@ "x-docgen-enum-table-extension": [ { "value": "attributes", - "description": "A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners." + "description": "A JSON object containing structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners and conform to the related Amazon product type definitions available in the Selling Partner API for Product Type Definitions." }, { "value": "identifiers", @@ -113,6 +652,14 @@ "collectionFormat": "csv", "x-example": "summaries", "default": "summaries" + }, + { + "name": "locale", + "description": "Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.", + "in": "query", + "required": false, + "type": "string", + "x-example": "en_US" } ], "responses": { @@ -349,6 +896,10 @@ "404": { "description": "The resource specified does not exist.", "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" @@ -521,14 +1072,14 @@ "type": "string" }, "ItemAttributes": { - "description": "A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners.", + "description": "A JSON object that contains structured item attribute data keyed by attribute name. Catalog item attributes are available only to brand owners and conform to the related product type definitions available in the Selling Partner API for Product Type Definitions.", "additionalProperties": true, "type": "object" }, "ItemIdentifiers": { "description": "Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.", "items": { - "$ref" : "#/definitions/ItemIdentifiersByMarketplace" + "$ref": "#/definitions/ItemIdentifiersByMarketplace" }, "type": "array" }, @@ -955,6 +1506,115 @@ "marketplaceId" ], "type": "object" + }, + "ItemSearchResults": { + "description": "Items in the Amazon catalog and search related metadata.", + "properties": { + "numberOfResults": { + "description": "The estimated total number of products matched by the search query (only results up to the page count limit will be returned per request regardless of the number found).\n\nNote: The maximum number of items (ASINs) that can be returned and paged through is 1000.", + "type": "integer" + }, + "pagination": { + "description": "If available, the nextToken and/or previousToken values required to return paginated results.", + "$ref": "#/definitions/Pagination" + }, + "refinements": { + "$ref": "#/definitions/Refinements" + }, + "items": { + "description": "A list of items from the Amazon catalog.", + "type": "array", + "items": { + "$ref": "#/definitions/Item" + } + } + }, + "required": [ + "numberOfResults", + "pagination", + "refinements", + "items" + ], + "type": "object" + }, + "Pagination": { + "description": "When a request produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. When you receive the last page, there will be no nextToken key in the pagination object.", + "properties": { + "nextToken": { + "description": "A token that can be used to fetch the next page.", + "type": "string" + }, + "previousToken": { + "description": "A token that can be used to fetch the previous page.", + "type": "string" + } + }, + "type": "object" + }, + "Refinements": { + "description": "Search refinements.", + "properties": { + "brands": { + "description": "Brand search refinements.", + "type": "array", + "items": { + "$ref": "#/definitions/BrandRefinement" + } + }, + "classifications": { + "description": "Classification search refinements.", + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationRefinement" + } + } + }, + "required": [ + "brands", + "classifications" + ], + "type": "object" + }, + "BrandRefinement": { + "description": "Description of a brand that can be used to get more fine-grained search results.", + "properties": { + "numberOfResults": { + "description": "The estimated number of results that would still be returned if refinement key applied.", + "type": "integer" + }, + "brandName": { + "description": "Brand name. For display and can be used as a search refinement.", + "type": "string" + } + }, + "required": [ + "numberOfResults", + "brandName" + ], + "type": "object" + }, + "ClassificationRefinement": { + "description": "Description of a classification that can be used to get more fine-grained search results.", + "properties": { + "numberOfResults": { + "description": "The estimated number of results that would still be returned if refinement key applied.", + "type": "integer" + }, + "displayName": { + "description": "Display name for the classification.", + "type": "string" + }, + "classificationId": { + "description": "Identifier for the classification that can be used for search refinement purposes.", + "type": "string" + } + }, + "required": [ + "numberOfResults", + "displayName", + "classificationId" + ], + "type": "object" } } -} \ No newline at end of file +} diff --git a/models/listings-items-api-model/listingsItems_2020-09-01.json b/models/listings-items-api-model/listingsItems_2020-09-01.json new file mode 100644 index 0000000..f731f65 --- /dev/null +++ b/models/listings-items-api-model/listingsItems_2020-09-01.json @@ -0,0 +1,941 @@ +{ + "swagger": "2.0", + "info": { + "description": "The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API.", + "version": "2020-09-01", + "title": "Selling Partner API for Listings Items", + "contact": { + "name": "Selling Partner API Developer Support", + "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" + }, + "license": { + "name": "Apache License 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "host": "sellingpartnerapi-na.amazon.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/listings/2020-09-01/items/{sellerId}/{sku}": { + "delete": { + "tags": [ + "listings" + ], + "description": "Delete a listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "deleteListingsItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sellerId", + "description": "A selling partner identifier, such as a merchant account or vendor code.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "sku", + "description": "A selling partner provided identifier for an Amazon listing.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "marketplaceIds", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "ATVPDKIKX0DER" + }, + { + "name": "issueLocale", + "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", + "in": "query", + "required": false, + "type": "string", + "x-example": "en_US" + } + ], + "responses": { + "200": { + "description": "Successfully understood the listings item delete request. See the response to determine whether the submission has been accepted.", + "schema": { + "$ref": "#/definitions/ListingsItemSubmissionResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "examples": { + "application/json": { + "sku":"GM-ZDPI-9B4E", + "status":"ACCEPTED", + "submissionId":"f1dc2914-75dd-11ea-bc55-0242ac130003", + "issues":[] + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + } + }, + "response": { + "sku": "GM-ZDPI-9B4E", + "status": "ACCEPTED", + "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", + "issues": [] + } + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "sku": { + "value": "BadSKU" + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + } + } + }, + "patch": { + "tags": [ + "listings" + ], + "description": "Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "patchListingsItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sellerId", + "description": "A selling partner identifier, such as a merchant account or vendor code.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "sku", + "description": "A selling partner provided identifier for an Amazon listing.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "marketplaceIds", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "ATVPDKIKX0DER" + }, + { + "name": "issueLocale", + "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", + "in": "query", + "required": false, + "type": "string", + "x-example": "en_US" + }, + { + "name": "body", + "description": "The request body schema for the patchListingsItem operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListingsItemPatchRequest" + } + } + ], + "responses": { + "200": { + "description": "Successfully understood the listings item patch request. See the response to determine if the submission was accepted.", + "schema": { + "$ref": "#/definitions/ListingsItemSubmissionResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "examples": { + "application/json": { + "sku":"GM-ZDPI-9B4E", + "status":"ACCEPTED", + "submissionId":"f1dc2914-75dd-11ea-bc55-0242ac130003", + "issues":[] + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "body": { + } + } + }, + "response": { + "sku": "GM-ZDPI-9B4E", + "status": "ACCEPTED", + "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", + "issues": [] + } + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "sku": { + "value": "BadSKU" + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + } + } + }, + "put": { + "tags": [ + "listings" + ], + "description": "Creates a new or fully-updates an existing listings item for a selling partner.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "putListingsItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sellerId", + "description": "A selling partner identifier, such as a merchant account or vendor code.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "sku", + "description": "A selling partner provided identifier for an Amazon listing.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "marketplaceIds", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "ATVPDKIKX0DER" + }, + { + "name": "issueLocale", + "description": "A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". Localized messages default to \"en_US\" when a localization is not available in the specified locale.", + "in": "query", + "required": false, + "type": "string", + "x-example": "en_US" + }, + { + "name": "body", + "description": "The request body schema for the putListingsItem operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListingsItemPutRequest" + } + } + ], + "responses": { + "200": { + "description": "Successfully understood the request to create or fully-update a listings item. See the response to determine if the submission has been accepted.", + "schema": { + "$ref": "#/definitions/ListingsItemSubmissionResponse" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "examples": { + "application/json": { + "sku":"GM-ZDPI-9B4E", + "status":"ACCEPTED", + "submissionId":"f1dc2914-75dd-11ea-bc55-0242ac130003", + "issues":[] + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "body": { + } + } + }, + "response": { + "sku": "GM-ZDPI-9B4E", + "status": "ACCEPTED", + "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", + "issues": [] + } + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "sku": { + "value": "BadSKU" + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "headers": { + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "headers": { + "x-amzn-RateLimit-Limit": { + "description": "Your rate limit (requests per second) for this operation.", + "type": "string" + }, + "x-amzn-RequestId": { + "description": "Unique request reference identifier.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ErrorList" + } + } + } + } + } + }, + "definitions": { + "Error": { + "description": "Error response returned when the request is unsuccessful.", + "properties": { + "code": { + "description": "An error code that identifies the type of error that occurred.", + "type": "string" + }, + "message": { + "description": "A message that describes the error condition.", + "type": "string" + }, + "details": { + "description": "Additional details that can help the caller understand or fix the issue.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ], + "type": "object" + }, + "ErrorList": { + "description": "A list of error responses returned when a request is unsuccessful.", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + }, + "required": [ + "errors" + ] + }, + "Issue": { + "description": "An issue with a listings item.", + "properties": { + "code": { + "description": "An issue code that identifies the type of issue.", + "type": "string" + }, + "message": { + "description": "A message that describes the issue.", + "type": "string" + }, + "severity": { + "description": "The severity of the issue.", + "enum": [ + "ERROR", + "WARNING", + "INFO" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ERROR", + "description": "Indicates an issue has occurred preventing the submission from processing, such as a validation error." + }, + { + "value": "WARNING", + "description": "Indicates an issue has occurred that should be reviewed, but has not prevented the submission from processing." + }, + { + "value": "INFO", + "description": "Indicates additional information has been provided that should be reviewed." + } + ], + "type": "string" + }, + "attributeName": { + "description": "Name of the attribute associated with the issue, if applicable.", + "type": "string" + } + }, + "required": [ + "code", + "message", + "severity" + ], + "type": "object" + }, + "PatchOperation": { + "description": "Individual JSON Patch operation for an HTTP PATCH request.", + "properties": { + "op": { + "description": "Type of JSON Patch operation. Supported JSON Patch operations include add, replace, and delete. See .", + "enum": [ + "add", + "replace", + "delete" + ], + "x-docgen-enum-table-extension": [ + { + "value": "add", + "description": "The \"add\" operation adds or replaces the target property." + }, + { + "value": "replace", + "description": "The \"replace\" operation adds or replaces the target property." + }, + { + "value": "delete", + "description": "The \"delete\" operation removes the target property." + } + ], + "type": "string" + }, + "path": { + "description": "JSON Pointer path of the element to patch. See .", + "type": "string" + }, + "value": { + "description": "JSON value to add, replace, or delete.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + }, + "required": [ + "op", + "path" + ], + "type": "object" + }, + "ListingsItemPatchRequest": { + "description": "The request body schema for the patchListingsItem operation.", + "properties": { + "productType": { + "description": "The Amazon product type of the listings item.", + "type": "string" + }, + "patches": { + "description": "One or more JSON Patch operations to perform on the listings item.", + "type": "array", + "items": { + "$ref": "#/definitions/PatchOperation" + }, + "minItems": 1 + } + }, + "required": [ + "productType", + "patches" + ], + "type": "object" + }, + "ListingsItemPutRequest": { + "description": "The request body schema for the putListingsItem operation.", + "properties": { + "productType": { + "description": "The Amazon product type of the listings item.", + "type": "string" + }, + "requirements": { + "description": "The name of the requirements set for the provided data.", + "enum": [ + "LISTING", + "LISTING_PRODUCT_ONLY", + "LISTING_OFFER_ONLY" + ], + "x-docgen-enum-table-extension": [ + { + "value": "LISTING", + "description": "Indicates the submitted data contains product facts and sales terms." + }, + { + "value": "LISTING_PRODUCT_ONLY", + "description": "Indicates the submitted data contains product facts only." + }, + { + "value": "LISTING_OFFER_ONLY", + "description": "Indicates the submitted data contains sales terms only." + } + ], + "type": "string" + }, + "attributes": { + "description": "JSON object containing structured listings item attribute data keyed by attribute name.", + "type": "object", + "additionalProperties": true + } + }, + "required": [ + "productType", + "attributes" + ], + "type": "object" + }, + "ListingsItemSubmissionResponse": { + "description": "Response containing the results of a submission to the Selling Partner API for Listings Items.", + "properties": { + "sku": { + "description": "A selling partner provided identifier for an Amazon listing.", + "type": "string" + }, + "status": { + "description": "The status of the listings item submission.", + "enum": [ + "ACCEPTED", + "INVALID" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ACCEPTED", + "description": "The listings submission was accepted for processing." + }, + { + "value": "INVALID", + "description": "The listings submission was not valid and was not accepted for processing." + } + ], + "type": "string" + }, + "submissionId": { + "description": "The unique identifier of the listings item submission.", + "type": "string" + }, + "issues": { + "description": "Listings item issues related to the listings item submission.", + "type": "array", + "items": { + "$ref": "#/definitions/Issue" + } + } + }, + "required": [ + "sku", + "status", + "submissionId" + ], + "type": "object" + } + } +} \ No newline at end of file diff --git a/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json b/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json new file mode 100644 index 0000000..802315d --- /dev/null +++ b/models/product-type-definitions-api-model/definitionsProductTypes_2020-09-01.json @@ -0,0 +1,1077 @@ +{ + "swagger": "2.0", + "info": { + "description": "The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds).", + "version": "2020-09-01", + "title": "Selling Partner API for Product Type Definitions", + "contact": { + "name": "Selling Partner API Developer Support", + "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" + }, + "license": { + "name": "Apache License 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "host": "sellingpartnerapi-na.amazon.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/definitions/2020-09-01/productTypes": { + "get": { + "tags": [ + "definitions" + ], + "description": "Search for and return a list of Amazon product types that have definitions available.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "searchDefinitionsProductTypes", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "keywords", + "in": "query", + "description": "A comma-delimited list of keywords to search product types by.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "LUGGAGE" + }, + { + "name": "marketplaceIds", + "in": "query", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "ATVPDKIKX0DER" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a list of Amazon product types that have definitions available.", + "schema": { + "$ref": "#/definitions/ProductTypeList" + }, + "examples": { + "application/json": { + "productTypes": [ + { + "name": "LUGGAGE", + "marketplaceIds": [ + "ATVPDKIKX0DER" + ] + } + ] + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": {} + }, + "response": { + "productTypes": [ + { + "name": "LUGGAGE", + "marketplaceIds": [ + "ATVPDKIKX0DER" + ] + } + ] + } + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "keywords": { + "value": [ + "Invalid Request" + ] + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + }, + "parameters": [] + }, + "/definitions/2020-09-01/productTypes/{productType}": { + "get": { + "tags": [ + "definitions" + ], + "description": "Retrieve an Amazon product type definition.\n\n**Usage Plans:**\n\n| Plan type | Rate (requests per second) | Burst |\n| ---- | ---- | ---- |\n|Default| 5 | 10 |\n|Selling partner specific| Variable | Variable |\n\nThe x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.", + "operationId": "getDefinitionsProductType", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "productType", + "in": "path", + "description": "The Amazon product type name.", + "required": true, + "type": "string", + "x-example": "LUGGAGE" + }, + { + "name": "sellerId", + "in": "query", + "description": "A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.", + "required": false, + "type": "string" + }, + { + "name": "marketplaceIds", + "in": "query", + "description": "A comma-delimited list of Amazon marketplace identifiers for the request.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "x-example": "ATVPDKIKX0DER" + }, + { + "name": "productTypeVersion", + "in": "query", + "description": "The version of the Amazon product type to retrieve. Defaults to \"LATEST\",. Prerelease versions of product type definitions may be retrieved with \"RELEASE_CANDIDATE\". If no prerelease version is currently available, the \"LATEST\" live version will be provided.", + "required": false, + "type": "string", + "default": "LATEST", + "x-example": "LATEST" + }, + { + "name": "requirements", + "in": "query", + "description": "The name of the requirements set to retrieve requirements for.", + "required": false, + "type": "string", + "default": "LISTING", + "enum": [ + "LISTING", + "LISTING_PRODUCT_ONLY", + "LISTING_OFFER_ONLY" + ], + "x-docgen-enum-table-extension": [ + { + "value": "LISTING", + "description": "Request schema containing product facts and sales terms." + }, + { + "value": "LISTING_PRODUCT_ONLY", + "description": "Request schema containing product facts only." + }, + { + "value": "LISTING_OFFER_ONLY", + "description": "Request schema containing sales terms only." + } + ], + "x-example": "LISTING" + }, + { + "name": "requirementsEnforced", + "in": "query", + "description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates).", + "required": false, + "type": "string", + "default": "ENFORCED", + "enum": [ + "ENFORCED", + "NOT_ENFORCED" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ENFORCED", + "description": "Request schema with required and conditionally required attributes enforced (used for full payload validation)." + }, + { + "value": "NOT_ENFORCED", + "description": "Request schema with required and conditionally required attributes not enforced (used for partial payload validation, such as for single attributes)." + } + ], + "x-example": "ENFORCED" + }, + { + "name": "locale", + "in": "query", + "description": "Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.", + "required": false, + "type": "string", + "default": "DEFAULT", + "enum": [ + "DEFAULT", + "ar", + "ar_AE", + "de", + "de_DE", + "en", + "en_AE", + "en_AU", + "en_CA", + "en_GB", + "en_IN", + "en_SG", + "en_US", + "es", + "es_ES", + "es_MX", + "es_US", + "fr", + "fr_CA", + "fr_FR", + "it", + "it_IT", + "ja", + "ja_JP", + "nl", + "nl_NL", + "pl", + "pl_PL", + "pt", + "pt_BR", + "pt_PT", + "sv", + "sv_SE", + "tr", + "tr_TR", + "zh", + "zh_CN", + "zh_TW" + ], + "x-docgen-enum-table-extension": [ + { + "value": "DEFAULT", + "description": "Default locale of the requested Amazon marketplace." + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "ar_AE", + "description": "Arabic (U.A.E.)" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "de_DE", + "description": "German (Germany)" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "en_AE", + "description": "English (U.A.E.)" + }, + { + "value": "en_AU", + "description": "English (Australia)" + }, + { + "value": "en_CA", + "description": "English (Canada)" + }, + { + "value": "en_GB", + "description": "English (United Kingdom)" + }, + { + "value": "en_IN", + "description": "English (India)" + }, + { + "value": "en_SG", + "description": "English (Singapore)" + }, + { + "value": "en_US", + "description": "English (United States)" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "es_ES", + "description": "Spanish (Spain)" + }, + { + "value": "es_MX", + "description": "Spanish (Mexico)" + }, + { + "value": "es_US", + "description": "Spanish (United States)" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "fr_CA", + "description": "French (Canada)" + }, + { + "value": "fr_FR", + "description": "French (France)" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "it_IT", + "description": "Italian (Italy)" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ja_JP", + "description": "Japanese (Japan)" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "nl_NL", + "description": "Dutch (Netherlands)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pl_PL", + "description": "Polish (Poland)" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pt_BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "pt_PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "sv_SE", + "description": "Swedish (Sweden)" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "tr_TR", + "description": "Turkish (Turkey)" + }, + { + "value": "zh", + "description": "Chinese" + }, + { + "value": "zh_CN", + "description": "Chinese (Simplified)" + }, + { + "value": "zh_TW", + "description": "Chinese (Traditional)" + } + ], + "x-example": "DEFAULT" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved an Amazon product type definition.", + "schema": { + "$ref": "#/definitions/ProductTypeDefinition" + }, + "examples": { + "application/json": { + "metaSchema": { + "link": { + "resource": "https://meta-schema-url", + "verb": "GET" + }, + "checksum": "c7af9479ca7261645cea9db56c5f720d" + }, + "schema": { + "link": { + "resource": "https://schema-url", + "verb": "GET" + }, + "checksum": "c7af9479ca7261645cea9db56c5f720d" + }, + "requirements": "LISTING", + "requirementsEnforced": "ENFORCED", + "propertyGroups": { + "product_identity": { + "title": "Product Identity", + "description": "Information to uniquely identify your product (e.g., UPC, EAN, GTIN, Product Type, Brand)", + "propertyNames": [ + "item_name", + "brand", + "external_product_id", + "gtin_exemption_reason", + "merchant_suggested_asin", + "product_type", + "product_category", + "product_subcategory", + "item_type_keyword" + ] + } + }, + "locale": "en_US", + "marketplaceIds": [ + "ATVPDKIKX0DER" + ], + "productType": "LUGGAGE", + "productTypeVersion": { + "version": "UHqSqmb4FNUk=", + "latest": true, + "releaseCandidate": false + } + } + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": {} + }, + "response": { + "metaSchema": { + "link": { + "resource": "https://meta-schema-url", + "verb": "GET" + }, + "checksum": "c7af9479ca7261645cea9db56c5f720d" + }, + "schema": { + "link": { + "resource": "https://schema-url", + "verb": "GET" + }, + "checksum": "c7af9479ca7261645cea9db56c5f720d" + }, + "requirements": "LISTING", + "requirementsEnforced": "ENFORCED", + "propertyGroups": { + "product_identity": { + "title": "Product Identity", + "description": "Information to uniquely identify your product (e.g., UPC, EAN, GTIN, Product Type, Brand)", + "propertyNames": [ + "item_name", + "brand", + "external_product_id", + "gtin_exemption_reason", + "merchant_suggested_asin", + "product_type", + "product_category", + "product_subcategory", + "item_type_keyword" + ] + } + }, + "locale": "en_US", + "marketplaceIds": [ + "ATVPDKIKX0DER" + ], + "productType": "LUGGAGE", + "productTypeVersion": { + "version": "UHqSqmb4FNUk=", + "latest": true, + "releaseCandidate": false + } + } + } + ] + }, + "400": { + "description": "Request has missing or invalid parameters and cannot be parsed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + }, + "x-amazon-spds-sandbox-behaviors": [ + { + "request": { + "parameters": { + "productType": { + "value": "INVALID" + } + } + }, + "response": { + "errors": [ + { + "code": "BAD_REQUEST", + "message": "Invalid input", + "details": "Invalid input" + } + ] + } + } + ] + }, + "403": { + "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "404": { + "description": "The resource specified does not exist.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "413": { + "description": "The request size exceeded the maximum accepted size.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "415": { + "description": "The request payload is in an unsupported format.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "429": { + "description": "The frequency of requests was greater than allowed.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "500": { + "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + }, + "503": { + "description": "Temporary overloading or maintenance of the server.", + "schema": { + "$ref": "#/definitions/ErrorList" + }, + "headers": { + "x-amzn-RateLimit-Limit": { + "type": "string", + "description": "Your rate limit (requests per second) for this operation." + }, + "x-amzn-RequestId": { + "type": "string", + "description": "Unique request reference identifier." + } + } + } + } + }, + "parameters": [] + } + }, + "definitions": { + "Error": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "An error code that identifies the type of error that occurred." + }, + "message": { + "type": "string", + "description": "A message that describes the error condition." + }, + "details": { + "type": "string", + "description": "Additional details that can help the caller understand or fix the issue." + } + }, + "description": "Error response returned when the request is unsuccessful." + }, + "ErrorList": { + "type": "object", + "required": [ + "errors" + ], + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + }, + "description": "A list of error responses returned when a request is unsuccessful." + }, + "SchemaLink": { + "type": "object", + "required": [ + "checksum", + "link" + ], + "properties": { + "link": { + "type": "object", + "description": "Link to retrieve the schema.", + "properties": { + "resource": { + "type": "string", + "description": "URI resource for the link." + }, + "verb": { + "type": "string", + "description": "HTTP method for the link operation.", + "enum": [ + "GET" + ], + "x-docgen-enum-table-extension": [ + { + "value": "GET", + "description": "The provided resource is accessed with the HTTP GET method." + } + ] + } + }, + "required": [ + "resource", + "verb" + ] + }, + "checksum": { + "type": "string", + "description": "Checksum hash of the schema (Base64 MD5). Can be used to verify schema contents, identify changes between schema versions, and for caching." + } + } + }, + "ProductTypeDefinition": { + "type": "object", + "required": [ + "locale", + "marketplaceIds", + "productType", + "productTypeVersion", + "propertyGroups", + "requirements", + "requirementsEnforced", + "schema" + ], + "properties": { + "metaSchema": { + "description": "Link to meta-schema describing the vocabulary used by the product type schema.", + "$ref": "#/definitions/SchemaLink" + }, + "schema": { + "description": "Link to schema describing the attributes and requirements for the product type.", + "$ref": "#/definitions/SchemaLink" + }, + "requirements": { + "type": "string", + "description": "Name of the requirements set represented in this product type definition.", + "enum": [ + "LISTING", + "LISTING_PRODUCT_ONLY", + "LISTING_OFFER_ONLY" + ], + "x-docgen-enum-table-extension": [ + { + "value": "LISTING", + "description": "Indicates the schema contains product facts and sales terms." + }, + { + "value": "LISTING_PRODUCT_ONLY", + "description": "Indicates the schema data contains product facts only." + }, + { + "value": "LISTING_OFFER_ONLY", + "description": "Indicates the schema data contains sales terms only." + } + ] + }, + "requirementsEnforced": { + "type": "string", + "description": "Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all of the required attributes being present (such as for partial updates).", + "enum": [ + "ENFORCED", + "NOT_ENFORCED" + ], + "x-docgen-enum-table-extension": [ + { + "value": "ENFORCED", + "description": "Schema enforces required and conditionally required attributes (used for full payload validation)." + }, + { + "value": "NOT_ENFORCED", + "description": "Schema does not enforce required and conditionally required attributes (used for partial payload validation, such as for single attributes)." + } + ] + }, + "propertyGroups": { + "type": "object", + "description": "Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes.", + "additionalProperties": { + "$ref": "#/definitions/PropertyGroup" + } + }, + "locale": { + "type": "string", + "description": "Locale of the display elements contained in the product type definition." + }, + "marketplaceIds": { + "type": "array", + "description": "Amazon marketplace identifiers for which the product type definition is applicable.", + "items": { + "type": "string" + } + }, + "productType": { + "type": "string", + "description": "The name of the Amazon product type that this product type definition applies to." + }, + "productTypeVersion": { + "description": "The version details for the Amazon product type.", + "$ref": "#/definitions/ProductTypeVersion" + } + }, + "description": "A product type definition represents the attributes and data requirements for a product type in the Amazon catalog. Product type definitions are used interchangeably between the Selling Partner API for Listings Items, Selling Partner API for Catalog Items, and JSON-based listings feeds in the Selling Partner API for Feeds." + }, + "PropertyGroup": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The display label of the property group." + }, + "description": { + "type": "string", + "description": "The description of the property group." + }, + "propertyNames": { + "type": "array", + "description": "The names of the schema properties for the property group.", + "items": { + "type": "string" + } + } + }, + "description": "A property group represents a logical grouping of schema properties that can be used for display or informational purposes." + }, + "ProductTypeVersion": { + "type": "object", + "required": [ + "latest", + "version" + ], + "properties": { + "version": { + "type": "string", + "description": "Version identifier." + }, + "latest": { + "type": "boolean", + "description": "When true, the version indicated by the version identifier is the latest available for the Amazon product type." + }, + "releaseCandidate": { + "type": "boolean", + "description": "When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type." + } + }, + "description": "The version details for an Amazon product type." + }, + "ProductType": { + "type": "object", + "required": [ + "marketplaceIds", + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the Amazon product type." + }, + "marketplaceIds": { + "type": "array", + "description": "The Amazon marketplace identifiers for which the product type definition is available.", + "items": { + "type": "string" + } + } + }, + "description": "An Amazon product type with a definition available." + }, + "ProductTypeList": { + "type": "object", + "required": [ + "productTypes" + ], + "properties": { + "productTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ProductType" + } + } + }, + "description": "A list of Amazon product types with definitions available." + } + } +} \ No newline at end of file