Shipping API v2 Reference

Overview

The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.

Carrier Support: Sellers enrolled in the Fulfilled by Merchant (FBM) Program can use this Shipping API V2 to purchase shipping labels for Amazon Shipping and/or third party shipping carriers like UPS, USPS, FedEx, DHL, etc. Complete list of supported carriers and shipping services can be found on Seller Central.

For Amazon marketplace orders (On-Amazon): Carrier labels for Amazon Shipping and third party carriers are available
For other channels (Off-Amazon) e.g. Merchant website, eBay, Shopify etc: Only Amazon Shipping is available.

To indicate if the label you are purchasing is for On-Amazon or Off-Amazon, use ChannelType.

Version information

Version : v2

URI scheme

Host : available hosts for amazon shipping v2 apis
Schemes : HTTPS

Consumes

application/json

Produces

application/json

Operations

getRates
purchaseShipment
oneClickShipment
getTracking
getShipmentDocuments
cancelShipment
getAccessPoints
submitNdrFeedback
getAdditionalInputs

Paths

POST /shipping/v2/shipments/rates

Operation: getRates

Description

Returns the available shipping service offerings.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

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 for this operation. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Parameters

Type	Name	Description	Schema
Body	body required	The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.	GetRatesRequest
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id required	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	GetRatesResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

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

POST /shipping/v2/shipments

Operation: purchaseShipment

Description

Purchases a shipping service and returns purchase related details and documents.

Note: You must complete the purchase within 10 minutes of rate creation by the shipping service provider for channelType as EXTERNAL which is for OFF-Amazon volume. If you make the request after the 10 minutes have expired, you will receive an error response with the error code equal to "TOKEN_EXPIRED". If you receive this error response, you must get the rates for the shipment again.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

Parameters

Type	Name	Description	Schema
Body	body required	The request schema for the purchaseShipment operation.	PurchaseShipmentRequest
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id required	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	PurchaseShipmentResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

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

POST /shipping/v2/oneClickShipment

Operation: oneClickShipment

Description

Purchases a shipping service identifier and returns purchase-related details and documents.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

Parameters

Type	Name	Description	Schema
Body	body required	The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.	OneClickShipmentRequest
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id required	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	OneClickShipmentResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

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

GET /shipping/v2/tracking

Operation: getTracking

Description

Returns tracking information for a purchased shipment.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

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

Parameters

Type	Name	Description	Schema
Query	trackingId required	A carrier-generated tracking identifier originally returned by the purchaseShipment operation.	string
Query	carrierId required	A carrier identifier originally returned by the getRates operation for the selected rate.	enum (carrier-id )
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id optional	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	GetTrackingResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

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

GET /shipping/v2/shipments/{shipmentId}/documents

Operation: getShipmentDocuments

Description

Returns the shipping documents associated with a package in a shipment.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

Parameters

Type	Name	Description	Schema
Path	shipmentId required	The shipment identifier originally returned by the purchaseShipment operation.	string
Query	packageClientReferenceId required	The package client reference identifier originally provided in the request body parameter for the getRates operation.	string
Query	format optional	The file format of the document. Must be one of the supported formats returned by the getRates operation.	string
Query	dpi optional	The resolution of the document (for example, 300 means 300 dots per inch). Must be one of the supported resolutions returned in the response to the getRates operation.	number
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id required	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	GetShipmentDocumentsResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

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

PUT /shipping/v2/shipments/{shipmentId}/cancel

Operation: cancelShipment

Description

Cancels a purchased shipment. Returns an empty object if the shipment is successfully cancelled.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

Parameters

Type	Name	Description	Schema
Path	shipmentId required	The shipment identifier originally returned by the purchaseShipment operation.	string
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id required	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	CancelShipmentResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

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

GET /shipping/v2/accessPoints

Operation: getAccessPoints

Description

Returns a list of access points in proximity of input postal code.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

Parameters

Type	Name	Description	Schema
Query	accessPointTypes required	-	< enum (AccessPointTypes) > array(csv)
Query	countryCode required	-	string
Query	postalCode required	-	string
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id required	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	GetAccessPointsResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

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

Consumes

application/json

Produces

application/json

POST /shipping/v2/ndrFeedback

Operation: submitNdrFeedback

Description

This API submits the NDR (Non-delivery Report) Feedback for any eligible shipment.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

Parameters

Type	Name	Description	Schema
Body	body required	Request body for ndrFeedback operation	SubmitNdrFeedbackRequest
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id optional	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

Responses

HTTP Code	Description	Schema
204	Success Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference identifier.	No Content
401	The request's Authorization header is not formatted correctly or does not contain a valid token. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ErrorList
413	The request size exceeded the maximum accepted size. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ErrorList
415	The request payload is in an unsupported format. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ErrorList
429	The frequency of requests was greater than allowed. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ErrorList
500	An unexpected condition occurred that prevented the server from fulfilling the request. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ErrorList
503	Temporary overloading or maintenance of the server. Headers : `x-amzn-RequestId` (string) : Unique request reference identifier.	ErrorList

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

GET /shipping/v2/shipments/additionalInputs/schema

Operation: getAdditionalInputs

Description

Returns the JSON schema to use for providing additional inputs when needed to purchase a shipping offering. Call the getAdditionalInputs operation when the response to a previous call to the getRates operation indicates that additional inputs are required for the rate (shipping offering) that you want to purchase.

Usage Plan:

Default Quota	Unit
5	Requests Per Second

Parameters

Type	Name	Description	Schema
Query	requestToken required	The request token returned in the response to the getRates operation.	string
Query	rateId required	The rate identifier for the shipping offering (rate) returned in the response to the getRates operation.	string
Header	x-amz-access-token required	Amazon shipping request token	string
Header	x-amzn-shipping-business-id optional	Amazon shipping business to assume for this request. The default is AmazonShipping_UK.	enum (X-amzn-shipping-business-id)

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.	GetAdditionalInputsResponse
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.	ErrorList
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.	ErrorList
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.	ErrorList
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.	ErrorList
500	An 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
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.	ErrorList

For additional 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 Code	Description	Schema
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.	ErrorList
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.	ErrorList
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.	ErrorList

Definitions

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

ErrorList

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

Name	Schema
errors required	< Error > array

Weight

The weight in the units indicated.

Name	Description	Schema
unit required	The unit of measurement.	enum (Unit)
value required	The measurement value.	number

LiquidVolume

Liquid Volume.

Name	Description	Schema
unit required	The unit of measurement.	enum (Unit)
value required	The measurement value.	number

InvoiceDetails

The invoice details for charges associated with the goods in the package. Only applies to certain regions.

Name	Description	Schema
invoiceNumber optional	The invoice number of the item.	string
invoiceDate optional	The invoice date of the item in ISO 8061 format.	string (date-time)

ChargeList

A list of charges based on the shipping service charges applied on a package.

Type : < ChargeComponent > array

ChargeComponent

The type and amount of a charge applied on a package.

Name	Description	Schema
amount optional	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency
chargeType optional	The type of charge.	enum (ChargeType)

Currency

The monetary value in the currency indicated, in ISO 4217 standard format.

Name	Description	Schema
value required	The monetary value.	number
unit required	The ISO 4217 format 3-character currency code. minLength : 3 maxLength : 3	string

Dimensions

A set of measurements for a three-dimensional object.

Name	Description	Schema
length required	The length of the package.	number
width required	The width of the package.	number
height required	The height of the package.	number
unit required	The unit of measurement.	enum (Unit)

RequestToken

A unique token generated to identify a getRates operation.

Type : string

RateId

An identifier for the rate (shipment offering) provided by a shipping service provider.

Type : string

CarrierId

The carrier identifier for the offering, provided by the carrier.

Type : string

CarrierName

The carrier name for the offering.

Type : string

PackageClientReferenceId

A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.

Type : string

ShipmentId

The unique shipment identifier provided by a shipping service.

Type : string

DetailCodes

A list of codes used to provide additional shipment information.

Type : enum

Value	Description
BusinessClosed	Attempted delivery but the business was closed.
CustomerUnavailable	Attempted delivery but the recipient was unavailable.
PaymentNotReady	Attempted delivery but cash was not available from recipient.
OtpNotAvailable	Attempted delivery but the recipient did not have the PIN available.
DeliveryAttempted	Delivery was attempted.
UnableToAccess	Attempted delivery but could not access the recipient location.
UnableToContactRecipient	Attempted delivery but unable to contact the recipient to coordinate delivery.
DeliveredToBehindWheelieBin	Shipment delivered behind wheelie bin.
DeliveredToPorch	Shipment delivered to front porch or front door.
DeliveredToGarage	Shipment delivered to garage.
DeliveredToGarden	Shipment delivered to garden.
DeliveredToGreenhouse	Shipment delivered to greenhouse.
DeliveredToMailSlot	Shipment delivered to letterbox/mail slot.
DeliveredToMailRoom	Shipment delivered to mailroom.
DeliveredToNeighbor	Shipment delivered and signed for by neighbor.
DeliveredToRearDoor	Shipment delivered to rear porch or rear door.
DeliveredToReceptionist	Shipment delivered to reception.
DeliveredToShed	Shipment delivered to shed.
Signed	Shipment delivered and signature received.
Damaged	Shipment was damaged. When paired with Rejected this indicates the recipient refused to accept the shipment because the shipment was damaged. When paired with UNDELIVERABLE it means the shipment was undeliverable due to being damaged and may be returned to the seller.
IncorrectItems	Recipient refused to accept the shipment because the shipment contains incorrect item/s.
NotRequired	Recipient refused to accept the shipment because the recipient did not want the shipment.
Rejected	Recipient refused to accept the shipment.
CancelledByRecipient	Shipment was cancelled by the recipient. This tag is paired with the rejected shipment status.
AddressNotFound	Shipment is undeliverable and is returning to seller because the address was missing or incorrect.
HazmatShipment	Shipment is non-compliant Hazmat.
Undeliverable	Shipment is undeliverable and is returning to the seller.

TrackingDetailCodes

Contains detail codes that provide additional details related to the forward and return leg of the shipment.

Name	Description	Schema
forward required	Contains detail codes that provide additional details related to the forward leg of the shipment.	< DetailCodes > array
returns required	Contains detail codes that provide additional details related to the return leg of the shipment.	< DetailCodes > array

TrackingId

The carrier generated identifier for a package in a purchased shipment.

Type : string

AlternateLegTrackingId

The carrier generated reverse identifier for a returned package in a purchased shipment.

Type : string

ServiceId

An identifier for the shipping service.

Type : string

Please find the current list of service id here.

ServiceName

The name of the shipping service.

Type : string

Please find the current list of service name here.

AdditionalAddressNotes

Address notes to re-attempt delivery with.

Type : string

maxLength : 256

ShipperInstruction

The shipper instruction.

Name	Description	Schema
deliveryNotes optional	The delivery notes for the shipment maxLength : 256	string

Address

The address.

Name	Description	Schema
name required	The name of the person, business or institution at the address. minLength : 1 maxLength : 50	string
addressLine1 required	The first line of the address. minLength : 1 maxLength : 60	string
addressLine2 optional	Additional address information, if required. minLength : 1 maxLength : 60	string
addressLine3 optional	Additional address information, if required. minLength : 1 maxLength : 60	string
companyName optional	The name of the business or institution associated with the address.	string
stateOrRegion optional	The state, county or region where the person, business or institution is located.	StateOrRegion
city required	The city or town where the person, business or institution is located.	City
countryCode required	The two digit country code. Follows ISO 3166-1 alpha-2 format.	CountryCode
postalCode required	The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.	PostalCode
email optional	The email address of the contact associated with the address. maxLength : 64	string
phoneNumber optional	The phone number of the person, business or institution located at that address, including the country calling code. minLength : 1 maxLength : 20	string
geocode optional	Defines the latitude and longitude of the access point.	Geocode

Geocode

Defines the latitude and longitude of the access point.

Name	Description	Schema
latitude optional	The latitude of access point.	string
longitude optional	The longitude of access point.	string

StateOrRegion

The state, county or region where the person, business or institution is located.

Type : string

City

The city or town where the person, business or institution is located.

Type : string

CountryCode

The two digit country code. Follows ISO 3166-1 alpha-2 format.

Type : string

PostalCode

The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.

Type : string

Location

The location where the person, business or institution is located.

Name	Description	Schema
stateOrRegion optional	The state, county or region where the person, business or institution is located.	StateOrRegion
city optional	The city or town where the person, business or institution is located.	City
countryCode optional	The two digit country code. Follows ISO 3166-1 alpha-2 format.	CountryCode
postalCode optional	The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.	PostalCode

DocumentFormat

The file format of the document.

Type : enum

Value	Description
PDF	The Portable Document Format (PDF) file format. Used to present documents, including text formatting and images, in a manner independent of application software, hardware, and operating systems.
PNG	Portable Network Graphics (PNG) is a raster-graphics file format that supports lossless data compression.
ZPL	Zebra Programming Language (ZPL) format is from Zebra Technologies. It's used primarily for labeling applications and can only be used with ZPL compatible printers.

RequestAttributes

Specify the type of attributes to be added on a label.

Type : < LabelAttribute > array

LabelAttribute

Type : enum

Value	Description
PACKAGE_CLIENT_REFERENCE_ID	Prints client reference ID on the shipping label.
SELLER_DISPLAY_NAME	Prints seller name on the shipping label.
COLLECT_ON_DELIVERY_AMOUNT	Prints Collect On Delivery amount on the shipping label.

DocumentType

The type of shipping document.

Type : enum

Value	Description
PACKSLIP	A listing of the items packed within the shipment.
LABEL	The shipping label for the specific shipment.
RECEIPT	The receipt of the shipment.
CUSTOM_FORM	The customs documentation for a cross-border shipment.

Dpi

The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document.

Type : integer

PageLayout

Indicates the position of the label on the paper. Should be the same value as returned in getRates response.

Type : string

NeedFileJoining

When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false.

Type : boolean

A Base64 encoded string of the file contents.

Type : string

PackageDocumentList

A list of documents related to a package.

Type : < PackageDocument > array

PackageDocument

A document related to a package.

Name	Description	Schema
type required	The type of shipping document.	DocumentType
format required	The file format of the document.	DocumentFormat
contents required	A Base64 encoded string of the file contents.	Contents

PrintOptionList

A list of the format options for a label.

Type : < PrintOption > array

PrintOption

The format options available for a label.

Name	Description	Schema
supportedDPIs optional	A list of the supported DPI options for a document.	< Dpi > array
supportedPageLayouts required	A list of the supported page layout options for a document.	< PageLayout > array
supportedFileJoiningOptions required	A list of the supported needFileJoining boolean values for a document.	< NeedFileJoining > array
supportedDocumentDetails required	A list of the supported documented details.	< SupportedDocumentDetail > array

DocumentSize

The size dimensions of the label.

Name	Description	Schema
width required	The width of the document measured in the units specified.	number
length required	The length of the document measured in the units specified.	number
unit required	The unit of measurement.	enum (Unit)

SupportedDocumentDetail

The supported document types for a service offering.

Name	Description	Schema
name required	The type of shipping document.	DocumentType
isMandatory required	When true, the supported document type is required.	boolean

RequestedDocumentSpecification

The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation.

Name	Description	Schema
format required	The file format of the document.	DocumentFormat
size required	The size dimensions of the label.	DocumentSize
dpi optional	The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document.	Dpi
pageLayout optional	Indicates the position of the label on the paper. Should be the same value as returned in getRates response.	PageLayout
needFileJoining required	When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false.	NeedFileJoining
requestedDocumentTypes required	A list of the document types requested.	< DocumentType > array
requestedLabelCustomization optional	Object contains customised data requested by a shipper to be printed on a shipping label.	< RequestAttributes > array

SupportedDocumentSpecificationList

A list of the document specifications supported for a shipment service offering.

Type : < SupportedDocumentSpecification > array

SupportedDocumentSpecification

Document specification that is supported for a service offering.

Name	Description	Schema
format required	The file format of the document.	DocumentFormat
size required	The size dimensions of the label.	DocumentSize
printOptions required	A list of the format options for a label.	PrintOptionList

Item

An item in a package.

Name	Description	Schema
itemValue optional	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency
description optional	The product description of the item.	string
itemIdentifier Conditional	A unique identifier for an item provided by the client. Please use the orders api and populate this field with the response parameter `OrderItemId` Note: This is Required* field for Amazon Marketplace Orders (ON Amazon type requests).*	string
quantity required	The number of units. This value is required.	integer
weight required	The weight in the units indicated.	Weight
liquidVolume optional	Liquid Volume.	LiquidVolume
isHazmat optional	When true, the item qualifies as hazardous materials (hazmat). Defaults to false.	boolean
dangerousGoodsDetails optional	Details related to any dangerous goods/items that are being shipped.	DangerousGoodsDetails
productType optional	The product type of the item.	string
invoiceDetails optional	The invoice details for charges associated with the goods in the package. Only applies to certain regions.	InvoiceDetails
serialNumbers optional	A list of unique serial numbers in an Amazon package that can be used to guarantee non-fraudulent items. The number of serial numbers in the list must be less than or equal to the quantity of items being shipped. Only applicable when channel source is Amazon.	< string > array
directFulfillmentItemIdentifiers optional	Item identifiers for an item in a direct fulfillment shipment.	DirectFulfillmentItemIdentifiers

ItemList

A list of items.

Type : < Item > array

Package

A package to be shipped through a shipping service offering.

Name	Description	Schema
dimensions required	A set of measurements for a three-dimensional object.	Dimensions
weight required	The weight in the units indicated.	Weight
insuredValue required	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency
isHazmat optional	When true, the package contains hazardous materials. Defaults to false.	boolean
sellerDisplayName optional	The seller name displayed on the label.	string
charges optional	A list of charges based on the shipping service charges applied on a package.	ChargeList
packageClientReferenceId required	A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.	PackageClientReferenceId
items required	A list of items.	ItemList

PackageList

A list of packages to be shipped through a shipping service offering.

Type : < Package > array

DirectFulfillmentItemIdentifiers

Item identifiers for an item in a direct fulfillment shipment.

Name	Description	Schema
lineItemID required	A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated for direct fulfillment multi-piece shipments. It is required if a vendor wants to change the configuration of the packages in which the purchase order is shipped.	string
pieceNumber optional	A unique identifier for an item provided by the client for a direct fulfillment shipment. This is only populated if a single line item has multiple pieces. Defaults to 1.	string

PackageDocumentDetail

The post-purchase details of a package that will be shipped using a shipping service.

Name	Description	Schema
packageClientReferenceId required	A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.	PackageClientReferenceId
packageDocuments required	A list of documents related to a package.	PackageDocumentList
trackingId optional	The carrier generated identifier for a package in a purchased shipment.	TrackingId

PackageDocumentDetailList

A list of post-purchase details about a package that will be shipped using a shipping service.

Type : < PackageDocumentDetail > array

TimeWindow

The start and end time that specifies the time interval of an event.

Name	Description	Schema
start optional	The start time of the time window.	string (date-time)
end optional	The end time of the time window.	string (date-time)

Promise

The time windows promised for pickup and delivery events.

Name	Description	Schema
deliveryWindow optional	The start and end time that specifies the time interval of an event.	TimeWindow
pickupWindow optional	The start and end time that specifies the time interval of an event.	TimeWindow

RequestedValueAddedServiceList

The value-added services to be added to a shipping service purchase.

Type : < RequestedValueAddedService > array

RequestedValueAddedService

A value-added service to be applied to a shipping service purchase.

Name	Description	Schema
id required	The identifier of the selected value-added service. Must be among those returned in the response to the getRates operation.	string

AvailableValueAddedServiceGroupList

A list of value-added services available for a shipping service offering.

Type : < AvailableValueAddedServiceGroup > array

AvailableValueAddedServiceGroup

The value-added services available for purchase with a shipping service offering.

Name	Description	Schema
groupId required	The type of the value-added service group.	string
groupDescription required	The name of the value-added service group.	string
isRequired required	When true, one or more of the value-added services listed must be specified.	boolean
valueAddedServices optional	A list of optional value-added services available for purchase with a shipping service offering.	< ValueAddedService > array

ValueAddedService

A value-added service available for purchase with a shipment service offering.

Name	Description	Schema
id required	The identifier for the value-added service.	string
name required	The name of the value-added service.	string
cost required	The cost of the value-added service.	Currency

CollectOnDelivery

The amount to collect on delivery.

Name	Description	Schema
amount required	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency

ValueAddedServiceDetails

A collection of supported value-added services.

Name	Description	Schema
collectOnDelivery optional	The amount to collect on delivery.	CollectOnDelivery

DangerousGoodsDetails

Details related to any dangerous goods/items that are being shipped.

Name	Description	Schema
unitedNationsRegulatoryId optional	The specific UNID of the item being shipped. Pattern : `"^(UN)[0-9]{4}$"`	string
transportationRegulatoryClass optional	The specific regulatory class of the item being shipped. Pattern : `"^[1-9](\\.[1-9])?$"` Note if `transportationRegulatoryClass` is `2` or `3` then please populate LiquidVolume	string
packingGroup optional	The specific packaging group of the item being shipped.	enum (PackingGroup)
packingInstruction optional	The specific packing instruction of the item being shipped.	enum (PackingInstruction)

TaxType

Indicates the type of tax.

Type : enum

Value	Description
GST	Goods and Services Tax.

TaxDetail

Indicates the tax specifications associated with the shipment for customs compliance purposes in certain regions.

Name	Description	Schema
taxType required	Indicates the type of tax.	TaxType
taxRegistrationNumber required	The shipper's tax registration number associated with the shipment for customs compliance purposes in certain regions.	string

TaxDetailList

A list of tax detail information.

Type : < TaxDetail > array

EventCode

The tracking event type.

Type : enum

Value	Description
ReadyForReceive	Package has been created and is ready for pickup at the shippers location. This is a pre-transit status event code.
PickupDone	Package has been picked up by the service provider.
Delivered	Package has been delivered.
Departed	Package has departed from a particular location in carrier network.
DeliveryAttempted	Delivery was attempted, but was unsuccessful.
Lost	Package is lost.
OutForDelivery	Package is out for delivery.
ArrivedAtCarrierFacility	Package is in transit and has been received at a carrier location.
Rejected	Package was rejected by the recipient.
Undeliverable	Package is undeliverable.
PickupCancelled	Pickup scheduled for the package was cancelled.
ReturnInitiated	Return label has been generated.
AvailableForPickup	Package held for recipient pickup.

Event

A tracking event.

Name	Description	Schema
eventCode required	The tracking event type.	EventCode
location optional	The location where the person, business or institution is located.	Location
eventTime required	The ISO 8601 formatted timestamp of the event.	string (date-time)
shipmentType optional	Shipment type.	ShipmentType

TrackingSummary

A package status summary.

Name	Description	Schema
status optional	The status of the package being shipped.	Status
trackingDetailCodes optional	Contains detail codes that provide additional details related to the forward and return leg of the shipment.	TrackingDetailCodes

Status

The status of the package being shipped.

Type : enum

Value	Description
PreTransit	Package has been created but has not been picked up.
InTransit	Package has been picked up and is in transit.
Delivered	Package has has been delivered successfully.
Lost	Package is lost.
OutForDelivery	Package is out for delivery.
Rejected	Package has been rejected by the recipient.
Undeliverable	Package was undeliverable.
DeliveryAttempted	Delivery was attempted to the recipient location, but was not delivered.
PickupCancelled	Pickup was cancelled for the package.
AwaitingCustomerPickup	Package held at facility for the customer pickup.

AmazonOrderDetails

Amazon order information. This is required if the shipment source channel is Amazon.

Name	Description	Schema
orderId required	The Amazon order ID associated with the Amazon order fulfilled by this shipment.	string

AmazonShipmentDetails

Amazon shipment information.

Name	Description	Schema
shipmentId required	This attribute is required only for a Direct Fulfillment shipment. This is the encrypted shipment ID.	string

ChannelType

The shipment source channel type.

Type : enum

Value	Description
AMAZON	Indicates that the shipment originates from an Amazon order.
EXTERNAL	Indicates that the shipment originates from a non-Amazon channel.

ChannelDetails

Shipment source channel related information.

Name	Description	Schema
channelType required	The shipment source channel type.	ChannelType
amazonOrderDetails optional	Amazon order information. This is required if the shipment source channel is Amazon.	AmazonOrderDetails
amazonShipmentDetails optional	Amazon shipment information.	AmazonShipmentDetails

RateList

A list of eligible shipping service offerings.

Type : < Rate > array

Rate

The details of a shipping service offering.

Name	Description	Schema
rateId required	An identifier for the rate (shipment offering) provided by a shipping service provider.	RateId
carrierId required	The carrier identifier for the offering, provided by the carrier.	CarrierId
carrierName required	The carrier name for the offering.	CarrierName
serviceId required	An identifier for the shipping service.	ServiceId
serviceName required	The name of the shipping service.	ServiceName
billedWeight optional	The weight in the units indicated.	Weight
totalCharge required	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency
promise required	The time windows promised for pickup and delivery events.	Promise
supportedDocumentSpecifications required	A list of the document specifications supported for a shipment service offering.	SupportedDocumentSpecificationList
availableValueAddedServiceGroups optional	A list of value-added services available for a shipping service offering.	AvailableValueAddedServiceGroupList
requiresAdditionalInputs required	When true, indicates that additional inputs are required to purchase this shipment service. You must then call the getAdditionalInputs operation to return the JSON schema to use when providing the additional inputs to the purchaseShipment operation.	boolean
rateItemList optional	A list of RateItem	RateItemList
paymentType optional	Payment type of the purchase.	PaymentType
benefits optional	Representing the included/excluded benefits that we offer for each ShippingOffering/Rate. Benefits being services provided by Amazon when sellers purchase shipping through Amazon.	Benefits

IneligibilityReasonCode

Reasons that make a shipment service offering ineligible.

Type : enum

Value	Description
NO_COVERAGE	The shipment is ineligible because there is no coverage to that address.
PICKUP_SLOT_RESTRICTION	The shipment is ineligible because there is an issue with the pickup slot.
UNSUPPORTED_VAS	The shipment is ineligible because the value-added service is invalid for this shipment.
VAS_COMBINATION_RESTRICTION	The shipment is ineligible because an invalid combination of value-added services were chosen.
SIZE_RESTRICTIONS	The shipment is ineligible because the package dimensions are unsupported.
WEIGHT_RESTRICTIONS	The shipment is ineligible because the weight is unsupported.
LATE_DELIVERY	The shipment is ineligible because delivery is too late.
PROGRAM_CONSTRAINTS	The shipment is ineligible because of program constraints.
TERMS_AND_CONDITIONS_NOT_ACCEPTED	The shipment is ineligible because terms and conditions have not been accepted by the carrier.
UNKNOWN	The ineligibility reason is unknown.

IneligibilityReason

The reason why a shipping service offering is ineligible.

Name	Description	Schema
code required	Reasons that make a shipment service offering ineligible.	IneligibilityReasonCode
message required	The ineligibility reason.	string

IneligibleRate

Detailed information for an ineligible shipping service offering.

Name	Description	Schema
serviceId required	An identifier for the shipping service.	ServiceId
serviceName required	The name of the shipping service.	ServiceName
carrierName required	The carrier name for the offering.	CarrierName
carrierId required	The carrier identifier for the offering, provided by the carrier.	CarrierId
ineligibilityReasons required	A list of reasons why a shipping service offering is ineligible.	< IneligibilityReason > array

IneligibleRateList

A list of ineligible shipping service offerings.

Type : < IneligibleRate > array

CancelShipmentResult

The payload for the cancelShipment operation.

Type : object

CancelShipmentResponse

Response schema for the cancelShipment operation.

Name	Description	Schema
payload optional	The payload for the cancelShipment operation.	CancelShipmentResult

GetRatesRequest

The request schema for the getRates operation. When the channelType is Amazon, the shipTo address is not required and will be ignored.

Name	Description	Schema
shipTo optional	The ship to address.	Address
shipFrom required	The ship from address.	Address
returnTo optional	The return to address.	Address
shipDate optional	The ship date and time (the requested pickup). This defaults to the current date and time.	string (date-time)
shipperInstruction optional	This field describe shipper instruction.	ShipperInstruction
packages required	A list of packages to be shipped through a shipping service offering.	PackageList
valueAddedServices optional	A collection of supported value-added services.	ValueAddedServiceDetails
taxDetails optional	A list of tax detail information.	TaxDetailList
channelDetails required	Shipment source channel related information.	ChannelDetails
clientReferenceDetails optional	Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail	ClientReferenceDetails
shipmentType optional	Shipment type.	ShipmentType
destinationAccessPointDetails optional	-	AccessPointDetails

AccessPointDetails

Name	Description	Schema
accessPointId optional	Unique identifier for the access point	AccessPointId

NdrAction

The type of NDR action shipper wants to take for a particular shipment.

Type : enum

Value	Description
RESCHEDULE	Seller wants to reschedule shipment delivery to a specific date.
REATTEMPT	Seller wants to re-attempt delivery with additional delivery notes.
RTO	Seller wants the shipment to return to the origin.

NdrRequestData

Additional information required for the NDR action that has been filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field. Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required field.

Name	Description	Schema
rescheduleDate optional	The date on which the Seller wants to reschedule shipment delivery, in ISO-8601 date/time format Example : `"2023-12-12T05:24:00.00Z"`	string (date-time)
additionalAddressNotes optional	Address notes to re-attempt delivery with.	AdditionalAddressNotes

GetRatesResult

The payload for the getRates operation.

Name	Description	Schema
requestToken required	A unique token generated to identify a getRates operation.	RequestToken
rates required	A list of eligible shipping service offerings.	RateList
ineligibleRates optional	A list of ineligible shipping service offerings.	IneligibleRateList

GetRatesResponse

The response schema for the getRates operation.

Name	Description	Schema
payload optional	The payload for the getRates operation.	GetRatesResult

GetShipmentDocumentsResult

The payload for the getShipmentDocuments operation.

Name	Description	Schema
shipmentId required	The unique shipment identifier provided by a shipping service.	ShipmentId
packageDocumentDetail required	The post-purchase details of a package that will be shipped using a shipping service.	PackageDocumentDetail
benefits optional	Benefits that are included and excluded for each shipping offer.	Benefits

GetShipmentDocumentsResponse

The response schema for the the getShipmentDocuments operation.

Name	Description	Schema
payload optional	The payload for the getShipmentDocuments operation.	GetShipmentDocumentsResult

GetTrackingResult

The payload for the getTracking operation.

Name	Description	Schema
trackingId required	The carrier generated identifier for a package in a purchased shipment.	TrackingId
alternateLegTrackingId required	The carrier generated reverse identifier for a returned package in a purchased shipment.	AlternateLegTrackingId
eventHistory required	A list of tracking events.	< Event > array
promisedDeliveryDate required	The date and time by which the shipment is promised to be delivered.	string (date-time)
summary required	A package status summary.	TrackingSummary

SubmitNdrFeedbackRequest

The request schema for the NdrFeedback operation

Name	Description	Schema
trackingId required	The carrier generated identifier for a package in a purchased shipment.	TrackingId
ndrAction required	The type of NDR action shipper wants to take for a particular shipment.	NdrAction
ndrRequestData optional	Additional information required for the NDR action that has been filed. If the NDR Action is RESCHEDULE, rescheduleDate is a required field. Otherwise, if the NDR Action is REATTEMPT, additionalAddressNotes is a required field.	NdrRequestData

GetTrackingResponse

The response schema for the getTracking operation.

Name	Description	Schema
payload optional	The payload for the getTracking operation.	GetTrackingResult

PurchaseShipmentRequest

The request schema for the purchaseShipment operation.

Name	Description	Schema
requestToken required	A unique token generated to identify a getRates operation.	RequestToken
rateId required	An identifier for the rate (shipment offering) provided by a shipping service provider.	RateId
requestedDocumentSpecification required	The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation.	RequestedDocumentSpecification
requestedValueAddedServices optional	The value-added services to be added to a shipping service purchase.	RequestedValueAddedServiceList
additionalInputs optional	The additional inputs required to purchase a shipping offering, in JSON format. The JSON provided here must adhere to the JSON schema that is returned in the response to the getAdditionalInputs operation. Additional inputs are only required when indicated by the requiresAdditionalInputs property in the response to the getRates operation.	object

PurchaseShipmentResult

The payload for the purchaseShipment operation.

Name	Description	Schema
shipmentId required	The unique shipment identifier provided by a shipping service.	ShipmentId
packageDocumentDetails required	A list of post-purchase details about a package that will be shipped using a shipping service.	PackageDocumentDetailList
promise required	The time windows promised for pickup and delivery events.	Promise
benefits optional	Benefits that are included and excluded for each shipping offer.	Benefits

PurchaseShipmentResponse

The response schema for the purchaseShipment operation.

Name	Description	Schema
payload optional	The payload for the purchaseShipment operation.	PurchaseShipmentResult

OneClickShipmentRequest

The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.

Name	Description	Schema
shipTo optional	The ship to address.	Address
shipFrom required	The ship from address.	Address
returnTo optional	The return to address.	Address
shipDate optional	The ship date and time (the requested pickup). This defaults to the current date and time.	string (date-time)
packages required	A list of packages to be shipped through a shipping service offering.	PackageList
valueAddedServicesDetails optional	The value-added services to be added to a shipping service purchase.	OneClickShipmentValueAddedServiceDetails
taxDetails optional	A list of tax detail information.	TaxDetailList
channelDetails required	Shipment source channel related information.	ChannelDetails
labelSpecifications required	The document specifications requested. For calls to the purchaseShipment operation, the shipment purchase fails if the specified document specifications are not among those returned in the response to the getRates operation.	RequestedDocumentSpecification
serviceSelection required	Service Selection Criteria.	ServiceSelection
shipperInstruction optional	Optional field for shipper instruction.	ShipperInstruction
destinationAccessPointDetails optional	-	AccessPointDetails

OneClickShipmentResponse

The response schema for the OneClickShipment operation.

Name	Description	Schema
payload optional	The payload for the OneClickShipment API.	OneClickShipmentResult

OneClickShipmentResult

The payload for the OneClickShipment API.

Name	Description	Schema
shipmentId required	The unique shipment identifier provided by a shipping service.	ShipmentId
packageDocumentDetails required	A list of post-purchase details about a package that will be shipped using a shipping service.	PackageDocumentDetailList
promise required	The time windows promised for pickup and delivery events.	Promise
carrier required	Carrier Related Info	Carrier
service required	Service Related Info	Service
totalCharge required	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency

GetAccessPointsResponse

The response schema for the GetAccessPoints operation.

Name	Description	Schema
payload optional	The payload for the GetAccessPoints API.	GetAccessPointsResult

GetAccessPointsResult

The payload for the GetAccessPoints API.

Name	Description	Schema
accessPointsMap required	Map of type of access point to list of access points	AccessPointsMap

AccessPointsMap

Map of type of access point to list of access points

Type : < string, AccessPointList > map

AccessPointId

Unique identifier for the access point

Type : string

GetAdditionalInputsResult

The JSON schema to use to provide additional inputs when required to purchase a shipping offering.

Type : object

GetAdditionalInputsResponse

The response schema for the getAdditionalInputs operation.

Name	Description	Schema
payload optional	The JSON schema to use to provide additional inputs when required to purchase a shipping offering.	GetAdditionalInputsResult

ClientReferenceDetails

Object to pass additional information about the MCI Integrator shipperType: List of ClientReferenceDetail

Type : < ClientReferenceDetail > array

ClientReferenceDetail

Client Reference Details

Name	Description	Schema
clientReferenceType required	Client Reference type.	enum (ClientReferenceType)
clientReferenceId required	The Client Reference Id.	string

ShipmentType

Shipment type.

Type : enum

Value	Description
FORWARD	Additional information about shipment representing package journey from origin address to destination address in the transportation/shipping request.
RETURNS	Additional information about shipment representing package journey from destination address to origin/return address in the original transportation/shipping request.

PaymentType

Payment type of the purchase.

Type : enum

Value	Description
PAY_THROUGH_AMAZON	Payment Through Amazon.
PAY_DIRECT_TO_CARRIER	Payment Direct to Carrier.

RateItemList

A list of RateItem

Type : < RateItem > array

RateItem

Rate Item for shipping (base cost, transaction fee, confirmation, insurance, etc.) Data source definition:

Name	Description	Schema
rateItemID optional	Unique ID for the rateItem.	RateItemID
rateItemType optional	Type of the rateItem.	RateItemType
rateItemCharge optional	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency
rateItemNameLocalization optional	Used for the localization.	string

RateItemID

Unique ID for the rateItem.

Type : enum

Value	Description
BASE_RATE	for Base Rate.
TRANSACTION_FEE	Charge for TransAction Fee.
ADULT_SIGNATURE_CONFIRMATION	Charge for Adult Signature Confirmation.
SIGNATURE_CONFIRMATION	Charge for signature confirmation.
NO_CONFIRMATION	Charge for No Confirmation.
WAIVE_SIGNATURE	Charge for Waive Signature.
IMPLIED_LIABILITY	Charge for Implied Liability.
HIDDEN_POSTAGE	Hidden Postage Charge.
DECLARED_VALUE	Declared Valure Coverage Charge.
SUNDAY_HOLIDAY_DELIVERY	Sunday Holiday Delivery Charge.
DELIVERY_CONFIRMATION	Charge for Delivery Confirmation.
IMPORT_DUTY_CHARGE	Import Duty Charge.
VAT	Vat Charge.
NO_SATURDAY_DELIVERY	Charge for No Satuarday Delivery.
INSURANCE	Insurance Charge.
COD	COD Charge.
FUEL_SURCHARGE	Fuel Surcharge.
INSPECTION_CHARGE	Inspection Charge.
DELIVERY_AREA_SURCHARGE	Delivery Area Surcharge.
WAYBILL_CHARGE	WayBill Charge.
AMAZON_SPONSORED_DISCOUNT	Amazon Sponsored Discount.
INTEGRATOR_SPONSORED_DISCOUNT	Integrator Sponsored Discount.
OVERSIZE_SURCHARGE	OverSize Surcharge.
CONGESTION_CHARGE	Congestion Charge.
RESIDENTIAL_SURCHARGE	Residential Surcharge.
ADDITIONAL_SURCHARGE	Additional Surcharge.
SURCHARGE	Surcharge.
REBATE	Rebate.

RateItemType

Type of the rateItem.

Type : enum

Value	Description
MANDATORY	Rate Item is mandatory.
OPTIONAL	Rate Item is Optional.
INCLUDED	Rate Item is included.

Benefits

Benefits that are included and excluded for each shipping offer. Benefits represents services provided by Amazon (eg. CLAIMS_PROTECTED, etc.) when sellers purchase shipping through Amazon. Benefit details will be made available for any shipment placed on or after January 1st 2024 00:00 UTC.

Name	Description	Schema
includedBenefits required	A list of included benefits.	IncludedBenefits
excludedBenefits required	A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation	ExcludedBenefits

IncludedBenefits

A list of included benefits.

Type : < string > array

ExcludedBenefits

A list of excluded benefit. Refer to the ExcludeBenefit object for further documentation

Type : < ExcludedBenefit > array

ExcludedBenefit

Object representing a benefit that is excluded for a shipping offer or rate.

Name	Description	Schema
benefit required	Benefit that is being excluded from a shipment.	string
reasonCodes required	List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.	ExcludedBenefitReasonCodes

ExcludedBenefitReasonCodes

List of reasons (eg. LATE_DELIVERY_RISK, etc.) indicating why a benefit is excluded for a shipping offer.

Type : < string > array

Min items : 1

ServiceSelection

Service Selection Criteria.

Name	Description	Schema
serviceId required	A list of ServiceId.	ServiceIds

ServiceIds

A list of ServiceId.

Type : < string > array

Please find the current list of service id here.

OneClickShipmentValueAddedServiceDetails

The value-added services to be added to a shipping service purchase.

Type : < OneClickShipmentValueAddedService > array

OneClickShipmentValueAddedService

A value-added service to be applied to a shipping service purchase.

Name	Description	Schema
id required	The identifier of the selected value-added service.	string
amount optional	The monetary value in the currency indicated, in ISO 4217 standard format.	Currency

Service

Service Related Info

Name	Description	Schema
id required	An identifier for the shipping service.	ServiceId
name required	The name of the shipping service.	ServiceName

Carrier

Carrier Related Info

Name	Description	Schema
id required	The carrier identifier for the offering, provided by the carrier.	CarrierId
name required	The carrier name for the offering.	CarrierName

PackingGroup

The specific packaging group of the item being shipped.

Type : enum

Value	Description
I	Packing group I indicates great danger.
II	Packing group II indicates medium danger.
III	Packing group III indicates minor danger.

ClientReferenceType

Client Reference type.

Type : enum

Value	Description
IntegratorShipperId	The unique identifier assigned to a 3P seller by the shipping integrator.
IntegratorMerchantId	The unique identifier assigned to a 3P shipping integrator by Amazon.

ChargeType

The type of charge.

Type : enum

Value	Description
TAX	A tax imposed on a package.
DISCOUNT	A discount deducted from the cost of a package.

PackingInstruction

The specific packing instruction of the item being shipped.

Type : enum

Value	Description
PI965_SECTION_IA	Ion PI965 Section IA (LiBa)
PI965_SECTION_IB	Ion PI965 Section IB (LiBa)
PI965_SECTION_II	Ion PI965 Section II (LiBa)
PI966_SECTION_I	Ion PI966 Section I (LiBa with equipment)
PI966_SECTION_II	Ion PI966 Section II (LiBa with equipment)
PI967_SECTION_I	Ion PI967 Section I (LiBa in equipment)
PI967_SECTION_II	Ion PI967 Section II (LiBa in equipment)
PI968_SECTION_IA	Metal PI968 Section IA (LiBa)
PI968_SECTION_IB	Metal PI968 Section IB (LiBa)
PI969_SECTION_I	Metal PI969 Section I (LiBa with equipment)
PI969_SECTION_II	Metal PI969 Section II (LiBa with equipment)
PI970_SECTION_I	Metal PI970 Section I (LiBa in equipment)
PI970_SECTION_II	Metal PI970 Section II (LiBa in equipment)

X-amzn-shipping-business-id

Amazon shipping business to assume for this request. The default is AmazonShipping_UK.

Type : enum

Value	Description
AmazonShipping_US	The United States Amazon shipping business.
AmazonShipping_IN	The India Amazon shipping business.
AmazonShipping_UK	The United Kingdom Amazon shipping business.
AmazonShipping_IT	The Italy Amazon shipping business.
AmazonShipping_ES	The Spain Amazon shipping business.
AmazonShipping_FR	The France Amazon shipping business.

carrier-id

Amazon shipping carrier-id to be used for tracking api.

Type : enum

Value	Description
AMZN_US	The United States Amazon shipping carrier id.
ATS	The India Amazon shipping carrier id.
AMZN_UK	The United Kingdom Amazon shipping carrier id.
AMZN_IT	The Italy Amazon shipping carrier id.
AMZN_ES	The Spain Amazon shipping carrier id.
AMZN_FR	The France Amazon shipping carrier id.

AccessPointTypes

Type : enum

Value	Description
HELIX	Available now for AccessPoints APIs
CAMPUS_LOCKER	-
OMNI_LOCKER	-
ODIN_LOCKER	-
DOBBY_LOCKER	-
CORE_LOCKER	-
3P	-
CAMPUS_ROOM	-

Unit

Type : enum

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

Value	Description
ML	Milliliter - Metric unit of volume.
L	Liter - Metric unit of volume.
FL_OZ	Fluid Ounce - Imperial unit of volume.
GAL	Gallon - Imperial unit of volume.
PT	Pint - Imperial unit of volume.
QT	Quart - Imperial unit of volume.
C	Cup - Imperial unit of volume.

For use with the definition(s): Dimensions, DocumentSize
The unit of measurement.

Value	Description
INCH	The imperial unit of length equal to one twelfth of a foot.
CENTIMETER	A metric unit of length, equal to one hundredth of a meter.

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

Value	Description
GRAM	Metric unit of mass equal to one thousandth of a kilogram.
KILOGRAM	Metric unit of mass.
OUNCE	The imperial unit of weight that is one sixteenth of a pound.
POUND	The imperial unit of weight.