Shipping API v1 Reference

Provides programmatic access to Amazon Shipping APIs.

Overview

Provides programmatic access to Amazon Shipping APIs.

Note: If you are new to the Amazon Shipping API, refer to the latest version of Amazon Shipping API (v2) on the Amazon Shipping Developer Documentation site.

Version information

Version : v1

Contact information

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

License information

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

URI scheme

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

Consumes

application/json

Produces

application/json

Operations

createShipment
getShipment
cancelShipment
purchaseLabels
retrieveShippingLabel
purchaseShipment
getRates
getAccount
getTrackingInformation

Paths

POST /shipping/v1/shipments

Operation: createShipment

Description

Create a new shipment.

Usage Plan:

Rate (requests per second)	Burst
5	15

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

Parameters

Type	Name	Description	Schema
Body	body required	The request schema for the createShipment operation.	CreateShipmentRequest

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 id.	CreateShipmentResponse
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 id.	CreateShipmentResponse
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 id.	CreateShipmentResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	CreateShipmentResponse
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 id.	CreateShipmentResponse
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 id.	CreateShipmentResponse
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 id.	CreateShipmentResponse
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 id.	CreateShipmentResponse

GET /shipping/v1/shipments/{shipmentId}

Operation: getShipment

Description

Return the entire shipment object for the shipmentId.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Schema
Path	shipmentId required	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 id.	GetShipmentResponse
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 id.	GetShipmentResponse
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 id.	GetShipmentResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	GetShipmentResponse
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 id.	GetShipmentResponse
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 id.	GetShipmentResponse
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 id.	GetShipmentResponse
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 id.	GetShipmentResponse

POST /shipping/v1/shipments/{shipmentId}/cancel

Operation: cancelShipment

Description

Cancel a shipment by the given shipmentId.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Schema
Path	shipmentId required	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 id.	CancelShipmentResponse
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 id.	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 id.	CancelShipmentResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	CancelShipmentResponse
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 id.	CancelShipmentResponse
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 id.	CancelShipmentResponse
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 id.	CancelShipmentResponse
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 id.	CancelShipmentResponse

POST /shipping/v1/shipments/{shipmentId}/purchaseLabels

Operation: purchaseLabels

Description

Purchase shipping labels based on a given rate.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	shipmentId required	-	string
Body	body required	The request schema for the purchaseLabels operation.	PurchaseLabelsRequest

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 id.	PurchaseLabelsResponse
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 id.	PurchaseLabelsResponse
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 id.	PurchaseLabelsResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	PurchaseLabelsResponse
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 id.	PurchaseLabelsResponse
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 id.	PurchaseLabelsResponse
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 id.	PurchaseLabelsResponse
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 id.	PurchaseLabelsResponse

POST /shipping/v1/shipments/{shipmentId}/containers/{trackingId}/label

Operation: retrieveShippingLabel

Description

Retrieve shipping label based on the shipment id and tracking id.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Path	shipmentId required	-	string
Path	trackingId required	-	string
Body	body required	The request schema for the retrieveShippingLabel operation.	RetrieveShippingLabelRequest

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 id.	RetrieveShippingLabelResponse
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 id.	RetrieveShippingLabelResponse
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 id.	RetrieveShippingLabelResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	RetrieveShippingLabelResponse
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 id.	RetrieveShippingLabelResponse
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 id.	RetrieveShippingLabelResponse
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 id.	RetrieveShippingLabelResponse
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 id.	RetrieveShippingLabelResponse

POST /shipping/v1/purchaseShipment

Operation: purchaseShipment

Description

Purchase shipping labels.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Body	body required	The payload schema for the purchaseShipment operation.	PurchaseShipmentRequest

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 id.	PurchaseShipmentResponse
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 id.	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 id.	PurchaseShipmentResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	PurchaseShipmentResponse
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 id.	PurchaseShipmentResponse
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 id.	PurchaseShipmentResponse
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 id.	PurchaseShipmentResponse
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 id.	PurchaseShipmentResponse

POST /shipping/v1/rates

Operation: getRates

Description

Get service rates.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Description	Schema
Body	body required	The payload schema for the getRates operation.	GetRatesRequest

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 id.	GetRatesResponse
400	Request is missing or has 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 id.	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 id.	GetRatesResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	GetRatesResponse
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 id.	GetRatesResponse
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 id.	GetRatesResponse
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 id.	GetRatesResponse
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 id.	GetRatesResponse

GET /shipping/v1/account

Operation: getAccount

Description

Verify if the current account is valid.

Usage Plan:

Rate (requests per second)	Burst
5	15

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Responses

HTTP Code	Description	Schema
200	The account was valid. Headers : `x-amzn-RateLimit-Limit` (string) : Your rate limit (requests per second) for this operation. `x-amzn-RequestId` (string) : Unique request reference id.	GetAccountResponse
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 id.	GetAccountResponse
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 id.	GetAccountResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	GetAccountResponse
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 id.	GetAccountResponse
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 id.	GetAccountResponse
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 id.	GetAccountResponse
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 id.	GetAccountResponse

GET /shipping/v1/tracking/{trackingId}

Operation: getTrackingInformation

Description

Return the tracking information of a shipment.

Usage Plan:

Rate (requests per second)	Burst
1	1

For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

Parameters

Type	Name	Schema
Path	trackingId required	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 id.	GetTrackingInformationResponse
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 id.	GetTrackingInformationResponse
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 id.	GetTrackingInformationResponse
403	403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers : `x-amzn-RequestId` (string) : Unique request reference id.	GetTrackingInformationResponse
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 id.	GetTrackingInformationResponse
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 id.	GetTrackingInformationResponse
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 id.	GetTrackingInformationResponse
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 id.	GetTrackingInformationResponse

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 occured.	string
message required	A message that describes the error condition in a human-readable form.	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.

Type : < Error > array

AccountId

This is the Amazon Shipping account id generated during the Amazon Shipping onboarding process.

Type : string

maxLength : 10

ShipmentId

The unique shipment identifier.

Type : string

ClientReferenceId

Client reference id.

Type : string

maxLength : 40

ContainerReferenceId

An identifier for the container. This must be unique within all the containers in the same shipment.

Type : string

maxLength : 40

EventCode

The event code of a shipment, such as Departed, Received, and ReadyForReceive.

Type : string

minLength : 1
maxLength : 60

StateOrRegion

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

Type : string

City

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

Type : string

minLength : 1
maxLength : 50

CountryCode

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

Type : string

minLength : 2
maxLength : 2

PostalCode

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

Type : string

minLength : 1
maxLength : 20

Location

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

Name	Description	Schema
stateOrRegion optional	The state or region where the person, business or institution is located.	StateOrRegion
city optional	The city where the person, business or institution is located.	City
countryCode optional	The two digit country code. In 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

Event

An event of a shipment

Name	Description	Schema
eventCode required	The event code of a shipment, such as Departed, Received, and ReadyForReceive.	EventCode
eventTime required	The date and time of an event for a shipment.	string (date-time)
location optional	The location where the person, business or institution is located.	Location

EventList

A list of events of a shipment.

Type : < Event > array

TrackingId

The tracking id generated to each shipment. It contains a series of letters or digits or both.

Type : string

minLength : 1
maxLength : 60

TrackingSummary

The tracking summary.

Name	Description	Schema
status optional	The derived status based on the events in the eventHistory. minLength : 1 maxLength : 60	string

PromisedDeliveryDate

The promised delivery date and time of a shipment.

Type : string (date-time)

Address

The address.

Name	Description	Schema
name required	The name of the person, business or institution at that address. minLength : 1 maxLength : 50	string
addressLine1 required	First line of that 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
stateOrRegion required	The state or region where the person, business or institution is located.	StateOrRegion
city required	The city where the person, business or institution is located.	City
countryCode required	The two digit country code. In 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
copyEmails optional	The email cc addresses of the contact associated with the address.	< string > array
phoneNumber optional	The phone number of the person, business or institution located at that address. minLength : 1 maxLength : 20	string

TimeRange

The time range.

Name	Description	Schema
start optional	The start date and time. This defaults to the current date and time.	string (date-time)
end optional	The end date and time. This must come after the value of start. This defaults to the next business day from the start.	string (date-time)

ShippingPromiseSet

The promised delivery time and pickup time.

Name	Description	Schema
deliveryWindow optional	The time window in which the shipment will be delivered.	TimeRange
receiveWindow optional	The time window in which Amazon Shipping will pick up the shipment.	TimeRange

ServiceType

The type of shipping service that will be used for the service offering.

Type : enum

Value	Description
Amazon Shipping Ground	Amazon Shipping Ground.
Amazon Shipping Standard	Amazon Shipping Standard.
Amazon Shipping Premium	Amazon Shipping Premium.

ServiceTypeList

A list of service types that can be used to send the shipment.

Type : < ServiceType > array

Rate

The available rate that can be used to send the shipment

Name	Description	Schema
rateId optional	An identifier for the rate.	string
totalCharge optional	The total charge that will be billed for the rate.	Currency
billedWeight optional	The weight that was used to calculate the totalCharge.	Weight
expirationTime optional	The time after which the offering will expire.	string (date-time)
serviceType optional	The type of shipping service that will be used for the service offering.	ServiceType
promise optional	The promised delivery time and pickup time.	ShippingPromiseSet

RateList

A list of all the available rates that can be used to send the shipment.

Type : < Rate > array

RateId

An identifier for the rating.

Type : string

AcceptedRate

The specific rate purchased for the shipment, or null if unpurchased.

Name	Description	Schema
totalCharge optional	The total charge that will be billed for the rate.	Currency
billedWeight optional	The weight that was used to calculate the totalCharge.	Weight
serviceType optional	The type of shipping service that will be used for the service offering.	ServiceType
promise optional	The promised delivery time and pickup time.	ShippingPromiseSet

ServiceRate

The specific rate for a shipping service, or null if no service available.

Name	Description	Schema
totalCharge required	The total charge that will be billed for the rate.	Currency
billableWeight required	The weight that was used to calculate the totalCharge.	Weight
serviceType required	The type of shipping service that will be used for the service offering.	ServiceType
promise required	The promised delivery time and pickup time.	ShippingPromiseSet

ServiceRateList

A list of service rates.

Type : < ServiceRate > array

Party

The account related with the shipment.

Name	Description	Schema
accountId optional	This is the Amazon Shipping account id generated during the Amazon Shipping onboarding process.	AccountId

Currency

The total value of all items in the container.

Name	Description	Schema
value required	The amount of currency.	number
unit required	A 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 container.	number
width required	The width of the container.	number
height required	The height of the container.	number
unit required	The unit of these measurements.	enum (Unit)

Weight

The weight.

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

ContainerItem

Item in the container.

Name	Description	Schema
quantity required	The quantity of the items of this type in the container.	number
unitPrice required	The unit price of an item of this type (the total value of this item type in the container is unitPrice quantity).	Currency
unitWeight required	The unit weight of an item of this type (the total weight of this item type in the container is unitWeight quantity).	Weight
title required	A descriptive title of the item. maxLength : 30	string

Container

Container in the shipment.

Name	Description	Schema
containerType optional	The type of physical container being used. (always 'PACKAGE')	enum (ContainerType)
containerReferenceId required	An identifier for the container. This must be unique within all the containers in the same shipment.	ContainerReferenceId
value required	The total value of all items in the container.	Currency
dimensions required	The length, width, height, and weight of the container.	Dimensions
items required	A list of the items in the container.	< ContainerItem > array
weight required	The weight of the container.	Weight

ContainerList

A list of container.

Type : < Container > array

ContainerSpecification

Container specification for checking the service rate.

Name	Description	Schema
dimensions required	The length, width, and height of the container.	Dimensions
weight required	The weight of the container.	Weight

ContainerSpecificationList

A list of container specifications.

Type : < ContainerSpecification > array

Label

The label details of the container.

Name	Description	Schema
labelStream optional	Contains binary image data encoded as a base-64 string.	LabelStream
labelSpecification optional	The label specification info.	LabelSpecification

LabelResult

Label details including label stream, format, size.

Name	Description	Schema
containerReferenceId optional	An identifier for the container. This must be unique within all the containers in the same shipment.	ContainerReferenceId
trackingId optional	The tracking identifier assigned to the container.	string
label optional	The label details of the container.	Label

LabelResultList

A list of label results

Type : < LabelResult > array

LabelStream

Contains binary image data encoded as a base-64 string.

Type : string

LabelSpecification

The label specification info.

Name	Description	Schema
labelFormat required	The format of the label. Enum of PNG only for now.	enum (LabelFormat)
labelStockSize required	The label stock size specification in length and height. Enum of 4x6 only for now.	enum (LabelStockSize)

CreateShipmentRequest

The request schema for the createShipment operation.

Name	Description	Schema
clientReferenceId required	Client reference id.	ClientReferenceId
shipTo required	The address.	Address
shipFrom required	The address.	Address
containers required	A list of container.	ContainerList

PurchaseLabelsRequest

The request schema for the purchaseLabels operation.

Name	Description	Schema
rateId required	An identifier for the rating.	RateId
labelSpecification required	The label specification info.	LabelSpecification

RetrieveShippingLabelRequest

The request schema for the retrieveShippingLabel operation.

Name	Description	Schema
labelSpecification required	The label specification info.	LabelSpecification

GetRatesRequest

The payload schema for the getRates operation.

Name	Description	Schema
shipTo required	The address.	Address
shipFrom required	The address.	Address
serviceTypes required	A list of service types that can be used to send the shipment.	ServiceTypeList
shipDate optional	The start date and time. This defaults to the current date and time.	string (date-time)
containerSpecifications required	A list of container specifications.	ContainerSpecificationList

PurchaseShipmentRequest

The payload schema for the purchaseShipment operation.

Name	Description	Schema
clientReferenceId required	Client reference id.	ClientReferenceId
shipTo required	The address.	Address
shipFrom required	The address.	Address
shipDate optional	The start date and time. This defaults to the current date and time.	string (date-time)
serviceType required	The type of shipping service that will be used for the service offering.	ServiceType
containers required	A list of container.	ContainerList
labelSpecification required	The label specification info.	LabelSpecification

CreateShipmentResult

The payload schema for the createShipment operation.

Name	Description	Schema
shipmentId required	The unique shipment identifier.	ShipmentId
eligibleRates required	A list of all the available rates that can be used to send the shipment.	RateList

Shipment

The shipment related data.

Name	Description	Schema
shipmentId required	The unique shipment identifier.	ShipmentId
clientReferenceId required	Client reference id.	ClientReferenceId
shipFrom required	The address.	Address
shipTo required	The address.	Address
acceptedRate optional	The specific rate purchased for the shipment, or null if unpurchased.	AcceptedRate
shipper optional	The account related with the shipment.	Party
containers required	A list of container.	ContainerList

PurchaseLabelsResult

The payload schema for the purchaseLabels operation.

Name	Description	Schema
shipmentId required	The unique shipment identifier.	ShipmentId
clientReferenceId optional	Client reference id.	ClientReferenceId
acceptedRate required	The specific rate purchased for the shipment, or null if unpurchased.	AcceptedRate
labelResults required	A list of label results	LabelResultList

RetrieveShippingLabelResult

The payload schema for the retrieveShippingLabel operation.

Name	Description	Schema
labelStream required	Contains binary image data encoded as a base-64 string.	LabelStream
labelSpecification required	The label specification info.	LabelSpecification

Account

The account related data.

Name	Description	Schema
accountId required	This is the Amazon Shipping account id generated during the Amazon Shipping onboarding process.	AccountId

GetRatesResult

The payload schema for the getRates operation.

Name	Description	Schema
serviceRates required	A list of service rates.	ServiceRateList

PurchaseShipmentResult

The payload schema for the purchaseShipment operation.

Name	Description	Schema
shipmentId required	The unique shipment identifier.	ShipmentId
serviceRate required	The specific rate for a shipping service, or null if no service available.	ServiceRate
labelResults required	A list of label results	LabelResultList

TrackingInformation

The payload schema for the getTrackingInformation operation.

Name	Description	Schema
trackingId required	The tracking id generated to each shipment. It contains a series of letters or digits or both.	TrackingId
summary required	The tracking summary.	TrackingSummary
promisedDeliveryDate required	The promised delivery date and time of a shipment.	PromisedDeliveryDate
eventHistory required	A list of events of a shipment.	EventList

CreateShipmentResponse

The response schema for the createShipment operation.

Name	Description	Schema
payload optional	The payload for createShipment operation	CreateShipmentResult
errors optional	Encountered errors for the operation.	ErrorList

GetShipmentResponse

The response schema for the getShipment operation.

Name	Description	Schema
payload optional	The payload for getShipment operation	Shipment
errors optional	Encountered errors for the operation.	ErrorList

GetRatesResponse

The response schema for the getRates operation.

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

PurchaseShipmentResponse

The response schema for the purchaseShipment operation.

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

CancelShipmentResponse

The response schema for the cancelShipment operation.

Name	Description	Schema
errors optional	Encountered errors for the operation.	ErrorList

PurchaseLabelsResponse

The response schema for the purchaseLabels operation.

Name	Description	Schema
payload optional	The payload for purchaseLabels operation	PurchaseLabelsResult
errors optional	Encountered errors for the operation.	ErrorList

RetrieveShippingLabelResponse

The response schema for the retrieveShippingLabel operation.

Name	Description	Schema
payload optional	The payload for retrieveShippingLabel operation	RetrieveShippingLabelResult
errors optional	Encountered errors for the operation.	ErrorList

GetAccountResponse

The response schema for the getAccount operation.

Name	Description	Schema
payload optional	The payload for getAccount operation	Account
errors optional	Encountered errors for the operation.	ErrorList

GetTrackingInformationResponse

The response schema for the getTrackingInformation operation.

Name	Description	Schema
payload optional	The payload for getTrackingInformation operation	TrackingInformation
errors optional	Encountered errors for the operation.	ErrorList

LabelFormat

The format of the label. Enum of PNG only for now.

Type : enum

Value	Description
PNG	PNG

ContainerType

The type of physical container being used. (always 'PACKAGE')

Type : enum

Value	Description
PACKAGE	PACKAGE

LabelStockSize

The label stock size specification in length and height. Enum of 4x6 only for now.

Type : enum

Value	Description
4x6	4x6

Unit

Type : enum

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

Value	Description
g	Grams
kg	Kilograms
oz	Ounces
lb	Pounds

For use with the definition(s): Dimensions
The unit of these measurements.

Value	Description
IN	Inches
CM	Centimeters

Updated 4 months ago