getCompetitivePricing

Tested

GET

/products/pricing/v0/competitivePrice

productPricing

Last modified:2024-12-12 05:09:27

Maintainer:Not configured

Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN.

Note: The parameters associated with this operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding.

Usage Plan:

Rate (requests per second)	Burst
0.5	1

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

Query Params

MarketplaceId

string

required

A marketplace identifier. Specifies the marketplace for which prices are returned.

Example:

Asins

array[string]

optional

A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.

<= 20 items

Skus

array[string]

optional

A list of up to twenty seller SKU values used to identify items in the given marketplace.

<= 20 items

ItemType

enum<string>

required

Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku.

Allowed values:

AsinSku

Example:

Asin

CustomerType

enum<string>

optional

Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.

Allowed values:

ConsumerBusiness

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/products/pricing/v0/competitivePrice?MarketplaceId={{MARKET_USA}}&Asins&Skus&ItemType=Asin&CustomerType'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference ID.

Body

The response schema for the `getPricing` and `getCompetitivePricing` operations.

payload

array[object (Price) {3}]

optional

<= 20 items

listingPrice

object (MoneyType)

required

Currency type and monetary value schema to demonstrate pricing information.

shippingPrice

object (MoneyType)

optional

Currency type and monetary value schema to demonstrate pricing information.

points

object (Points)

optional

The number of Amazon Points that are offered with the purchase of an item and the monetary value of these points.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": [
        {
            "listingPrice": {
                "currencyCode": "string",
                "amount": 0
            },
            "shippingPrice": {
                "currencyCode": "string",
                "amount": 0
            },
            "points": {
                "pointsNumber": 0,
                "pointsMonetaryValue": {
                    "currencyCode": "string",
                    "amount": 0
                }
            }
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

getPricing

getListingOffers