HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport

getLabels

get
https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments//labels

Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center.

Usage Plan:

Rate (requests per second)Burst
230

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

Path Params
string
required

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Query Params
string
enum
required

The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.

Show Details
PackageLabel_Letter_2Two labels per US Letter label sheet. This is the only valid value for Amazon-partnered shipments in the US that use United Parcel Service (UPS) as the carrier. Supported in Canada and the US.
PackageLabel_Letter_4Four 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_Letter_6Six 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_Letter_6_CarrierLeftPackageLabel_Letter_6_CarrierLeft
PackageLabel_A4_2Two labels per A4 label sheet.
PackageLabel_A4_4Four labels per A4 label sheet.
PackageLabel_Plain_PaperOne label per sheet of US Letter paper. Only for non-Amazon-partnered shipments.
PackageLabel_Plain_Paper_CarrierBottomPackageLabel_Plain_Paper_CarrierBottom
PackageLabel_ThermalFor use of a thermal printer. Supports Amazon-partnered shipments with UPS.
PackageLabel_Thermal_UnifiedFor use of a thermal printer. Supports shipments with ATS.
PackageLabel_Thermal_NonPCPFor use of a thermal printer. Supports non-Amazon-partnered shipments.
PackageLabel_Thermal_No_Carrier_RotationFor use of a thermal printer. Supports Amazon-partnered shipments with DHL.
string
enum
required

The type of labels requested.

Allowed:
integer

The number of packages in the shipment.

PackageLabelsToPrint
array of strings

A list of identifiers that specify packages for which you want package labels printed.

If you provide box content information with the FBA Inbound Shipment Carton Information Feed, then PackageLabelsToPrint must match the CartonId values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then PackageLabelsToPrint must match the boxID values from the listShipmentBoxes response. If these values do not match as required, the operation returns the IncorrectPackageIdentifier error code.

PackageLabelsToPrint
integer

The number of pallets in the shipment. This returns four identical labels for each pallet.

integer

The page size for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.

integer

The page start index for paginating through the total packages' labels. This is a required parameter for Non-Partnered LTL Shipments.

Responses

Updated over 1 year ago

Language
Response 
 Choose an example:
application/json
Updated over 1 year ago