Amazon SP API
  1. ProductPricing
Amazon SP API
  • Overview
  • Authorization Workflow
  • Permissions
  • Sandbox
  • API Models
  • Available API Models
  • Request Apidog Access
  • OPENAPI SPECIFICATION
  • Research Docs
    • Amazon Seller Order Fulfillment Workflow
  • Amazon Warehousing and Distribution
    • getInboundShipment
      GET
    • listInboundShipments
      GET
    • listInventory
      GET
  • Authorization
    • Authorization
      POST
  • Catalog Items
    • searchCatalogItems
      GET
    • getCatalogItem
      GET
  • Catalog [Deprecated]
    • listCatalogItems
      GET
    • getCatalogItem
      GET
    • listCatalogCategories
      GET
  • Definitions
    • searchDefinitionsProductTypes
      GET
    • getDefinitionsProductType
      GET
  • Easy Ship
    • listHandoverSlots
    • getScheduledPackage
    • createScheduledPackage
    • updateScheduledPackages
    • createScheduledPackageBulk
  • FBAInbound
    • listInboundPlans
    • createInboundPlan
    • getInboundPlan
    • listInboundPlanBoxes
    • cancelInboundPlan
    • listInboundPlanItems
    • updateInboundPlanName
    • listPackingGroupBoxes
    • listPackingGroupItems
    • setPackingInformation
    • listPackingOptions
    • generatePackingOptions
    • confirmPackingOption
    • listInboundPlanPallets
    • listPlacementOptions
    • generatePlacementOptions
    • confirmPlacementOption
    • getShipment
    • listShipmentBoxes
    • listShipmentContentUpdatePreviews
    • generateShipmentContentUpdatePreviews
    • getShipmentContentUpdatePreview
    • confirmShipmentContentUpdatePreview
    • getDeliveryChallanDocument
    • listDeliveryWindowOptions
    • generateDeliveryWindowOptions
    • confirmDeliveryWindowOptions
    • listShipmentItems
    • updateShipmentName
    • listShipmentPallets
    • cancelSelfShipAppointment
    • getSelfShipAppointmentSlots
    • generateSelfShipAppointmentSlots
    • scheduleSelfShipAppointment
    • updateShipmentSourceAddress
    • updateShipmentTrackingDetails
    • listTransportationOptions
    • generateTransportationOptions
    • confirmTransportationOptions
    • listItemComplianceDetails
    • updateItemComplianceDetails
    • createMarketplaceItemLabels
    • listPrepDetails
    • setPrepDetails
    • getInboundOperationStatus
    • getItemEligibilityPreview
  • FBAInventory
    • getInventorySummaries
    • createInventoryItem
    • deleteInventoryItem
    • addInventory
  • FBAOutbound
    • getFulfillmentPreview
    • deliveryOffers
    • listAllFulfillmentOrders
    • createFulfillmentOrder
    • getPackageTrackingDetails
    • listReturnReasonCodes
    • createFulfillmentReturn
    • getFulfillmentOrder
    • updateFulfillmentOrder
    • cancelFulfillmentOrder
    • submitFulfillmentOrderStatusUpdate
    • getFeatures
    • getFeatureInventory
    • getFeatureSKU
  • Feeds
    • getFeeds
    • createFeed
    • cancelFeed
    • getFeed
    • createFeedDocument
    • getFeedDocument
  • Fees
    • getMyFeesEstimateForSKU
    • getMyFeesEstimateForASIN
    • getMyFeesEstimates
  • Finance
    • listTransactions
    • listFinancialEventGroups
    • listFinancialEventsByGroupId
    • listFinancialEventsByOrderId
    • listFinancialEvents
  • Invoices [Brazil]
    • getInvoicesAttributes
    • getInvoicesDocument
    • createInvoicesExport
    • getInvoicesExports
    • getInvoicesExport
    • getInvoices
    • getInvoice
  • Listings Items
    • getListingsRestrictions
    • deleteListingsItem
    • getListingsItem
    • patchListingsItem
    • putListingsItem
  • Merchant Fulfillment
    • getEligibleShipmentServices
    • getShipment
    • cancelShipment
    • createShipment
    • getAdditionalSellerInputs
  • Orders
    • getOrders
    • getOrder
    • getOrderBuyerInfo
    • getOrderAddress
    • getOrderItems
    • getOrderItemsBuyerInfo
    • updateShipmentStatus
    • getOrderRegulatedInfo
    • updateVerificationStatus
    • confirmShipment
  • ProductPricing
    • deprecated
      • getPricing
      • getCompetitivePricing
      • getListingOffers
      • getItemOffers
      • getItemOffersBatch
      • getListingOffersBatch
    • getFeaturedOfferExpectedPriceBatch
      POST
    • getCompetitiveSummary
      POST
  • Reports
    • getReports
    • createReport
    • cancelReport
    • getReport
    • getReportSchedules
    • createReportSchedule
    • cancelReportSchedule
    • getReportSchedule
    • getReportDocument
  • Sales
    • getOrderMetrics
  • Sellers
    • getMarketplaceParticipations
    • getAccount
  • Service
    • getServiceJobByServiceJobId
    • cancelServiceJobByServiceJobId
    • completeServiceJobByServiceJobId
    • getServiceJobs
    • addAppointmentForServiceJobByServiceJobId
    • rescheduleAppointmentForServiceJobByServiceJobId
    • assignAppointmentResources
    • setAppointmentFulfillmentData
    • getRangeSlotCapacity
    • getFixedSlotCapacity
    • updateSchedule
    • createReservation
    • updateReservation
    • cancelReservation
    • getAppointmmentSlotsByJobId
    • getAppointmentSlots
    • createServiceDocumentUploadDestination
  • ShipmentInvoice[Brazil]
    • getShipmentDetails
    • submitInvoice
    • getInvoiceStatus
  • Shipping
    • getRates
    • createShipment
    • directPurchaseShipment
    • getShipment
    • purchaseShipment
    • cancelShipment
    • oneClickShipment
    • purchaseLabels
    • getTracking
    • retrieveShippingLabel
    • getShipmentDocuments
    • purchaseShipment
    • cancelShipment
    • getRates
    • getAdditionalInputs
    • getAccount
    • getCarrierAccountFormInputs
    • getTrackingInformation
    • getCarrierAccounts
    • linkCarrierAccount
    • unlinkCarrierAccount
    • generateCollectionForm
    • getCollectionFormHistory
    • getUnmanifestedShipments
    • getCollectionForm
    • getAccessPoints
  • Supply Sources
    • getSupplySources
    • createSupplySource
    • getSupplySource
    • updateSupplySource
    • archiveSupplySource
    • updateSupplySourceStatus
  • Tokens
    • createRestrictedDataToken
  • Uploads
    • createUploadDestinationForResource
  • Notifications
    • getSubscription
    • createSubscription
    • getSubscriptionById
    • deleteSubscriptionById
    • getDestinations
    • createDestination
    • getDestination
    • deleteDestination
  1. ProductPricing

getCompetitiveSummary

Tested
POST
/batches/products/pricing/2022-05-01/items/competitiveSummary
Last modified:2024-12-12 05:16:56
Maintainer:Not configured
Returns the competitive summary response, including featured buying options for the ASIN and marketplaceId combination.
Usage Plan:
Rate (requests per second)Burst
0.0331
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

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 Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/batches/products/pricing/2022-05-01/items/competitiveSummary' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
        }
    ]
}'

Responses

🟢200OK
application/json
Success.
Headers

Body

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
Modified at 2024-12-12 05:16:56
Previous
getFeaturedOfferExpectedPriceBatch
Next
getReports
Built with