Amazon SP API

updateShipmentStatus

Tested

POST

/orders/v0/orders/{orderId}/shipment

Orders

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
5	15

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:

Body Params application/json

The request body for the `updateShipmentStatus` operation.

marketplaceId

string

required

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

shipmentStatus

enum<string>

required

The shipment status.

Allowed values:

PurchasedRefundPendingRefundRejectedRefundApplied

orderItems

array [object {2}]

optional

For partial shipment status updates, the list of order items and quantities to be updated.

orderItemId

string

optional

The order item's unique identifier.

quantity

integer

optional

The quantity for which to update the shipment status.

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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

object {0}

Example

{}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

getOrderItemsBuyerInfo

getOrderRegulatedInfo