getCompetitiveSummary - Amazon SP API

Returns the competitive summary response, including featured buying options for the ASIN and marketplaceId combination.

Usage Plan:

Rate (requests per second)	Burst
0.033	1

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Request

Body Params application/json

The `competitiveSummary` batch request data.

requests

array[object (CompetitiveSummaryRequest) {6}]

required

A batched list of competitiveSummary requests.

>= 1 items<= 20 items

asin

string

required

The ASIN of the item.

marketplaceId

string

required

A marketplace identifier. Specifies the marketplace for which data is returned.

includedData

array[string]

required

The list of requested competitive pricing data for the product.

>= 1 items

Allowed values:

featuredBuyingOptionsreferencePriceslowestPricedOffers

lowestPricedOffersInputs

array[object (LowestPricedOffersInput) {2}]

optional

The list of lowestPricedOffersInput parameters that are used to build lowestPricedOffers in the response. This attribute is only valid if lowestPricedOffers is requested in includedData

>= 0 items<= 5 items

method

enum<string>

required

The HTTP method associated with an individual request within a batch.

Allowed values:

GETPUTPATCHDELETEPOST

uri

string

required

The URI associated with the individual APIs that are called as part of the batch request.

>= 6 characters<= 512 characters

Example

{
    "requests": [
        {
            "asin": "B00ZIAODGE",
            "marketplaceId": "ATVPDKIKX0DER",
            "includedData": [
                "featuredBuyingOptions",
                "referencePrices",
                "lowestPricedOffers"
            ],
            "lowestPricedOffersInputs": [
                {
                    "itemCondition": "New",
                    "offerType": "Consumer"
                },
                {
                    "itemCondition": "Used",
                    "offerType": "Consumer"
                }
            ],
            "uri": "/products/pricing/2022-05-01/items/competitiveSummary",
            "method": "GET"
        },
        {
            "asin": "11_AABB_123",
            "marketplaceId": "ATVPDKIKX0DER",
            "includedData": [
                "featuredBuyingOptions"
            ],
            "uri": "/products/pricing/2022-05-01/items/competitiveSummary",
            "method": "GET"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Body

The response schema for the `competitiveSummaryBatch` operation.

responses

array[object (CompetitiveSummaryResponse) {2}]

required

The response list for the competitiveSummaryBatch operation.

>= 1 items<= 20 items

status

object (HttpStatusLine)

required

The HTTP status line associated with the response for an individual request within a batch. For more information, refer to RFC 2616.

body

object (CompetitiveSummaryResponseBody)

required

The competitiveSummaryResponse body for a requested ASIN and marketplaceId.

Example

{
    "responses": [
        {
            "status": {
                "statusCode": 200,
                "reasonPhrase": "Success"
            },
            "body": {
                "asin": "B00ZIAODGE",
                "marketplaceId": "ATVPDKIKX0DER",
                "featuredBuyingOptions": [
                    {
                        "buyingOptionType": "New",
                        "segmentedFeaturedOffers": [
                            {
                                "sellerId": "A3DJR8M9Y3OUPG",
                                "condition": "New",
                                "fulfillmentType": "MFN",
                                "listingPrice": {
                                    "amount": 18.11,
                                    "currencyCode": "USD"
                                },
                                "shippingOptions": [
                                    {
                                        "shippingOptionType": "DEFAULT",
                                        "price": {
                                            "amount": 2.5,
                                            "currencyCode": "USD"
                                        }
                                    }
                                ],
                                "points": {
                                    "pointsNumber": 3,
                                    "pointsMonetaryValue": {
                                        "amount": 0.03,
                                        "currencyCode": "USD"
                                    }
                                },
                                "featuredOfferSegments": [
                                    {
                                        "customerMembership": "PRIME",
                                        "segmentDetails": {
                                            "glanceViewWeightPercentage": 72
                                        }
                                    },
                                    {
                                        "customerMembership": "NON_PRIME",
                                        "segmentDetails": {
                                            "glanceViewWeightPercentage": 18
                                        }
                                    }
                                ]
                            },
                            {
                                "sellerId": "A2ZWOLFOFDPJL1",
                                "condition": "New",
                                "fulfillmentType": "MFN",
                                "listingPrice": {
                                    "amount": 17.15,
                                    "currencyCode": "USD"
                                },
                                "shippingOptions": [
                                    {
                                        "shippingOptionType": "DEFAULT",
                                        "price": {
                                            "amount": 2.5,
                                            "currencyCode": "USD"
                                        }
                                    }
                                ],
                                "points": {
                                    "pointsNumber": 3,
                                    "pointsMonetaryValue": {
                                        "amount": 0.03,
                                        "currencyCode": "USD"
                                    }
                                },
                                "featuredOfferSegments": [
                                    {
                                        "customerMembership": "NON_PRIME",
                                        "segmentDetails": {
                                            "glanceViewWeightPercentage": 10
                                        }
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "referencePrices": [
                    {
                        "name": "CompetitivePriceThreshold",
                        "price": {
                            "amount": 18.11,
                            "currencyCode": "USD"
                        }
                    },
                    {
                        "name": "WasPrice",
                        "price": {
                            "amount": 18.49,
                            "currencyCode": "USD"
                        }
                    }
                ],
                "lowestPricedOffers": [
                    {
                        "lowestPricedOffersInput": {
                            "itemCondition": "New",
                            "offerType": "Consumer"
                        },
                        "offers": [
                            {
                                "listingPrice": {
                                    "currencyCode": "USD",
                                    "amount": 17.15
                                },
                                "shippingOptions": [
                                    {
                                        "shippingOptionType": "DEFAULT",
                                        "price": {
                                            "amount": 2.5,
                                            "currencyCode": "USD"
                                        }
                                    }
                                ],
                                "points": {
                                    "pointsMonetaryValue": {
                                        "amount": 0.5,
                                        "currencyCode": "USD"
                                    },
                                    "pointsNumber": 50
                                },
                                "primeDetails": {
                                    "eligibility": "REGIONAL"
                                },
                                "subCondition": "New",
                                "sellerId": "A2ZWOLFOFDPJL1",
                                "fulfillmentType": "MFN"
                            },
                            {
                                "listingPrice": {
                                    "amount": 18.11,
                                    "currencyCode": "USD"
                                },
                                "shippingOptions": [
                                    {
                                        "shippingOptionType": "DEFAULT",
                                        "price": {
                                            "amount": 2.5,
                                            "currencyCode": "USD"
                                        }
                                    }
                                ],
                                "points": {
                                    "pointsNumber": 3,
                                    "pointsMonetaryValue": {
                                        "amount": 0.03,
                                        "currencyCode": "USD"
                                    }
                                },
                                "primeDetails": {
                                    "eligibility": "NATIONAL"
                                },
                                "sellerId": "A3DJR8M9Y3OUPG",
                                "subCondition": "New",
                                "fulfillmentType": "MFN"
                            }
                        ]
                    },
                    {
                        "lowestPricedOffersInput": {
                            "itemCondition": "Used",
                            "offerType": "Consumer"
                        },
                        "offers": [
                            {
                                "listingPrice": {
                                    "CurrencyCode": "USD",
                                    "Amount": 12
                                },
                                "shippingOptions": [
                                    {
                                        "shippingOptionType": "DEFAULT",
                                        "price": {
                                            "amount": 2.5,
                                            "currencyCode": "USD"
                                        }
                                    }
                                ],
                                "primeDetails": {
                                    "eligibility": "REGIONAL"
                                },
                                "subCondition": "Acceptable",
                                "sellerId": "A3DH5AGPM3JVAB",
                                "fulfillmentType": "AFN"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable