Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation
Amazon MWS Documentation

GetPackageLabels

Returns package labels.

Description

Important: The GetPackageLabels operation is provided for backwards compatibility only. Amazon strongly recommends using the GetUniquePackageLabels operation to get package labels instead of the GetPackageLabels operation. Using the GetUniquePackageLabels operation helps to ensure that your shipment is processed at the Amazon fulfillment center quickly and accurately.

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.

Non-Amazon-partnered, Small Parcel shipments

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.

Note: To help ensure that your shipment is processed in a timely manner when it reaches the Amazon fulfillment center, never photocopy a shipping label and put the copied label on multiple boxes in a Small Parcel shipment. Each shipping label for a Small Parcel shipment has a unique barcode and should be placed on a different box in the shipment.

Amazon-partnered, Small Parcel shipments

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.

Note: To help ensure that your shipment is processed in a timely manner when it reaches an Amazon fulfillment center, always put the shipping label and carrier label from the same PDF on the same box.

Less Than Truckload/Full Truckload (LTL/FTL) shipments

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.

Availability

This operation is available in all marketplaces except Brazil.

Throttling

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.

Request parameters

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:
  • PackageLabel_Letter_2 - Two labels per US Letter label sheet. This is the only valid value for Amazon-partnered shipments in the US that use UPS as the carrier. Supported in Canada and the US.
  • PackageLabel_Letter_6 - Six labels per US Letter label sheet. This is the only valid value for non-Amazon-partnered shipments in the US. Supported in Canada and the US.
  • PackageLabel_A4_2 - Two labels per A4 label sheet. Supported in France, Germany, Italy, Spain, and the UK.
  • PackageLabel_A4_4 - Four labels per A4 label sheet. Supported in France, Germany, Italy, Spain, and the UK.
  • PackageLabel_Plain_Paper. One label per sheet of US Letter paper. Only for non-Amazon-partnered shipments. Supported in all marketplaces.

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

Response elements

Name Description
TransportDocument PDF document data and checksum.

Type: TransportContent

Examples

Example query request

For information about standard request requirements, see Required request parameters.

Show example code Hide example code

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

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?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>

↑ Top

Related topics