getLabels

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

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

Usage Plan:

Rate (requests per second)	Burst
2	30

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

shipmentId

string

required

A shipment identifier originally returned by the createInboundShipmentPlan operation.

Query Params

PageType

string

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

string

required

The type of labels requested.

NumberOfPackages

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

NumberOfPallets

integer

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

PageSize

integer

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

PageStartIndex

integer

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

Responses

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sellingpartnerapi-na.amazon.com/fba/inbound/v0/shipments/shipmentId/labels?PageType=PackageLabel_Letter_2&LabelType=BARCODE_2D' \
3
     --header 'accept: application/json'


xxxxxxxxxx
12
 
1
{
2
  "payload": {
3
    "DownloadURL": "string"
4
  },
5
  "errors": [
6
    {
7
      "code": "string",
8
      "message": "string",
9
      "details": "string"
10
    }
11
  ]
12
}

x-amzn-RateLimit-Limit	Your rate limit (requests per second) for this operation.
x-amzn-RequestId	Unique request reference identifier.

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The specified resource does not exist.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.