UNPKG

node-red-contrib-rollun-aws-sp-api

Version:

Node-RED nodes to access AWS Selling Partner API

1,284 lines (1,283 loc) 142 kB
{ "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.\n\nFor more information, see the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide).", "version": "2021-08-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/2021-08-01/items/{sellerId}/{sku}": { "delete": { "tags": [ "listings" ], "description": "Delete a listings item for a selling partner.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "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", "maxItems": 1, "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-amzn-api-sandbox": { "static": [ { "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-amzn-api-sandbox": { "static": [ { "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-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "get": { "tags": [ "listings" ], "description": "Returns details about a listings item for a selling partner.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getListingsItem", "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", "maxItems": 1, "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": "includedData", "description": "A comma-delimited list of data sets to include in the response. Default: `summaries`.", "in": "query", "required": false, "type": "array", "items": { "enum": [ "summaries", "attributes", "issues", "offers", "fulfillmentAvailability", "procurement", "relationships", "productTypes" ], "x-docgen-enum-table-extension": [ { "value": "summaries", "description": "Summary details of the listing item." }, { "value": "attributes", "description": "A JSON object containing structured listing item attribute data keyed by attribute name." }, { "value": "issues", "description": "The issues associated with the listing item." }, { "value": "offers", "description": "The current offers for the listing item." }, { "value": "fulfillmentAvailability", "description": "The fulfillment availability details for the listing item." }, { "value": "procurement", "description": "Vendor procurement details for the listing item. " }, { "value": "relationships", "description": "Relationship details for a listing item (for example, variations)." }, { "value": "productTypes", "description": "Product types that are associated with a listing item." } ], "type": "string" }, "collectionFormat": "csv", "x-example": "summaries", "default": [ "summaries" ] } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Item" }, "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", "summaries": [ { "marketplaceId": "ATVPDKIKX0DER", "asin": "B071VG5N9D", "productType": "LUGGAGE", "conditionType": "new_new", "status": [ "BUYABLE" ], "itemName": "Hardside Carry-On Spinner Suitcase Luggage", "createdDate": "2021-02-01T00:00:00Z", "lastUpdatedDate": "2021-03-01T00:00:00Z", "mainImage": { "link": "https://www.example.com/luggage.png", "height": 500, "width": 500 } } ], "offers": [ { "marketplaceId": "ATVPDKIKX0DER", "offerType": "B2C", "price": { "currencyCode": "USD", "amount": "100.00" }, "audience": { "value": "ALL", "displayName": "Sell on Amazon" } } ], "fulfillmentAvailability": [ { "fulfillmentChannelCode": "DEFAULT", "quantity": 100 } ], "issues": [ { "code": "90220", "message": "'size' is required but not supplied.", "severity": "ERROR", "attributeNames": [ "size" ], "categories": [ "MISSING_ATTRIBUTE" ] }, { "code": "18027", "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", "severity": "ERROR", "categories": [ "INVALID_IMAGE" ], "enforcements": { "actions": [ { "action": "SEARCH_SUPPRESSED" } ], "exemption": { "status": "EXEMPT_UNTIL_EXPIRY_DATE", "expiryDate": "2025-05-28T00:36:48.914Z" } } }, { "code": "99300", "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", "severity": "ERROR", "categories": [], "enforcements": { "actions": [ { "action": "ATTRIBUTE_SUPPRESSED" } ], "exemption": { "status": "EXEMPT" } } }, { "code": "18155", "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", "severity": "ERROR", "categories": [ "INVALID_PRICE" ], "enforcements": { "actions": [ { "action": "LISTING_SUPPRESSED" } ], "exemption": { "status": "NOT_EXEMPT" } } }, { "code": "18742", "message": "Restricted Products Policy Violation", "severity": "ERROR", "categories": [], "enforcements": { "actions": [ { "action": "CATALOG_ITEM_REMOVED" } ], "exemption": { "status": "NOT_EXEMPT" } } } ] } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": {} } }, "response": { "sku": "GM-ZDPI-9B4E", "summaries": [ { "marketplaceId": "ATVPDKIKX0DER", "asin": "B071VG5N9D", "productType": "LUGGAGE", "conditionType": "new_new", "status": [ "BUYABLE" ], "itemName": "Hardside Carry-On Spinner Suitcase Luggage", "createdDate": "2021-02-01T00:00:00Z", "lastUpdatedDate": "2021-03-01T00:00:00Z", "mainImage": { "link": "https://www.example.com/luggage.png", "height": 500, "width": 500 } } ], "offers": [ { "marketplaceId": "ATVPDKIKX0DER", "offerType": "B2C", "price": { "currencyCode": "USD", "amount": "100.00" }, "audience": { "value": "ALL", "displayName": "Sell on Amazon" } } ], "fulfillmentAvailability": [ { "fulfillmentChannelCode": "DEFAULT", "quantity": 100 } ], "issues": [ { "code": "90220", "message": "'size' is required but not supplied.", "severity": "ERROR", "attributeNames": [ "size" ], "categories": [ "MISSING_ATTRIBUTE" ] }, { "code": "18027", "message": "We believe the main image has text, logo, graphic or watermark which is not permitted for this product type. Please submit a compliant image to lift the suppression. Also refer to Product image requirements.", "severity": "ERROR", "categories": [ "INVALID_IMAGE" ], "enforcements": { "actions": [ { "action": "SEARCH_SUPPRESSED" } ], "exemption": { "status": "EXEMPT_UNTIL_EXPIRY_DATE", "expiryDate": "2025-05-28T00:36:48.914Z" } } }, { "code": "99300", "message": "Product Detail Page Rules Violation (Inaccurate information on product detail page)", "severity": "ERROR", "categories": [], "enforcements": { "actions": [ { "action": "ATTRIBUTE_SUPPRESSED" } ], "exemption": { "status": "EXEMPT" } } }, { "code": "18155", "message": "The 'minimum price' is greater than the selling price (excluding shipping) for the listing. Please review and update your price and/or minimum price.", "severity": "ERROR", "categories": [ "INVALID_PRICE" ], "enforcements": { "actions": [ { "action": "LISTING_SUPPRESSED" } ], "exemption": { "status": "NOT_EXEMPT" } } }, { "code": "18742", "message": "Restricted Products Policy Violation", "severity": "ERROR", "categories": [], "enforcements": { "actions": [ { "action": "CATALOG_ITEM_REMOVED" } ], "exemption": { "status": "NOT_EXEMPT" } } } ] } } ] } }, "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-amzn-api-sandbox": { "static": [ { "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" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "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 Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 5 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) 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", "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: `issues`.", "in": "query", "required": false, "type": "array", "items": { "enum": [ "identifiers", "issues" ], "x-docgen-enum-table-extension": [ { "value": "identifiers", "description": "Identifiers associated with the item in the Amazon catalog, such as Amazon Standard Identification Number (ASIN). Can only be requested when `mode` is `VALIDATION_PREVIEW`." }, { "value": "issues", "description": "The issues associated with the listing item." } ], "type": "string" }, "collectionFormat": "csv", "x-example": "issues", "default": [ "issues" ] }, { "name": "mode", "description": "The mode of operation for the request.", "in": "query", "enum": [ "VALIDATION_PREVIEW" ], "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ], "required": false, "type": "string", "x-example": "VALIDATION_PREVIEW" }, { "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-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": {} } }, "response": { "sku": "GM-ZDPI-9B4E", "status": "ACCEPTED", "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", "issues": [] } }, { "request": { "parameters": { "sku": { "value": "VALIDATION_VALID" }, "marketplaceIds": { "value": [ "ATVPDKIKX0DER" ] }, "includedData": { "value": [ "identifiers", "issues" ] }, "mode": { "value": "VALIDATION_PREVIEW" } } }, "response": { "sku": "VALIDATION_VALID", "status": "VALID", "submissionId": "1edc94ea-a3d7-210b-42bc-0ec72c1384762", "identifiers": [ { "marketplaceId": "ATVPDKIKX0DER", "asin": "B07N4M94X4" } ], "issues": [] } }, { "request": { "parameters": { "sku": { "value": "VALIDATION_INVALID" }, "marketplaceIds": { "value": [ "ATVPDKIKX0DER" ] }, "includedData": { "value": [ "identifiers", "issues" ] }, "mode": { "value": "VALIDATION_PREVIEW" } } }, "response": { "sku": "VALIDATION_INVALID", "status": "INVALID", "submissionId": "a1c562c2-1695-11ee-be56-0242ac120002", "identifiers": [], "issues": [ { "code": "90000900", "message": "The attributes are invalid.", "severity": "ERROR", "attributeNames": [ "fake_attribute" ], "categories": [ "INVALID_ATTRIBUTE" ], "enforcements": { "actions": [ { "action": "ATTRIBUTE_SUPPRESSED" } ], "exemption": { "status": "NOT_EXEMPT" } } } ] } } ] } }, "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-amzn-api-sandbox": { "static": [ { "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-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "put": { "tags": [ "listings" ], "description": "Creates or fully updates an existing listings item for a selling partner.\n\n**Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`.\n\n**Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully call the API. To avoid errors with SKUs when encoding URLs, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\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, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "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", "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: `issues`.", "in": "query", "required": false, "type": "array", "items": { "enum": [ "identifiers", "issues" ], "x-docgen-enum-table-extension": [ { "value": "identifiers", "description": "Identifiers associated with the item in the Amazon catalog, such as Amazon Standard Identification Number (ASIN). Can only be requested when `mode` is `VALIDATION_PREVIEW`." }, { "value": "issues", "description": "The issues associated with the listing item." } ], "type": "string" }, "collectionFormat": "csv", "x-example": "issues", "default": [ "issues" ] }, { "name": "mode", "description": "The mode of operation for the request.", "in": "query", "enum": [ "VALIDATION_PREVIEW" ], "x-docgen-enum-table-extension": [ { "value": "VALIDATION_PREVIEW", "description": "Indicates the submitted data should be validated using the values provided in the payload and validation errors the selling partner account may face. This will synchronously perform the same checks that are preformed on submissions after being accepted for processing, but without persisting to the selling partner's catalog." } ], "required": false, "type": "string", "x-example": "VALIDATION_PREVIEW" }, { "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-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": {} } }, "response": { "sku": "GM-ZDPI-9B4E", "status": "ACCEPTED", "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003", "issues": [] } }, { "request": { "parameters": { "sku": { "value": "VALIDATION_VALID" }, "marketplaceIds": { "value": [ "ATVPDKIKX0DER" ] }, "includedData": { "value": [ "identifiers", "issues" ] }, "mode": { "value": "VALIDATION_PREVIEW" } } }, "response": { "sku": "VALIDATION_VALID", "status": "VALID", "submissionId": "1edc94ea-a3d7-210b-42bc-0ec72c1384762", "identifiers": [ { "marketplaceId": "ATVPDKIKX0DER", "asin": "B07N4M94X4" } ], "issues": [] } }, { "request": { "parameters": { "sku": { "value": "VALIDATION_INVALID" }, "marketplaceIds": { "value": [ "ATVPDKIKX0DER" ] }, "includedData": { "value": [ "identifiers", "issues" ] }, "mode": {