getShipmentDetails

Returns the shipment details required to issue an invoice for the specified shipment.

Usage Plan:

Rate (requests per second)	Burst
1.133	25

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.

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 getShipmentDetails operation.

payload

object (ShipmentDetail)

optional

The information required by a selling partner to issue a shipment invoice.

WarehouseId

string

optional

The Amazon-defined identifier for the warehouse.

AmazonOrderId

string

optional

The Amazon-defined identifier for the order.

AmazonShipmentId

string

optional

The Amazon-defined identifier for the shipment.

PurchaseDate

string <date-time>

optional

The date and time when the order was created.

ShippingAddress

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

PaymentMethodDetails

array[string]

optional

The list of payment method details.

MarketplaceId

string

optional

The identifier for the marketplace where the order was placed.

SellerId

string

optional

The seller identifier.

BuyerName

string

optional

The name of the buyer.

BuyerCounty

string

optional

The county of the buyer.

BuyerTaxInfo

object (BuyerTaxInfo)

optional

Tax information about the buyer.

MarketplaceTaxInfo

object (MarketplaceTaxInfo)

optional

Tax information about the marketplace.

SellerDisplayName

string

optional

The seller’s friendly name registered in the marketplace.

ShipmentItems

array[object (ShipmentItem) {11}]

optional

A list of shipment items.

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": {
        "WarehouseId": "string",
        "AmazonOrderId": "string",
        "AmazonShipmentId": "string",
        "PurchaseDate": "2019-08-24T14:15:22Z",
        "ShippingAddress": {
            "addressLine1": "address_1",
            "addressLine2": "address_2",
            "addressLine3": "address_3",
            "city": "Seattle",
            "countryCode": "US",
            "county": "Washington",
            "district": "District1",
            "name": "address_name",
            "phoneNumber": "+14155552671",
            "postalCode": "123456",
            "stateOrRegion": "Washington"
        },
        "PaymentMethodDetails": [
            "string"
        ],
        "MarketplaceId": "string",
        "SellerId": "string",
        "BuyerName": "string",
        "BuyerCounty": "string",
        "BuyerTaxInfo": {
            "CompanyLegalName": "string",
            "TaxingRegion": "string",
            "TaxClassifications": [
                {
                    "Name": "string",
                    "Value": "string"
                }
            ]
        },
        "MarketplaceTaxInfo": {
            "CompanyLegalName": "string",
            "TaxingRegion": "string",
            "TaxClassifications": [
                {
                    "Name": "string",
                    "Value": "string"
                }
            ]
        },
        "SellerDisplayName": "string",
        "ShipmentItems": [
            {
                "ASIN": "string",
                "SellerSKU": "string",
                "OrderItemId": "string",
                "Title": "string",
                "QuantityOrdered": 0,
                "ItemPrice": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "ShippingPrice": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "GiftWrapPrice": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "ShippingDiscount": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "PromotionDiscount": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "SerialNumbers": [
                    "string"
                ]
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses