Amazon Services
Amazon Marketplace Web Service (Amazon MWS) Documentation

Deprecation Notice:

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.

Amazon MWS Documentation

GetPalletLabels

Returns pallet labels.

Description

The GetPalletLabels operation returns PDF document data for printing pallet labels for a Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. This operation returns the InvalidOperation error code if you include a ShipmentId value for a Small Parcel shipment. For information about extracting PDF document data, see Extracting PDF Document Data. For more information about creating inbound shipments, see Shipping inventory to Amazon's fulfillment network.

Availability

This operation is available in all marketplaces except Brazil.

Throttling

The GetPalletLabels 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 Must match a ShipmentId value previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the NoPackageContentInformation error. For more information, see Providing carton contents information.

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.
  • PackageLabel_Thermal - One label per sheet of 4" x 6" thermal printed paper. Supports Amazon-partnered shipments with UPS.
  • PackageLabel_Thermal_Unified - One label per sheet of 4" x 6" thermal printed paper. Supports shipments with ATS.
  • PackageLabel_Thermal_NonPCP - One label per sheet of 4" x 6" thermal printed paper. Supports non-Amazon-partnered shipments.
  • PackageLabel_Thermal_No_Carrier_Rotation - One label per sheet of 4" x 6" thermal printed paper. Supports Amazon-partnered shipments with DHL.

Submitting a PageType value that is not supported in your marketplace returns an error.

Type: xs:string

NumberOfPallets The number of pallets in the shipment. This returns four identical labels for each pallet. Yes 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=GetPalletLabels
  &MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE
  &SellerId=A13EXAMPLE1J56
  &SignatureVersion=2
  &Timestamp=2015-08-10T00%3A38%3A53Z
  &Version=2010-10-01
  &SignatureMethod=HmacSHA256
  &ShipmentId=FBAQFGQZ
  &PageType=PackageLabel_Letter_4
  &NumberOfPallets=4

↑ Top

Example response

For information about standard response formatting, see Response format.

Show example code Hide example code

<?xml version="1.0" encoding="UTF-8"?>

<?xml version="1.0"?>
<GetPalletLabelsResponse> 
    xmlns="http://mws.amazonaws.com/FulfillmentInboundShipment/2010-10-01/">
    <GetPalletLabelsResult>
        <TransportDocument>
            <PdfDocument>ABEAAAAAAlbHMucGRmUEsFBgAAAAABAAEAPwAAALQXAQAAAA==
            </PdfDocument>
            <Checksum>WGQwqA+NlzMVL1plHc/7ZA==</Checksum>
        </TransportDocument>
    </GetPalletLabelsResult>
    <ResponseMetadata>
        <RequestId>985a3fa9-3ce2-46fb-a1c7-321439269d2b</RequestId>
    </ResponseMetadata>
</GetPalletLabelsResponse>

↑ Top