---
title: "getShippingLabels"
method: GET
path: "/vendor/directFulfillment/shipping/v1/shippingLabels"
tags: ["Vendor Direct Fulfillment Shipping v1"]
---

# getShippingLabels

`GET /vendor/directFulfillment/shipping/v1/shippingLabels`

Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days.

**Usage Plan:**

| Rate (requests per second) | Burst |
| ---- | ---- |
| 10 | 10 |

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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

## Query parameters

- `shipFromPartyId` string
- `limit` integer
- `createdAfter` string, date-time, required
- `createdBefore` string, date-time, required
- `sortOrder` 'ASC' | 'DESC'
- `nextToken` string

## Response `200`

Success.

- GetShippingLabelListResponse — The response schema for the getShippingLabels operation.
  - `payload` ShippingLabelList — Response payload with the list of shipping labels.
    - `pagination` Pagination — The pagination elements required to retrieve the remaining data.
      - `nextToken` string — A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more shipment items to return.
    - `shippingLabels` ShippingLabel[] — An array containing the details of the generated shipping labels.
      - `purchaseOrderNumber` string, required — This field will contain the Purchase Order Number for this order.
      - `sellingParty` PartyIdentification, required — Name/Address and tax details of the party.
        - `address` Address — Address of the party.
          - `name` string, required — The name of the person, business or institution at that address.
          - `addressLine1` string, required — First line of the address.
          - `addressLine2` string — Additional street address information, if required.
          - `addressLine3` string — Additional street address information, if required.
          - `city` string — The city where the person, business or institution is located.
          - `county` string — The county where person, business or institution is located.
          - `district` string — The district where person, business or institution is located.
          - `stateOrRegion` string — The state or region where person, business or institution is located.
          - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
          - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
          - `phone` string — The phone number of the person, business or institution located at that address.
        - `partyId` string, required — Assigned identification for the party.
        - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
          - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
          - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
      - `shipFromParty` PartyIdentification, required — Name/Address and tax details of the party.
        - `address` Address — Address of the party.
          - `name` string, required — The name of the person, business or institution at that address.
          - `addressLine1` string, required — First line of the address.
          - `addressLine2` string — Additional street address information, if required.
          - `addressLine3` string — Additional street address information, if required.
          - `city` string — The city where the person, business or institution is located.
          - `county` string — The county where person, business or institution is located.
          - `district` string — The district where person, business or institution is located.
          - `stateOrRegion` string — The state or region where person, business or institution is located.
          - `postalCode` string — The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.
          - `countryCode` string, required — The two digit country code in ISO 3166-1 alpha-2 format.
          - `phone` string — The phone number of the person, business or institution located at that address.
        - `partyId` string, required — Assigned identification for the party.
        - `taxRegistrationDetails` TaxRegistrationDetails[] — Tax registration details of the entity.
          - `taxRegistrationType` 'VAT' | 'GST', required — Tax registration type for the entity.
          - `taxRegistrationNumber` string, required — Tax registration number for the entity. For example, VAT ID.
      - `labelFormat` 'PNG' | 'ZPL', required — Format of the label.
      - `labelData` LabelData[], required — Provides the details of the packages in this shipment.
        - `labelSequenceNumber` integer — A sequential number assigned to each label within a shipment.
        - `labelFormat` 'PDF' — The format of the label.
        - `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` Error[] — A list of error responses returned when a request is unsuccessful.
    - `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.

## Other responses

- `400` — Request has missing or invalid parameters and cannot be parsed.
- `403` — Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
- `404` — The resource specified does not exist.
- `415` — The request payload is in an unsupported format.
- `429` — The frequency of requests was greater than allowed.
- `500` — Encountered an unexpected condition which prevented the server from fulfilling the request.
- `503` — Temporary overloading or maintenance of the server.

---

[API](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01.md) · [All operations](https://skmtc.net/aws-samples/apis/a-content-management-v2020-11-01/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws-samples/a-content-management-v2020-11-01/revisions/815a5b6dbaa6/schema)
