getShipmentDocuments - Amazon SP API

Returns the shipping documents associated with a package in a shipment.

Usage Plan:

Rate (requests per second)	Burst
80	100

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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

shipmentId

string

required

The shipment identifier originally returned by the purchaseShipment operation.

Query Params

packageClientReferenceId

string

required

The package client reference identifier originally provided in the request body parameter for the getRates operation.

format

string

optional

The file format of the document. Must be one of the supported formats returned by the getRates operation.

dpi

number

optional

The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.

Header Params

x-amzn-shipping-business-id

enum<string>

optional

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

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

Body

The response schema for the the getShipmentDocuments operation.

payload

object (GetShipmentDocumentsResult)

optional

The payload for the getShipmentDocuments operation.

shipmentId

string

required

An Amazon-defined shipment identifier.

packageDocumentDetail

object (PackageDocumentDetail)

required

The post-purchase details of a package that will be shipped using a shipping service.

Example

{
    "shipmentId": "445454-3232-3232",
    "packageDocumentDetail": {
        "packageClientReferenceId": "ASUSDI-45343854",
        "trackingId": "T1234567",
        "packageDocuments": [
            {
                "type": "LABEL",
                "format": "PNG",
                "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac=="
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable