"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 [Listing Items API Use Case Guide](doc:listings-items-api-v2020-09-01-use-case-guide).",
"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).",
"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.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"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**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).",
"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.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Creates a new or fully-updates an existing 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).",
"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.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned.",
"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 <https://tools.ietf.org/html/rfc6902>.",
"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."
"description":"The \"delete\" operation removes the target property. Not supported for vendors (vendors will receive an HTTP status code 400 response)."
"description":"Indicates the submitted data contains sales terms only. Not supported for vendors (vendors will receive an HTTP status code 400 response)."