Amazon SP API
  1. deprecated
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
    • getDefinitionsProductType
  • 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
        GET
      • getCompetitivePricing
        GET
      • getListingOffers
        GET
      • getItemOffers
        GET
      • getItemOffersBatch
        POST
      • getListingOffersBatch
        POST
    • 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. deprecated

getListingOffersBatch

POST
/batches/products/pricing/v0/listingOffers
productPricing
Last modified:2024-12-12 05:12:08
Maintainer:Not configured
Returns the lowest priced offers for a batch of listings by SKU.
Usage Plan:
Rate (requests per second)Burst
0.51
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

Body Params application/json
The request associated with the `getListingOffersBatch` API call.
requests
array[object (ListingOffersRequest) {7}] 
optional
A list of getListingOffers batched requests to run.
>= 1 items<= 20 items
uri
string 
required
The URI associated with an individual request within a batch. For FeaturedOfferExpectedPrice, this is /products/pricing/2022-05-01/offer/featuredOfferExpectedPrice.
method
enum<string> 
HttpMethod
required
The HTTP method associated with an individual request within a batch.
Allowed values:
GETPUTPATCHDELETEPOST
body
HttpBody
optional
Additional HTTP body information that is associated with an individual request within a batch.
headers
object 
HttpHeaders
optional
A mapping of additional HTTP headers to send or receive for an individual request within a batch.
MarketplaceId
string 
MarketplaceId
required
A marketplace identifier. Specifies the marketplace for which data is returned.
ItemCondition
enum<string> 
ItemCondition
required
Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.
Allowed values:
NewUsedCollectibleRefurbishedClub
CustomerType
enum<string> 
CustomerType
optional
Indicates whether to request Consumer or Business offers. Default is Consumer.
Allowed values:
ConsumerBusiness
Example
{
    "requests": [
        {
            "uri": "string",
            "method": "GET",
            "body": {
                "property1": null,
                "property2": null
            },
            "headers": {
                "property1": "string",
                "property2": "string"
            },
            "MarketplaceId": "string",
            "ItemCondition": "New",
            "CustomerType": "Consumer"
        }
    ]
}

Request 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/v0/listingOffers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requests": [
        {
            "uri": "string",
            "method": "GET",
            "body": {
                "property1": null,
                "property2": null
            },
            "headers": {
                "property1": "string",
                "property2": "string"
            },
            "MarketplaceId": "string",
            "ItemCondition": "New",
            "CustomerType": "Consumer"
        }
    ]
}'

Responses

🟢200OK
application/json
Indicates that requests were run in batch. Check the batch response status lines for information on whether a batch request succeeded.
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 associated with the `getListingOffersBatch` API call.
responses
array[object (ListingOffersResponse) {4}] 
optional
A list of getListingOffers batched responses.
>= 1 items<= 20 items
headers
object 
HttpResponseHeaders
optional
A mapping of additional HTTP headers to send/receive for the individual batch request.
status
object 
GetOffersHttpStatusLine
optional
The HTTP status line associated with the response. For more information, consult RFC 2616.
body
object 
GetOffersResponse
required
The response schema for the getListingOffers and getItemOffers operations.
request
object 
ListingOffersRequestParams
optional
Example
{
    "responses": [
        {
            "headers": {
                "Date": "string",
                "x-amzn-RequestId": "string",
                "property1": "string",
                "property2": "string"
            },
            "status": {
                "statusCode": 100,
                "reasonPhrase": "string"
            },
            "body": {
                "payload": {
                    "MarketplaceID": "string",
                    "ASIN": "string",
                    "SKU": "string",
                    "ItemCondition": "New",
                    "status": "string",
                    "Identifier": {
                        "identifierType": "string",
                        "identifier": "string"
                    },
                    "Summary": {
                        "TotalOfferCount": 0,
                        "NumberOfOffers": [
                            {
                                "condition": "string",
                                "fulfillmentChannel": "Amazon",
                                "OfferCount": 0
                            }
                        ],
                        "LowestPrices": [
                            {
                                "condition": "string",
                                "fulfillmentChannel": "string",
                                "offerType": "B2C",
                                "quantityTier": 0,
                                "quantityDiscountType": "QUANTITY_DISCOUNT",
                                "LandedPrice": {
                                    "currencyCode": "string",
                                    "amount": 0
                                },
                                "ListingPrice": {
                                    "currencyCode": "string",
                                    "amount": 0
                                },
                                "Shipping": {
                                    "currencyCode": "string",
                                    "amount": 0
                                },
                                "Points": {
                                    "pointsNumber": 0,
                                    "pointsMonetaryValue": {
                                        "currencyCode": "string",
                                        "amount": 0
                                    }
                                }
                            }
                        ],
                        "BuyBoxPrices": [
                            {
                                "condition": "string",
                                "offerType": "B2C",
                                "quantityTier": 0,
                                "quantityDiscountType": "QUANTITY_DISCOUNT",
                                "LandedPrice": {
                                    "currencyCode": "string",
                                    "amount": 0
                                },
                                "ListingPrice": {
                                    "currencyCode": "string",
                                    "amount": 0
                                },
                                "Shipping": {
                                    "currencyCode": "string",
                                    "amount": 0
                                },
                                "Points": {
                                    "pointsNumber": 0,
                                    "pointsMonetaryValue": {
                                        "currencyCode": "string",
                                        "amount": 0
                                    }
                                },
                                "sellerId": "string"
                            }
                        ],
                        "ListPrice": {
                            "currencyCode": "string",
                            "amount": 0
                        },
                        "CompetitivePriceThreshold": {
                            "currencyCode": "string",
                            "amount": 0
                        },
                        "SuggestedLowerPricePlusShipping": {
                            "currencyCode": "string",
                            "amount": 0
                        },
                        "SalesRankings": [
                            {
                                "ProductCategoryId": "string",
                                "Rank": 0
                            }
                        ],
                        "BuyBoxEligibleOffers": [
                            {
                                "condition": "string",
                                "fulfillmentChannel": "Amazon",
                                "OfferCount": 0
                            }
                        ],
                        "OffersAvailableTime": "2019-08-24T14:15:22Z"
                    },
                    "Offers": [
                        {
                            "MyOffer": true,
                            "offerType": "B2C",
                            "SubCondition": "string",
                            "SellerId": "string",
                            "ConditionNotes": "string",
                            "SellerFeedbackRating": {
                                "SellerPositiveFeedbackRating": 0,
                                "FeedbackCount": 0
                            },
                            "ShippingTime": {
                                "minimumHours": 0,
                                "maximumHours": 0,
                                "availableDate": "string",
                                "availabilityType": "NOW"
                            },
                            "ListingPrice": {
                                "currencyCode": "string",
                                "amount": 0
                            },
                            "quantityDiscountPrices": [
                                {
                                    "quantityTier": 0,
                                    "quantityDiscountType": "QUANTITY_DISCOUNT",
                                    "listingPrice": {
                                        "currencyCode": "string",
                                        "amount": 0
                                    }
                                }
                            ],
                            "Points": {
                                "pointsNumber": 0,
                                "pointsMonetaryValue": {
                                    "currencyCode": "string",
                                    "amount": 0
                                }
                            },
                            "Shipping": {
                                "currencyCode": "string",
                                "amount": 0
                            },
                            "ShipsFrom": {
                                "State": "string",
                                "Country": "string"
                            },
                            "IsFulfilledByAmazon": true,
                            "PrimeInformation": {
                                "IsPrime": true,
                                "IsNationalPrime": true
                            },
                            "IsBuyBoxWinner": true,
                            "IsFeaturedMerchant": true
                        }
                    ]
                },
                "errors": [
                    {
                        "code": "string",
                        "message": "string",
                        "details": "string"
                    }
                ]
            },
            "request": {
                "MarketplaceId": "string",
                "ItemCondition": "New",
                "CustomerType": "Consumer",
                "SellerSKU": "string"
            }
        }
    ]
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠429429
🔴500Server Error
🔴503Service Unavailable
Previous
getItemOffersBatch
Next
getFeaturedOfferExpectedPriceBatch
Built with