Amazon SP API
  1. Orders
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
    • getCatalogItem
    • listCatalogCategories
  • 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
      GET
    • getOrder
      GET
    • getOrderBuyerInfo
      GET
    • getOrderAddress
      GET
    • getOrderItems
      GET
    • getOrderItemsBuyerInfo
      GET
    • updateShipmentStatus
      POST
    • getOrderRegulatedInfo
      GET
    • updateVerificationStatus
      PATCH
    • confirmShipment
      POST
  • ProductPricing
    • deprecated
      • getPricing
      • getCompetitivePricing
      • getListingOffers
      • getItemOffers
      • getItemOffersBatch
      • getListingOffersBatch
    • getFeaturedOfferExpectedPriceBatch
    • getCompetitiveSummary
  • 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. Orders

getOrderItemsBuyerInfo

Tested
GET
/orders/v0/orders/{orderId}/orderItems/buyerInfo
Orders
Last modified:2024-11-29 11:38:58
Maintainer:Sarath S
Returns buyer information for the order items in the order that you specify.
Usage Plan:
Rate (requests per second)Burst
0.530
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were 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 then those shown here. For more information, refer to Usage Plans and Rate Limits.

Request

Path Params
orderId
string 
required
An Amazon-defined order identifier, in 3-7-7 format.
Example:
{{SUCCESS}}
Query Params
NextToken
string 
optional
A string token returned in the response of your previous request.

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 -g --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/orders/v0/orders/{{SUCCESS}}/orderItems/buyerInfo?NextToken'

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 `getOrderItemsBuyerInfo` operation.
payload
object (OrderItemsBuyerInfoList) 
optional
A single order item's buyer information list with the order ID.
OrderItems
array[object (OrderItemBuyerInfo) {6}] 
required
A single order item's buyer information list.
NextToken
string 
optional
When present and not empty, pass this string token in the next request to return the next response page.
AmazonOrderId
string 
required
An Amazon-defined order identifier, in 3-7-7 format.
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": {
        "OrderItemId": "903-1671087-0812628",
        "BuyerCustomizedInfo": {
            "CustomizedURL": "https://zme-caps.amazon.com/t/bR6qHkzSOxuB/J8nbWhze0Bd3DkajkOdY-XQbWkFralegp2sr_QZiKEE/1"
        },
        "GiftMessageText": "For you!",
        "GiftWrapPrice": {
            "CurrencyCode": "JPY",
            "Amount": "1.99"
        },
        "GiftWrapLevel": "Classic"
    }
}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠429429
🔴500Server Error
🔴503Service Unavailable
Previous
getOrderItems
Next
updateShipmentStatus
Built with