/shipping/v2/oneClickShipment

post

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

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

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 and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

Body Params

shipTo

object

The address.

shipFrom

object

required

The address.

returnTo

object

The address.

shipDate

date-time

The ship date and time (the requested pickup). This defaults to the current date and time.

goodsOwner

object

The seller owning the goods before handing them over to the carrier

packages

array of objects

required

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

packages*

valueAddedServicesDetails

array of objects

This field is deprecated. This field only supports the Collect on Delivery (COD) value added service.

valueAddedServicesDetails

valueAddedServices

object

A collection of supported value-added services.

taxDetails

array of objects

A list of tax detail information.

taxDetails

channelDetails

object

required

Shipment source channel related information.

labelSpecifications

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.

serviceSelection

object

required

Service Selection Criteria.

shipperInstruction

object

The shipper instruction.

destinationAccessPointDetails

object

AccessPointDetails object

Headers

x-amz-access-token

string

required

Amazon shipping request token

x-amzn-shipping-business-id

string

enum

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

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.

Allowed:

Responses

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.