Vendor Direct Fulfillment Shipping API v2021-12-28 reference

Programmatic access to a direct fulfillment vendor's shipping data.

Overview

The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.

Version information

Version : 2021-12-28

Contact information

Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html

License information

License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0

URI scheme

Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Operations

getShippingLabels
submitShippingLabelRequest
getShippingLabel

Paths

GET /vendor/directFulfillment/shipping/2021-12-28/shippingLabels

Operation: getShippingLabels

Description

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
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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchemaDefault
QueryshipFromPartyId
optional
The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.string-
Querylimit
optional
The limit to the number of records returned.
Minimum : 1
Maximum : 100
integer-
QuerycreatedAfter
required
Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.string (date-time)-
QuerycreatedBefore
required
Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.string (date-time)-
QuerysortOrder
optional
Sort ASC or DESC by order creation date.enum (SortOrder)"ASC"
QuerynextToken
optional
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.string-

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ShippingLabelList

For error status codes, descriptions and schemas, see Error responses and schemas.

POST /vendor/directFulfillment/shipping/2021-12-28/shippingLabels

Operation: submitShippingLabelRequest

Description

Creates a shipping label for a purchase order and returns a transactionId for reference.

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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameSchema
Bodybody
required
SubmitShippingLabelsRequest

Responses

HTTP CodeDescriptionSchema
202Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
TransactionReference

For error status codes, descriptions and schemas, see Error responses and schemas.

GET /vendor/directFulfillment/shipping/2021-12-28/shippingLabels/{purchaseOrderNumber}

Operation: getShippingLabel

Description

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 then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

TypeNameDescriptionSchema
PathpurchaseOrderNumber
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.string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
ShippingLabel

For error status codes, descriptions and schemas, see Error responses and schemas.

Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP CodeDescriptionSchema
400Request has missing or invalid parameters and cannot be parsed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
404The resource specified does not exist.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
413The request size exceeded the maximum accepted size.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
415The request payload is in an unsupported format.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
429The frequency of requests was greater than allowed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
500An unexpected condition occurred that prevented the server from fulfilling the request.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
503Temporary overloading or maintenance of the server.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList

Definitions

SubmitShippingLabelsRequest

NameSchema
shippingLabelRequests
optional
< ShippingLabelRequest > array

ShippingLabelRequest

NameDescriptionSchema
purchaseOrderNumber
required
Purchase order number of the order for which to create a shipping label.
Pattern : "^[a-zA-Z0-9]+$"
string
sellingParty
required
ID of the selling party or vendor.PartyIdentification
shipFromParty
required
Warehouse code of vendor.PartyIdentification
containers
optional
A list of the packages in this shipment.< Container > array

PackedItem

NameDescriptionSchema
itemSequenceNumber
required
Item Sequence Number for the item. This must be the same value as sent in the order for a given item.integer
buyerProductIdentifier
optional
Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.string
vendorProductIdentifier
optional
The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number.string
packedQuantity
required
Total item quantity packed in the container.ItemQuantity

PartyIdentification

NameDescriptionSchema
partyId
required
Assigned Identification for the party.string
address
optional
Identification of the party by address.Address
taxRegistrationDetails
optional
Tax registration details of the entity.< TaxRegistrationDetails > array

TaxRegistrationDetails

Tax registration details of the entity.

NameDescriptionSchema
taxRegistrationType
optional
Tax registration type for the entity.enum (TaxRegistrationType)
taxRegistrationNumber
required
Tax registration number for the party. For example, VAT ID.string
taxRegistrationAddress
optional
Address associated with the tax registration number.Address
taxRegistrationMessages
optional
Tax registration message that can be used for additional tax related details.string

Address

Address of the party.

NameDescriptionSchema
name
required
The name of the person, business or institution at that address.string
addressLine1
required
First line of the address.string
addressLine2
optional
Additional street address information, if required.string
addressLine3
optional
Additional street address information, if required.string
city
optional
The city where the person, business or institution is located.string
county
optional
The county where person, business or institution is located.string
district
optional
The district where person, business or institution is located.string
stateOrRegion
optional
The state or region where person, business or institution is located.string
postalCode
optional
The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.string
countryCode
required
The two digit country code in ISO 3166-1 alpha-2 format.string
phone
optional
The phone number of the person, business or institution located at that address.string

Dimensions

Physical dimensional measurements of a container.

NameDescriptionSchema
length
required
The length of the container.Decimal
width
required
The width of the container.Decimal
height
required
The height of the container.Decimal
unitOfMeasure
required
The unit of measure for dimensions.enum (UnitOfMeasure)

Weight

The weight.

NameDescriptionSchema
unitOfMeasure
required
The unit of measurement.enum (UnitOfMeasure)
value
required
The measurement value.Decimal

Decimal

A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
Pattern : ^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$.

Type : string

ItemQuantity

Details of item quantity.

NameDescriptionSchema
amount
required
Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level.integer
unitOfMeasure
required
Unit of measure for the shipped quantity.string

ShippingLabelList

NameSchema
pagination
optional
Pagination
shippingLabels
optional
< ShippingLabel > array

LabelData

Details of the shipment label.

NameDescriptionSchema
packageIdentifier
optional
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
trackingNumber
optional
Package tracking identifier from the shipping carrier.string
shipMethod
optional
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
shipMethodName
optional
Shipping method name for internal reference.string
content
required
This field will contain the Base64encoded string of the shipment label content.string

ShippingLabel

NameDescriptionSchema
purchaseOrderNumber
required
This field will contain the Purchase Order Number for this order.
Pattern : "^[a-zA-Z0-9]+$"
string
sellingParty
required
ID of the selling party or vendor.PartyIdentification
shipFromParty
required
Warehouse code of vendor.PartyIdentification
labelFormat
required
Format of the label.enum (LabelFormat)
labelData
required
Provides the details of the packages in this shipment.< LabelData > array

Pagination

NameDescriptionSchema
nextToken
optional
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 order items to return.string

TransactionReference

NameDescriptionSchema
transactionId
optional
GUID to identify this transaction. This value can be used with the Transaction Status API to return the status of this transaction.string

ErrorList

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

NameSchema
errors
required
< Error > array

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
code
required
An error code that identifies the type of error that occurred.string
message
required
A message that describes the error condition.string
details
optional
Additional details that can help the caller understand or fix the issue.string

Container

NameDescriptionSchema
containerType
required
The type of container.enum (ContainerType)
containerIdentifier
required
The container identifier.string
trackingNumber
optional
The tracking number.string
manifestId
optional
The manifest identifier.string
manifestDate
optional
The date of the manifest.string
shipMethod
optional
The shipment method.string
scacCode
optional
SCAC code required for NA VOC vendors only.string
carrier
optional
Carrier required for EU VOC vendors only.string
containerSequenceNumber
optional
An integer that must be submitted for multi-box shipments only, where one item may come in separate packages.integer
dimensions
optional
Physical dimensional measurements of a container.Dimensions
weight
optional
The weight.Weight
packedItems
required
A list of packed items.< PackedItem > array

LabelFormat

Format of the label.

Type : enum

ValueDescription
PNGPortable Network Graphics (png) format.
ZPLZebra Programming Language (zpl) format.

TaxRegistrationType

Tax registration type for the entity.

Type : enum

ValueDescription
VATValue-added tax.
GSTGoods and Services Tax (GST).

ContainerType

The type of container.

Type : enum

ValueDescription
CartonPacking container type. Typically used for drinks or food.
PalletA flat transport structure which supports goods in a stable fashion while being lifted by a forklift.

SortOrder

Sort ASC or DESC by order creation date.

Type : enum

ValueDescription
ASCSort in ascending order by order creation date.
DESCSort in descending order by order creation date.

UnitOfMeasure

Type : enum

For use with the definition(s): Weight
The unit of measurement.

ValueDescription
KGKilogram
LBPounds (Libra for Latin).

For use with the definition(s): Dimensions
The unit of measure for dimensions.

ValueDescription
INInches
CMCentimeters