Shipping API v1 reference

Provides programmatic access to Amazon Shipping APIs.

Overview

Provides programmatic access to Amazon Shipping APIs.

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
515

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

Parameters

TypeNameDescriptionSchema
Bodybody
required
The request schema for the createShipment operation.CreateShipmentRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
CreateShipmentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
CreateShipmentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CreateShipmentResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
CreateShipmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CreateShipmentResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference 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
515

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

Parameters

TypeNameSchema
PathshipmentId
required
string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetShipmentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetShipmentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetShipmentResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetShipmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetShipmentResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference 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
515

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

Parameters

TypeNameSchema
PathshipmentId
required
string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference 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
515

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

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
-string
Bodybody
required
The request schema for the purchaseLabels operation.PurchaseLabelsRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseLabelsResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseLabelsResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseLabelsResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseLabelsResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseLabelsResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference 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
515

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

Parameters

TypeNameDescriptionSchema
PathshipmentId
required
-string
PathtrackingId
required
-string
Bodybody
required
The request schema for the retrieveShippingLabel operation.RetrieveShippingLabelRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
RetrieveShippingLabelResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
RetrieveShippingLabelResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
RetrieveShippingLabelResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
RetrieveShippingLabelResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
RetrieveShippingLabelResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
RetrieveShippingLabelResponse

POST /shipping/v1/purchaseShipment

Operation: purchaseShipment

Description

Purchase shipping labels.

Usage Plan:

Rate (requests per second)Burst
515

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

Parameters

TypeNameDescriptionSchema
Bodybody
required
The payload schema for the purchaseShipment operation.PurchaseShipmentRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse

POST /shipping/v1/rates

Operation: getRates

Description

Get service rates.

Usage Plan:

Rate (requests per second)Burst
515

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

Parameters

TypeNameDescriptionSchema
Bodybody
required
The payload schema for the getRates operation.GetRatesRequest

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetRatesResponse
400Request 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
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetRatesResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetRatesResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetRatesResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetRatesResponse

GET /shipping/v1/account

Operation: getAccount

Description

Verify if the current account is valid.

Usage Plan:

Rate (requests per second)Burst
515

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

Responses

HTTP CodeDescriptionSchema
200The 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
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetAccountResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetAccountResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetAccountResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetAccountResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetAccountResponse

GET /shipping/v1/tracking/{trackingId}

Operation: getTrackingInformation

Description

Return the tracking information of a shipment.

Usage Plan:

Rate (requests per second)Burst
11

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

Parameters

TypeNameSchema
PathtrackingId
required
string

Responses

HTTP CodeDescriptionSchema
200Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
400Request has missing or invalid parameters and cannot be parsed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
401The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
403403 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
404The resource specified does not exist.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
429The frequency of requests was greater than allowed.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
500Encountered 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
503Temporary overloading or maintenance of the server.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse

Definitions

Error

Error response returned when the request is unsuccessful.

NameDescriptionSchema
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.

NameDescriptionSchema
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

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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

ValueDescription
Amazon Shipping GroundAmazon Shipping Ground.
Amazon Shipping StandardAmazon Shipping Standard.
Amazon Shipping PremiumAmazon 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

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
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.

NameDescriptionSchema
unit
required
The unit of measurement.enum (Unit)
value
required
The measurement value.number

ContainerItem

Item in the container.

NameDescriptionSchema
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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    rateId
    required
    An identifier for the rating.RateId
    labelSpecification
    required
    The label specification info.LabelSpecification

    RetrieveShippingLabelRequest

    The request schema for the retrieveShippingLabel operation.

    NameDescriptionSchema
    labelSpecification
    required
    The label specification info.LabelSpecification

    GetRatesRequest

    The payload schema for the getRates operation.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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 resultsLabelResultList

    RetrieveShippingLabelResult

    The payload schema for the retrieveShippingLabel operation.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    serviceRates
    required
    A list of service rates.ServiceRateList

    PurchaseShipmentResult

    The payload schema for the purchaseShipment operation.

    NameDescriptionSchema
    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 resultsLabelResultList

    TrackingInformation

    The payload schema for the getTrackingInformation operation.

    NameDescriptionSchema
    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.

    NameDescriptionSchema
    payload
    optional
    The payload for createShipment operationCreateShipmentResult
    errors
    optional
    Encountered errors for the operation.ErrorList

    GetShipmentResponse

    The response schema for the getShipment operation.

    NameDescriptionSchema
    payload
    optional
    The payload for getShipment operationShipment
    errors
    optional
    Encountered errors for the operation.ErrorList

    GetRatesResponse

    The response schema for the getRates operation.

    NameDescriptionSchema
    payload
    optional
    The payload for getRates operationGetRatesResult
    errors
    optional
    Encountered errors for the operation.ErrorList

    PurchaseShipmentResponse

    The response schema for the purchaseShipment operation.

    NameDescriptionSchema
    payload
    optional
    The payload for purchaseShipment operationPurchaseShipmentResult
    errors
    optional
    Encountered errors for the operation.ErrorList

    CancelShipmentResponse

    The response schema for the cancelShipment operation.

    NameDescriptionSchema
    errors
    optional
    Encountered errors for the operation.ErrorList

    PurchaseLabelsResponse

    The response schema for the purchaseLabels operation.

    NameDescriptionSchema
    payload
    optional
    The payload for purchaseLabels operationPurchaseLabelsResult
    errors
    optional
    Encountered errors for the operation.ErrorList

    RetrieveShippingLabelResponse

    The response schema for the retrieveShippingLabel operation.

    NameDescriptionSchema
    payload
    optional
    The payload for retrieveShippingLabel operationRetrieveShippingLabelResult
    errors
    optional
    Encountered errors for the operation.ErrorList

    GetAccountResponse

    The response schema for the getAccount operation.

    NameDescriptionSchema
    payload
    optional
    The payload for getAccount operationAccount
    errors
    optional
    Encountered errors for the operation.ErrorList

    GetTrackingInformationResponse

    The response schema for the getTrackingInformation operation.

    NameDescriptionSchema
    payload
    optional
    The payload for getTrackingInformation operationTrackingInformation
    errors
    optional
    Encountered errors for the operation.ErrorList

    LabelFormat

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

    Type : enum

    ValueDescription
    PNGPNG

    ContainerType

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

    Type : enum

    ValueDescription
    PACKAGEPACKAGE

    LabelStockSize

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

    Type : enum

    ValueDescription
    4x64x6

    Unit

    Type : enum

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

    ValueDescription
    gGrams
    kgKilograms
    ozOunces
    lbPounds

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

    ValueDescription
    INInches
    CMCentimeters