purchaseLabels - Amazon SP API

Purchase shipping labels based on a given rate.

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

Path Params

shipmentId

string

required

Body Params application/json

The request schema for the purchaseLabels operation.

rateId

string

required

An identifier for the rating.

labelSpecification

object (LabelSpecification)

required

The label specification info.

labelFormat

enum<string>

required

The format of the label. Enum of PNG only for now.

Allowed value:

PNG

labelStockSize

enum<string>

required

The label stock size specification in length and height. Enum of 4x6 only for now.

Allowed value:

4x6

Example

{
    "rateId": "string",
    "labelSpecification": {
        "labelFormat": "PNG",
        "labelStockSize": "4x6"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 id.

Body

The response schema for the purchaseLabels operation.

payload

object (PurchaseLabelsResult)

optional

The payload schema for the purchaseLabels operation.

shipmentId

string

required

An Amazon-defined shipment identifier.

clientReferenceId

string

optional

Client reference id.

<= 40 characters

acceptedRate

object (AcceptedRate)

required

The specific rate purchased for the shipment, or null if unpurchased.

labelResults

array[object (LabelResult) {3}]

required

A list of label results

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

{
    "shipmentId": "89108749065090",
    "clientReferenceId": "911-7267646-6348616",
    "acceptedRate": {
        "billedWeight": {
            "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