purchaseShipment - Amazon SP API

Purchase shipping labels.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Request

Body Params application/json

Example

{
    "clientReferenceId": "string",
    "shipTo": {
        "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"
    },
    "shipFrom": {
        "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"
    },
    "shipDate": "2019-08-24T14:15:22Z",
    "serviceType": "Amazon Shipping Ground",
    "containers": [
        {
            "containerType": "PACKAGE",
            "containerReferenceId": "string",
            "value": {
                "amount": 0,
                "code": "str"
            },
            "dimensions": {
                "height": {
                    "unit": "string",
                    "value": 0
                },
                "length": {
                    "unit": "string",
                    "value": 0
                },
                "weight": {
                    "unit": "string",
                    "value": 0
                },
                "width": {
                    "unit": "string",
                    "value": 0
                }
            },
            "items": [
                {
                    "quantity": 0,
                    "unitPrice": {
                        "amount": 0,
                        "code": "str"
                    },
                    "unitWeight": {
                        "value": 11,
                        "unit": "Grams"
                    },
                    "title": "string"
                }
            ],
            "weight": {
                "value": 11,
                "unit": "Grams"
            }
        }
    ],
    "labelSpecification": {
        "labelFormat": "PNG",
        "labelStockSize": "4x6"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v1/purchaseShipment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientReferenceId": "string",
    "shipTo": {
        "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"
    },
    "shipFrom": {
        "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"
    },
    "shipDate": "2019-08-24T14:15:22Z",
    "serviceType": "Amazon Shipping Ground",
    "containers": [
        {
            "containerType": "PACKAGE",
            "containerReferenceId": "string",
            "value": {
                "amount": 0,
                "code": "str"
            },
            "dimensions": {
                "height": {
                    "unit": "string",
                    "value": 0
                },
                "length": {
                    "unit": "string",
                    "value": 0
                },
                "weight": {
                    "unit": "string",
                    "value": 0
                },
                "width": {
                    "unit": "string",
                    "value": 0
                }
            },
            "items": [
                {
                    "quantity": 0,
                    "unitPrice": {
                        "amount": 0,
                        "code": "str"
                    },
                    "unitWeight": {
                        "value": 11,
                        "unit": "Grams"
                    },
                    "title": "string"
                }
            ],
            "weight": {
                "value": 11,
                "unit": "Grams"
            }
        }
    ],
    "labelSpecification": {
        "labelFormat": "PNG",
        "labelStockSize": "4x6"
    }
}'

Responses

🟢200OK

application/json

Success.

Headers

Body

Example

{
    "shipmentId": "89108749065090",
    "serviceRate": {
        "billableWeight": {
            "value": 4,
            "unit": "kg"
        },
        "totalCharge": {
            "value": 3.5,
            "unit": "GBP"
        },
        "serviceType": "Amazon Shipping Standard",
        "promise": {
            "deliveryWindow": {
                "start": "2018-08-25T20:22:30.737Z",
                "end": "2018-08-26T20:22:30.737Z"
            },
            "receiveWindow": {
                "start": "2018-08-23T09:22:30.737Z",
                "end": "2018-08-23T11:22:30.737Z"
            }
        }
    },
    "labelResults": [
        {
            "containerReferenceId": "CRI123456789",
            "trackingId": "1512748795322",
            "label": {
                "labelStream": "iVBORw0KGgo...AAAARK5CYII=(Truncated)",
                "labelSpecification": {
                    "labelFormat": "PNG",
                    "labelStockSize": "4x6"
                }
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable