patchListingsItem

PATCH

/listings/2021-08-01/items/{sellerId}/{sku}

Listings Items

Last modified:2024-12-11 06:11:07

Maintainer:Not configured

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: This operation has a throttling rate of one request per second when mode is VALIDATION_PREVIEW.

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.

Request

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[string]

required

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

<= 1 items

Example:

ATVPDKIKX0DER

includedData

array[string]

optional

A comma-delimited list of data sets to include in the response. Default: issues.

Allowed values:

identifiersissues

Default:

issues

Example:

issues

mode

enum<string>

optional

The mode of operation for the request.

Allowed value:

VALIDATION_PREVIEW

Example:

VALIDATION_PREVIEW

issueLocale

string

optional

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.

Example:

en_US

Body Params application/json

The request body schema for the `patchListingsItem` operation.

productType

string

required

The Amazon product type of the listings item.

patches

array[object (PatchOperation) {3}]

required

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

>= 1 items

enum<string>

required

Type of JSON Patch operation. Supported JSON Patch operations include add, replace, and delete. Refer to JavaScript Object Notation (JSON) Patch for more information.

Allowed values:

addreplacedelete

path

string

required

JSON Pointer path of the element to patch. Refer to JavaScript Object Notation (JSON) Patch for more information.

value

array [object {1}]

optional

JSON value to add, replace, or delete.

Example

{
    "productType": "string",
    "patches": [
        {
            "op": "add",
            "path": "string",
            "value": [
                {}
            ]
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://sandbox.sellingpartnerapi-na.amazon.com/listings/2021-08-01/items//?marketplaceIds=ATVPDKIKX0DER' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productType": "string",
    "patches": [
        {
            "op": "add",
            "path": "string",
            "value": [
                {}
            ]
        }
    ]
}'

Responses

🟢200OK

application/json

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

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Response containing the results of a submission to the Selling Partner API for Listings Items.

sku

string

required

A selling partner provided identifier for an Amazon listing.

status

enum<string>

required

The status of the listings item submission.

Allowed values:

ACCEPTEDINVALIDVALID

submissionId

string

required

The unique identifier of the listings item submission.

issues

array[object (Issue) {6}]

optional

Listings item issues related to the listings item submission.

code

string

required

An issue code that identifies the type of issue.

message

string

required

A message that describes the issue.

severity

enum<string>

required

The severity of the issue.

Allowed values:

ERRORWARNINGINFO

attributeNames

array[string]

optional

The names of the attributes associated with the issue, if applicable.

categories

array[string]

required

List of issue categories.

Possible vales:

INVALID_ATTRIBUTE - Indicating an invalid attribute in the listing.

MISSING_ATTRIBUTE - Highlighting a missing attribute in the listing.

INVALID_IMAGE - Signifying an invalid image in the listing.

MISSING_IMAGE - Noting the absence of an image in the listing.

INVALID_PRICE - Pertaining to issues with the listing's price-related attributes.

MISSING_PRICE - Pointing out the absence of a price attribute in the listing.

DUPLICATE - Identifying listings with potential duplicate problems, such as this ASIN potentially being a duplicate of another ASIN.

QUALIFICATION_REQUIRED - Indicating that the listing requires qualification-related approval.

Example:

["INVALID_ATTRIBUTE"]

enforcements

object (IssueEnforcements)

optional

This field provides information about the enforcement actions taken by Amazon that affect the publishing or status of a listing. It also includes details about any associated exemptions.

identifiers

array[object (ItemIdentifiersByMarketplace) {2}]

optional

Identity attributes associated with the item in the Amazon catalog, such as the ASIN.

marketplaceId

string

optional

A marketplace identifier. Identifies the Amazon marketplace for the listings item.

asin

string

optional

Amazon Standard Identification Number (ASIN) of the listings item.

Example

{
    "sku": "GM-ZDPI-9B4E",
    "status": "ACCEPTED",
    "submissionId": "f1dc2914-75dd-11ea-bc55-0242ac130003",
    "issues": []
}

🟠400Bad Request

🟠403Forbidden

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

getListingsItem

putListingsItem