Overview

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

Version information

Version : v1

Operations

getShippingLabels
submitShippingLabelRequest
getShippingLabel
submitShipmentConfirmations
submitShipmentStatusUpdates
getCustomerInvoices
getCustomerInvoice
getPackingSlips
getPackingSlip

Paths

getShippingLabels

GET /vendor/directFulfillment/shipping/v1/shippingLabels

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 Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema	Default
Query	shipFromPartyId optional	The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.	string	-
Query	limit optional	The limit to the number of records returned. Minimum : 1 Maximum : 100	integer	-
Query	createdAfter 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)	-
Query	createdBefore 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)	-
Query	sortOrder optional	Sort ASC or DESC by order creation date.	enum (SortOrder)	"ASC"
Query	nextToken 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 Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetShippingLabelListResponse
400	Request 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.	GetShippingLabelListResponse
403	Indicates 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.	GetShippingLabelListResponse
404	The 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.	GetShippingLabelListResponse
415	The 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.	GetShippingLabelListResponse
429	The 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.	GetShippingLabelListResponse
500	Encountered an unexpected condition which 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.	GetShippingLabelListResponse
503	Temporary 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.	GetShippingLabelListResponse

submitShippingLabelRequest

POST /vendor/directFulfillment/shipping/v1/shippingLabels

Description

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

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Schema
Body	body required	SubmitShippingLabelsRequest

Responses

HTTP Code	Description	Schema
202	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SubmitShippingLabelsResponse
400	Request 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.	SubmitShippingLabelsResponse
403	Indicates 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.	SubmitShippingLabelsResponse
404	The 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.	SubmitShippingLabelsResponse
413	The 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.	SubmitShippingLabelsResponse
415	The 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.	SubmitShippingLabelsResponse
429	The 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.	SubmitShippingLabelsResponse
500	Encountered an unexpected condition which 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.	SubmitShippingLabelsResponse
503	Temporary 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.	SubmitShippingLabelsResponse

getShippingLabel

GET /vendor/directFulfillment/shipping/v1/shippingLabels/{purchaseOrderNumber}

Description

Returns a shipping label for the purchaseOrderNumber that you specify.

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	purchaseOrderNumber 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 Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetShippingLabelResponse
400	Request 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.	GetShippingLabelResponse
401	The 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.	GetShippingLabelResponse
403	Indicates 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.	GetShippingLabelResponse
404	The 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.	GetShippingLabelResponse
415	The 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.	GetShippingLabelResponse
429	The 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.	GetShippingLabelResponse
500	Encountered an unexpected condition which 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.	GetShippingLabelResponse
503	Temporary 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.	GetShippingLabelResponse

submitShipmentConfirmations

POST /vendor/directFulfillment/shipping/v1/shipmentConfirmations

Description

Submits one or more shipment confirmations for vendor orders.

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Schema
Body	body required	SubmitShipmentConfirmationsRequest

Responses

HTTP Code	Description	Schema
202	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SubmitShipmentConfirmationsResponse
400	Request 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.	SubmitShipmentConfirmationsResponse
403	Indicates 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.	SubmitShipmentConfirmationsResponse
404	The 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.	SubmitShipmentConfirmationsResponse
413	The 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.	SubmitShipmentConfirmationsResponse
415	The 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.	SubmitShipmentConfirmationsResponse
429	The 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.	SubmitShipmentConfirmationsResponse
500	Encountered an unexpected condition which 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.	SubmitShipmentConfirmationsResponse
503	Temporary 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.	SubmitShipmentConfirmationsResponse

submitShipmentStatusUpdates

POST /vendor/directFulfillment/shipping/v1/shipmentStatusUpdates

Description

This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Schema
Body	body required	SubmitShipmentStatusUpdatesRequest

Responses

HTTP Code	Description	Schema
202	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	SubmitShipmentStatusUpdatesResponse
400	Request 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.	SubmitShipmentStatusUpdatesResponse
403	Indicates 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.	SubmitShipmentStatusUpdatesResponse
404	The 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.	SubmitShipmentStatusUpdatesResponse
413	The 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.	SubmitShipmentStatusUpdatesResponse
415	The 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.	SubmitShipmentStatusUpdatesResponse
429	The 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.	SubmitShipmentStatusUpdatesResponse
500	Encountered an unexpected condition which 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.	SubmitShipmentStatusUpdatesResponse
503	Temporary 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.	SubmitShipmentStatusUpdatesResponse

getCustomerInvoices

GET /vendor/directFulfillment/shipping/v1/customerInvoices

Description

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

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Query	shipFromPartyId optional	The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.	string
Query	limit optional	The limit to the number of records returned Minimum : 1 Maximum : 100	integer
Query	createdAfter required	Orders 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)
Query	createdBefore required	Orders 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)
Query	sortOrder optional	Sort ASC or DESC by order creation date.	enum (SortOrder)
Query	nextToken optional	Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetCustomerInvoicesResponse
400	Request 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.	GetCustomerInvoiceResponse
403	Indicates 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.	GetCustomerInvoiceResponse
404	The 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.	GetCustomerInvoiceResponse
415	The 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.	GetCustomerInvoiceResponse
429	The 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.	GetCustomerInvoiceResponse
500	Encountered an unexpected condition which 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.	GetCustomerInvoiceResponse
503	Temporary 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.	GetCustomerInvoiceResponse

getCustomerInvoice

GET /vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber}

Description

Returns a customer invoice based on the purchaseOrderNumber that you specify.

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	purchaseOrderNumber required	Purchase order number of the shipment for which to return the invoice.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetCustomerInvoiceResponse
400	Request 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.	GetCustomerInvoiceResponse
401	The 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.	GetCustomerInvoiceResponse
403	Indicates 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.	GetCustomerInvoiceResponse
404	The 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.	GetCustomerInvoiceResponse
415	The 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.	GetCustomerInvoiceResponse
429	The 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.	GetCustomerInvoiceResponse
500	Encountered an unexpected condition which 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.	GetCustomerInvoiceResponse
503	Temporary 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.	GetCustomerInvoiceResponse

getPackingSlips

GET /vendor/directFulfillment/shipping/v1/packingSlips

Description

Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema	Default
Query	shipFromPartyId optional	The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.	string	-
Query	limit optional	The limit to the number of records returned Minimum : 1 Maximum : 100	integer	-
Query	createdAfter required	Packing slips 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)	-
Query	createdBefore required	Packing slips 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)	-
Query	sortOrder optional	Sort ASC or DESC by packing slip creation date.	enum (SortOrder)	"ASC"
Query	nextToken optional	Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.	string	-

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetPackingSlipListResponse
400	Request 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.	GetPackingSlipListResponse
401	The 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.	GetPackingSlipListResponse
403	Indicates 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.	GetPackingSlipListResponse
404	The 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.	GetPackingSlipListResponse
415	The 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.	GetPackingSlipListResponse
429	The 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.	GetPackingSlipListResponse
500	Encountered an unexpected condition which 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.	GetPackingSlipListResponse
503	Temporary 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.	GetPackingSlipListResponse

getPackingSlip

GET /vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber}

Description

Returns a packing slip based on the purchaseOrderNumber that you specify.

Usage Plans:

Plan type	Rate (requests per second)	Burst
Default	10	10
Selling partner specific	Variable	Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	purchaseOrderNumber required	The purchaseOrderNumber for the packing slip you want.	string

Responses

HTTP Code	Description	Schema
200	Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier.	GetPackingSlipResponse
400	Request 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.	GetPackingSlipResponse
401	The 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.	GetPackingSlipResponse
403	Indicates 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.	GetPackingSlipResponse
404	The 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.	GetPackingSlipResponse
415	The 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.	GetPackingSlipResponse
429	The 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.	GetPackingSlipResponse
500	Encountered an unexpected condition which 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.	GetPackingSlipResponse
503	Temporary 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.	GetPackingSlipResponse

Definitions

PackingSlip

Packing slip information.

Name	Description	Schema
purchaseOrderNumber required	Purchase order number of the shipment that the packing slip is for. Pattern : "^[a-zA-Z0-9]+$"	string
content required	A Base64encoded string of the packing slip PDF.	string
contentType optional	The format of the file such as PDF, JPEG etc.	enum (ContentType)

PackingSlipList

A list of packing slips.

Name	Schema
pagination optional	Pagination
packingSlips optional	< PackingSlip > array

GetPackingSlipListResponse

Name	Description	Schema
payload optional	A list of packing slips.	PackingSlipList
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

GetPackingSlipResponse

Name	Description	Schema
payload optional	Packing slip information.	PackingSlip
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

SubmitShippingLabelsRequest

Name	Schema
shippingLabelRequests optional	< ShippingLabelRequest > array

ShippingLabelRequest

Name	Description	Schema
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

Item

Details of the item being shipped.

Name	Description	Schema
itemSequenceNumber required	Item Sequence Number for the item. This must be the same value as sent in 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
shippedQuantity required	Total item quantity shipped in this shipment.	ItemQuantity

PackedItem

Name	Description	Schema
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

Name	Description	Schema
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

ShipmentDetails

Details about a shipment.

Name	Description	Schema
shippedDate required	This field indicates the date of the departure of the shipment from vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Amazon destination warehouse, whichever is sooner. Shipped date mentioned in the Shipment Confirmation should not be in the future.	string (date-time)
shipmentStatus required	Indicate the shipment status.	enum (ShipmentStatus)
isPriorityShipment optional	Provide the priority of the shipment.	boolean
vendorOrderNumber optional	The vendor order number is a unique identifier generated by a vendor for their reference.	string
estimatedDeliveryDate optional	Date on which the shipment is expected to reach the buyer's warehouse. It needs to be an estimate based on the average transit time between the ship-from location and the destination. The exact appointment time will be provided by buyer and is potentially not known when creating the shipment confirmation.	string (date-time)

StatusUpdateDetails

Details for the shipment status update given by the vendor for the specific package.

Name	Description	Schema
trackingNumber required	This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation.	string
statusCode required	Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer.	string
reasonCode required	Provides a reason code for the status of the package that will provide additional information about the transportation status.	string
statusDateTime required	The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.	string (date-time)
statusLocationAddress required	Address of the party.	Address
shipmentSchedule optional	-	shipmentSchedule

shipmentSchedule

Name	Description	Schema
estimatedDeliveryDateTime optional	Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.	string (date-time)
apptWindowStartDateTime optional	This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.	string (date-time)
apptWindowEndDateTime optional	This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.	string (date-time)

TaxRegistrationDetails

Tax registration details of the entity.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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.

Name	Description	Schema
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

SubmitShipmentConfirmationsResponse

The response schema for the submitShipmentConfirmations operation.

Name	Description	Schema
payload optional	The response payload for the submitShipmentConfirmations operation.	TransactionReference
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

SubmitShipmentStatusUpdatesResponse

The response schema for the submitShipmentStatusUpdates operation.

Name	Description	Schema
payload optional	The response payload for the submitShipmentStatusUpdates operation.	TransactionReference
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

GetShippingLabelListResponse

The response schema for the getShippingLabels operation.

Name	Description	Schema
payload optional	List of ship labels.	ShippingLabelList
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

GetShippingLabelResponse

The response schema for the getShippingLabel operation.

Name	Description	Schema
payload optional	The payload for the getShippingLabel operation.	ShippingLabel
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

ShippingLabelList

Name	Schema
pagination optional	Pagination
shippingLabels optional	< ShippingLabel > array

LabelData

Details of the shipment label.

Name	Description	Schema
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

Name	Description	Schema
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

SubmitShippingLabelsResponse

The response schema for the submitShippingLabelRequest operation.

Name	Description	Schema
payload optional	The response payload for the submitShippingLabelRequest operation.	TransactionReference
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

SubmitShipmentConfirmationsRequest

Name	Schema
shipmentConfirmations optional	< ShipmentConfirmation > array

ShipmentConfirmation

Name	Description	Schema
purchaseOrderNumber required	Purchase order number corresponding to the shipment. Pattern : "^[a-zA-Z0-9]+$"	string
shipmentDetails required	Shipment information.	ShipmentDetails
sellingParty required	ID of the selling party or vendor.	PartyIdentification
shipFromParty required	Warehouse code of vendor.	PartyIdentification
items required	Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.	< Item > array
containers optional	Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.	< Container > array

SubmitShipmentStatusUpdatesRequest

Name	Schema
shipmentStatusUpdates optional	< ShipmentStatusUpdate > array

ShipmentStatusUpdate

Name	Description	Schema
purchaseOrderNumber required	Purchase order number of the shipment for which to update the shipment status. Pattern : "^[a-zA-Z0-9]+$"	string
sellingParty required	ID of the selling party or vendor.	PartyIdentification
shipFromParty required	Warehouse code of vendor.	PartyIdentification
statusUpdateDetails required	Provide the details about the status of the shipment at that particular point of time.	StatusUpdateDetails

GetCustomerInvoicesResponse

The response schema for the getCustomerInvoices operation.

Name	Description	Schema
payload optional	List of customer invoices.	CustomerInvoiceList
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

GetCustomerInvoiceResponse

The response schema for the getCustomerInvoice operation.

Name	Description	Schema
payload optional	The payload for the getCustomerInvoice operation.	CustomerInvoice
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

CustomerInvoiceList

Name	Schema
pagination optional	Pagination
customerInvoices optional	< CustomerInvoice > array

Pagination

Name	Description	Schema
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

CustomerInvoice

Name	Description	Schema
purchaseOrderNumber required	The purchase order number for this order. Pattern : "^[a-zA-Z0-9]+$"	string
content required	The Base64encoded customer invoice.	string

TransactionReference

Name	Description	Schema
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.

Type : < Error > array

Error

Error response returned when the request is unsuccessful.

Name	Description	Schema
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

Name	Description	Schema
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

Value	Description
PNG	Portable Network Graphics (png) format.
ZPL	Zebra Programming Language (zpl) format.

ContentType

The format of the file such as PDF, JPEG etc.

Type : enum

Value	Description
application/pdf	Portable Document Format (pdf).

ShipmentStatus

Indicate the shipment status.

Type : enum

Value	Description
SHIPPED	Orders that have left the warehouse have shipped status.
FLOOR_DENIAL	Status for orders rejected due to quality issues with products on the floor, or the physical and virtual inventory do not match.

TaxRegistrationType

Tax registration type for the entity.

Type : enum

Value	Description
VAT	Value-added tax.
GST	Goods and Services Tax (GST).

ContainerType

The type of container.

Type : enum

Value	Description
carton	Packing container type. Typically used for drinks or food.
pallet	A flat transport structure which supports goods in a stable fashion while being lifted by a forklift.

UnitOfMeasure

Type : enum

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

Value	Description
KG	Kilogram
LB	Pounds (Libra for Latin).

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

Value	Description
IN	Inches
CM	Centimeters

SortOrder

Type : enum

For use with the operation(s): getPackingSlips Sort ASC or DESC by packing slip creation date.

Value	Description
ASC	Sort in ascending order by packing slip creation date.
DESC	Sort in descending order by packing slip creation date.

For use with the operation(s): getShippingLabels, getCustomerInvoices Sort ASC or DESC by order creation date.

Value	Description
ASC	Sort in ascending order by order creation date.
DESC	Sort in descending order by order creation date.