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

updateShipmentStatus

Tested
POST
/orders/v0/orders/{orderId}/shipment
Last modified:2024-11-29 11:39:24
Maintainer:Sarath S
Update the shipment status for an order that you specify.
Usage Plan:
Rate (requests per second)Burst
515
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

Body Params application/json

Example
{
    "marketplaceId": "string",
    "shipmentStatus": "Purchased",
    "orderItems": [
        {
            "orderItemId": "string",
            "quantity": 0
        }
    ]
}

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 -g --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/orders/v0/orders/{{SUCCESS}}/shipment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "marketplaceId": "string",
    "shipmentStatus": "Purchased",
    "orderItems": [
        {
            "orderItemId": "string",
            "quantity": 0
        }
    ]
}'

Responses

🟢204No Content
application/json
Success.
Headers

Body

Example
{}
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
🟠413413
🟠415415
🟠429429
🔴500Server Error
🔴503Service Unavailable
Modified at 2024-11-29 11:39:24
Previous
getOrderItemsBuyerInfo
Next
getOrderRegulatedInfo
Built with