v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Fulfillment Inbound v0

getLabels

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.

get/fba/inbound/v0/shipments/{shipmentId}/labels

Path parameters

shipmentIdstring required

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Query parameters

PageType'PackageLabel_Letter_2' | 'PackageLabel_Letter_4' | 'PackageLabel_Letter_6' | 'PackageLabel_Letter_6_CarrierLeft' | 'PackageLabel_A4_2' | 'PackageLabel_A4_4' | 'PackageLabel_Plain_Paper' | 'PackageLabel_Plain_Paper_CarrierBottom' | 'PackageLabel_Thermal' | 'PackageLabel_Thermal_Unified' | 'PackageLabel_Thermal_NonPCP' | 'PackageLabel_Thermal_No_Carrier_Rotation' required

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

LabelType'BARCODE_2D' | 'UNIQUE' | 'PALLET' required

The type of labels requested.

NumberOfPackagesinteger

The number of packages in the shipment.

PackageLabelsToPrintstring[]

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.

NumberOfPalletsinteger

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

PageSizeinteger

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

PageStartIndexinteger

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

Response

Success.