GetShipmentLabels

get https://sellingpartnerapi-na.amazon.com/vendor/shipping/v1/transportLabels

Returns small parcel shipment labels based on the filters that you specify.

Usage Plan:

Rate (requests per second)	Burst
10	10

The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

Query Params

limit

int64

1 to 50

The limit to the number of records returned. Default value is 50 records.

sortOrder

string

Sort the list by shipment label creation date in ascending or descending order.

nextToken

string

A token that is used to retrieve the next page of results. The response includes nextToken when the number of results exceeds the specified pageSize value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

labelCreatedAfter

date-time

Shipment labels created after this time will be included in the result. This field must be in ISO 8601 datetime format.

labelCreatedBefore

date-time

Shipment labels created before this time will be included in the result. This field must be in ISO 8601 datetime format.

buyerReferenceNumber

string

Get Shipment labels by passing buyer reference number.

vendorShipmentIdentifier

string

Get Shipment labels by passing vendor shipment identifier.

sellerWarehouseCode

string

Get Shipping labels based on vendor warehouse code. This value must be same as the sellingParty.partyId in the shipment.

Responses

Response body

object

payload

object

The request schema for the GetShipmentLabels operation.

pagination

object

The pagination elements required to retrieve the remaining data.

transportLabels

array of objects

A list of one or more ShipmentLabels.

transportLabels

object

labelCreateDateTime

date-time

Date on which label is created.

shipmentInformation

object

Shipment Information details for Label request.

labelData

array of objects

Indicates the label data,format and type associated .

labelData

object

labelSequenceNumber

integer

A sequential number assigned to each label within a shipment.

labelFormat

string

The format of the label.

PDF

carrierCode

string

Unique identification of the carrier.

trackingId

string

Tracking Id for the transportation.

label

string

The base-64 encoded string that represents the shipment label.

errors

array of objects

A list of error responses returned when a request is unsuccessful.

errors

object

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

Additional details that can help the caller understand or fix the issue.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sellingpartnerapi-na.amazon.com/vendor/shipping/v1/transportLabels \
3
     --header 'accept: application/json'


xxxxxxxxxx
47
}
1
{
2
  "payload": {
3
    "pagination": {
4
      "nextToken": "MDAwMDAwMDAwMQ=="
5
    },
6
    "transportLabels": [
7
      {
8
        "labelCreateDateTime": "2024-03-03T14:40:29Z",
9
        "shipmentInformation": {
10
          "vendorDetails": {
11
            "sellingParty": {
12
              "partyId": "WHF47"
13
            },
14
            "vendorShipmentIdentifier": "7822"
15
          },
16
          "buyerReferenceNumber": "14511336331",
17
          "shipToParty": {
18
            "partyId": "IND1"
19
          },
20
          "shipFromParty": {
21
            "partyId": "0-55767831",
22
            "address": {
23
              "name": "SF Two",
24
              "addressLine1": "123 Another street",
25
              "city": "San Francisco",

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 resource specified does not exist.

415The request payload is in an unsupported format.

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.