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

time	status	user agent
Retrieving recent requests…

Loading…

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.

packages

array of objects

required

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

packages*

valueAddedServicesDetails

array of objects

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

valueAddedServicesDetails

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

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

Response body

object

payload

object

The payload for the OneClickShipment API.

shipmentId

string

required

The unique shipment identifier provided by a shipping service.

packageDocumentDetails

array of objects

required

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

packageDocumentDetails*

object

packageClientReferenceId

string

required

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

packageDocuments

array of objects

required

A list of documents related to a package.

packageDocuments*

object

type

string

required

The type of shipping document.

PACKSLIP LABEL RECEIPT CUSTOM_FORM

Show Details

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.

format

string

required

The file format of the document.

PDF PNG ZPL

Show Details

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.

contents

string

required

A Base64 encoded string of the file contents.

trackingId

string

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

promise

object

required

The time windows promised for pickup and delivery events.

carrier

object

required

Carrier Related Info

service

object

required

Service Related Info

totalCharge

object

required

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

Headers

object

x-amzn-RequestId

string

Unique request reference identifier.

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

Language

URL


xxxxxxxxxx
19
1
curl --request POST \
2
     --url https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/oneClickShipment \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --header 'x-amzn-shipping-business-id: AmazonShipping_US' \
6
     --data '
7
{
8
  "channelDetails": {
9
    "channelType": "AMAZON"
10
  },
11
  "labelSpecifications": {
12
    "format": "PDF",
13
    "size": {
14
      "unit": "INCH"
15
    },
16
    "needFileJoining": true
17
  }
18
}
19
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.