HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
API Reference
Developer HubAPI StatusSupport
Start typing to search…

getShippingLabels

get https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/2021-12-28/shippingLabels

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

Usage Plan:

Rate (requests per second)Burst
1010

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values then those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Query Params
string

The vendor warehouseId for order fulfillment. If not specified, the result contains orders for all warehouses.

integer
1 to 100

The limit to the number of records returned.

date-time
required

Shipping labels that became available after this date and time will be included in the result. Values are in ISO 8601 date-time format.

date-time
required

Shipping labels that became available before this date and time will be included in the result. Values are in ISO 8601 date-time format.

string
Defaults to ASC

The sort order creation date. You can choose between ascending (ASC) or descending (DESC) sort order.

string

Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.

Responses

Response body
object
pagination
object

The pagination elements required to retrieve the remaining data.

string

Pagination occurs when a request produces a response that exceeds the pageSize. This means that the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request. There is no nextToken in the pagination object on the last page.

shippingLabels
array of objects

An array containing the details of the generated shipping labels.

shippingLabels
object
string
required

This field will contain the Purchase Order Number for this order.

sellingParty
object
required

The name, address, and tax details of a party.

shipFromParty
object
required

The name, address, and tax details of a party.

string
required

Format of the label.

PNG ZPL

Show Details
PNGPortable Network Graphics (png) format.
ZPLZebra Programming Language (zpl) format.
labelData
array of objects
required

Provides the details of the packages in this shipment.

labelData*
object
string

Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level.

string

Package tracking identifier from the shipping carrier.

string

Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation.

string

Shipping method name for internal reference.

string
required

This field will contain the Base64 string of the shipment label content.

Headers
object
string

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

string

Unique request reference identifier.

Updated 3 months ago

Did this page help you?
Language

Updated 3 months ago

Did this page help you?