Amazon Marketplace Web Service (MWS) will no longer be available after March 31, 2024. All MWS developers must migrate to Selling Partner API (SP-API) to avoid service disruptions. Refer to the Migration Hub for more information.
Returns package labels.
The GetPackageLabels operation returns PDF document data for printing shipping labels and carrier labels for an inbound shipment. For information about extracting PDF document data, see Extracting PDF Document Data.
The language of the address section of a shipping label is determined by the ShipFromAddress value for the shipment, which was specified with a previous call to the CreateInboundShipmentPlan operation. The language of the FC Prep instructions (if applicable) is determined by the marketplace of the Amazon fulfillment center receiving the shipment.
For Non-Amazon-partnered, Small Parcel shipments, use the NumberOfPackages parameter to specify the number of boxes in your shipment. The GetPackageLabels operation returns a shipping label with a unique barcode for every box in your shipment.
For Amazon-partnered, Small Parcel shipments, the GetPackageLabels operation returns a carrier label and a shipping label for each box in your shipment. The NumberOfPackages parameter is not required; if you include the NumberOfPackages parameter it is ignored. The number of boxes in your shipment was specified with your call to the PutTransportContent operation.
For LTL/FTL shipments, regardless of whether they are Amazon-partnered or non-Amazon-partnered, use the NumberOfPackages parameter to indicate the number of shipping labels that you want for your shipment. You will need one shipping label for every box in your shipment, plus one for each of the four sides of each of your shrink-wrapped pallets. Unlike the unique shipping labels that are returned for a Small Parcel shipment, the shipping labels that are returned for a LTL/FTL shipment are identical.
This operation is available in all marketplaces except Brazil.
The GetPackageLabels operation has a maximum request quota of 30 and a restore rate of two requests every second. For definitions of throttling terminology and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.
For more information about the request parameters that are required for all Amazon MWS operations, see Required request parameters in the Amazon MWS Developer Guide.
Name | Description | Required | Values |
---|---|---|---|
ShipmentId | A shipment identifier originally returned by the CreateInboundShipmentPlan operation. | Yes | Type: xs:string |
PageType | The page type that you want to print the labels on. | Yes | PageType values:
Submitting a PageType value that is not supported in your marketplace returns an error. Type: xs:string |
NumberOfPackages | Indicates the number of packages in the shipment. | No. Required only for non-Amazon-partnered, Small Parcel shipments. For Amazon-partnered, Small Parcel shipments, the NumberOfPackages value is ignored and the information provided in a previous call to the PutTransportContent operation is used. |
Type: xs:int |
Name | Description |
---|---|
TransportDocument | PDF document data and checksum. Type: TransportContent |
For information about standard request requirements, see Required request parameters.
http://mws.amazonaws.com/FulfillmentInboundShipment/2010-10-01 ?AWSAccessKeyId=AKIAEIAEXAMPLEQCJLSA &Action=GetPackageLabels &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE &SellerId=A13EXAMPLE1J56 &SignatureVersion=2 &Timestamp=2013-08-10T00%3A25%3A41Z &Version=2010-10-01 &SignatureMethod=HmacSHA256 &ShipmentId=FBAQFGQZ &PageType=PackageLabel_Letter_4
For information about standard response formatting, see Response format.
<?xml version="1.0"?> <GetPackageLabelsResponse xmlns="http://mws.amazonaws.com/FulfillmentInboundShipment/2010-10-01/"> <GetPackageLabelsResult> <TransportDocument> <PdfDocument>ABEAAAAAAlbHMucGRmUEsFBgAAAAABAAEAPwAAALQXAQAAAA== </PdfDocument> <Checksum>WGQwqA+NlzMVL1plHc/7ZA==</Checksum> </TransportDocument> </GetPackageLabelsResult> <ResponseMetadata> <RequestId>985a3fa9-3ce2-46fb-a1c7-321439269d2b</RequestId> </ResponseMetadata> </GetPackageLabelsResponse>