Amazon SP API

confirmShipment

Tested

POST

/orders/v0/orders/{orderId}/shipmentConfirmation

Orders

Last modified:2024-11-29 11:51:02

Maintainer:Sarath S

Updates the shipment confirmation status for a specified order.

Usage Plan:

Rate (requests per second)	Burst
2	10

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:

902-1106328-1059050

Body Params application/json

The request schema for an shipment confirmation.

packageDetail

object (PackageDetail)

required

Properties of packages

packageReferenceId

string

required

A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.

carrierCode

string

required

Identifies the carrier that will deliver the package. This field is required for all marketplaces. For more information, refer to the CarrierCode announcement.

carrierName

string

optional

Carrier Name that will deliver the package. Required when carrierCode is "Others"

shippingMethod

string

optional

Ship method to be used for shipping the order.

trackingNumber

string

required

The tracking number used to obtain tracking and delivery information.

shipDate

string <date-time>

required

The shipping date for the package. Must be in ISO 8601 date/time format.

shipFromSupplySourceId

string

optional

The unique identifier for the supply source.

orderItems

array[object (ConfirmShipmentOrderItem) {3}]

required

A list of order items.

codCollectionMethod

enum<string>

optional

The COD collection method (only supported in the JP marketplace).

Allowed value:

DirectPayment

marketplaceId

string

required

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

Example

{
    "marketplaceId": "ATVPDKIKX0DER",
    "packageDetail": {
        "packageReferenceId": "1",
        "carrierCode": "FedEx",
        "carrierName": "FedEx",
        "shippingMethod": "FedEx Ground",
        "trackingNumber": "112345678",
        "shipDate": "2022-02-11T01:00:00.000Z",
        "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
        "orderItems": [
            {
                "orderItemId": "79039765272157",
                "quantity": 1,
                "transparencyCodes": [
                    "09876543211234567890"
                ]
            }
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/orders/v0/orders/902-1106328-1059050/shipmentConfirmation' \
--header 'Content-Type: application/json' \
--data-raw '{
    "marketplaceId": "ATVPDKIKX0DER",
    "packageDetail": {
        "packageReferenceId": "1",
        "carrierCode": "FedEx",
        "carrierName": "FedEx",
        "shippingMethod": "FedEx Ground",
        "trackingNumber": "112345678",
        "shipDate": "2022-02-11T01:00:00.000Z",
        "shipFromSupplySourceId": "057d3fcc-b750-419f-bbcd-4d340c60c430",
        "orderItems": [
            {
                "orderItemId": "79039765272157",
                "quantity": 1,
                "transparencyCodes": [
                    "09876543211234567890"
                ]
            }
        ]
    }
}'

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

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

updateVerificationStatus

ProductPricing