/shipping/v2/shipments

post https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/shipments

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

Body Params

requestToken

string

required

A unique token generated to identify a getRates operation.

rateId

string

required

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

requestedDocumentSpecification

object

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.

requestedValueAddedServices

array of objects

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

requestedValueAddedServices

additionalInputs

object

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.

Headers

x-amz-access-token

string

required

Amazon shipping request token

x-amzn-shipping-business-id

string

required

Amazon shipping business to assume for this request.

Show Details

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.

Responses

xxxxxxxxxx
curl --request POST \
     --url https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/shipments \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-amzn-shipping-business-id: AmazonShipping_US' \
     --data '
{
  "requestedDocumentSpecification": {
    "format": "PDF",
    "size": {
      "unit": "INCH"
    },
    "needFileJoining": true
  }
}
'

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.

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.

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.