patchListingsItem

patch https://sellingpartnerapi-na.amazon.com/listings/2020-09-01/items/{sellerId}/{sku}

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.

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.

Usage Plan:

Rate (requests per second)	Burst
5	10

The 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.

Path Params

sellerId

string

required

A selling partner identifier, such as a merchant account or vendor code.

sku

string

required

A selling partner provided identifier for an Amazon listing.

Query Params

marketplaceIds

array of strings

required

A comma-delimited list of Amazon marketplace identifiers for the request.

marketplaceIds*

issueLocale

string

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.

Body Params

The request body schema for the patchListingsItem operation.

productType

string

required

The Amazon product type of the listings item.

patches

array of objects

required

length ≥ 1

One or more JSON Patch operations to perform on the listings item.

patches*

string

required

Type of JSON Patch operation. Supported JSON Patch operations include add, replace, and delete. See https://tools.ietf.org/html/rfc6902.

Show Details

add	The "add" operation adds or replaces the target property.
replace	The "replace" operation adds or replaces the target property.
delete	The "delete" operation removes the target property. Not supported for vendors (vendors will receive an HTTP status code 400 response).

path

string

required

JSON Pointer path of the element to patch. See https://tools.ietf.org/html/rfc6902.

value

array of objects

JSON value to add, replace, or delete.

value

200

Successfully understood the listings item patch request. See the response to determine if the submission was accepted.

Response body

object

sku

string

required

A selling partner provided identifier for an Amazon listing.

status

string

required

The status of the listings item submission.

ACCEPTED INVALID

Show Details

ACCEPTED	The listings submission was accepted for processing.
INVALID	The listings submission was not valid and was not accepted for processing.

submissionId

string

required

The unique identifier of the listings item submission.

issues

array of objects

Listings item issues related to the listings item submission.

issues

object

code

string

required

An issue code that identifies the type of issue.

message

string

required

A message that describes the issue.

severity

string

required

The severity of the issue.

ERROR WARNING INFO

Show Details

ERROR	Indicates an issue has occurred preventing the submission from processing, such as a validation error.
WARNING	Indicates an issue has occurred that should be reviewed, but has not prevented the submission from processing.
INFO	Indicates additional information has been provided that should be reviewed.

attributeName

string

Name of the attribute associated with the issue, if applicable.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

400

Request has missing or invalid parameters and cannot be parsed.

403

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

413

The request size exceeded the maximum accepted size.

415

The request payload is in an unsupported format.

429

The frequency of requests was greater than allowed.

500

An unexpected condition occurred that prevented the server from fulfilling the request.

503

Temporary overloading or maintenance of the server.

xxxxxxxxxx
curl --request PATCH \
     --url https://sellingpartnerapi-na.amazon.com/listings/2020-09-01/items/sellerId/sku \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "patches": [
    {
      "op": "add"
    }
  ]
}
'

200Successfully understood the listings item patch request. See the response to determine if the submission was accepted.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.