Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Amazon Warehousing and Distribution v2024-05-09

getInboundShipmentLabels

Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is GENERATED, then the label URL is available.

Usage Plan:

Rate (requests per second)Burst
12

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 indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

get/awd/2024-05-09/inboundShipments/{shipmentId}/labels

Path parameters

shipmentIdstring required

ID for the shipment.

Query parameters

pageType'PLAIN_PAPER'

Page type for the generated labels. The default is PLAIN_PAPER.

formatType'PDF'

The format type of the output file that contains your labels. The default format type is PDF.

Response

The 200 response for getInboundShipmentLabels.

labelDownloadURLstring

The URL to download shipment labels. The URL is active for 600 seconds from generation.

labelStatus'GENERATING' | 'GENERATED' | 'GENERATION_FAILED' | 'NOT_READY' required

The status of your label.