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

getShippingLabel

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

Returns a shipping label for the purchaseOrderNumber that you specify.

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 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
string
required

The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.

Responses

Response body
object
payload
object

Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details.

string
required

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

sellingParty
object
required

Name, address and tax details of a party.

shipFromParty
object
required

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 Base64encoded string of the shipment label content.

errors
array of objects

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

errors
object
string
required

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

string
required

A message that describes the error condition.

string

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

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?