oneClickShipment - Amazon SP API

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

Usage Plan:

Rate (requests per second)	Burst
80	100

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.

Request

Header Params

x-amzn-shipping-business-id

enum<string>

optional

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

Allowed values:

AmazonShipping_USAmazonShipping_INAmazonShipping_UKAmazonShipping_UAEAmazonShipping_SAAmazonShipping_EGAmazonShipping_ITAmazonShipping_ESAmazonShipping_FRAmazonShipping_JP

Body Params application/json

The request schema for the OneClickShipment operation. When the channelType is not Amazon, shipTo is required and when channelType is Amazon shipTo is ignored.

shipTo

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

{"addressLine1":"address_1","addressLine2":"address_2","addressLine3":"address_3","city":"Seattle","countryCode":"US","county":"Washington","district":"District1","name":"address_name","phoneNumber":"+14155552671","postalCode":"123456","stateOrRegion":"Washington"}

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

shipFrom

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

returnTo

object (Address)

optional

Shipping address that represents the origin or destination location.

Example:

shipDate

string <date-time>

optional

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

packages

array[object (Package) {9}]

required

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

scheduledPackageId

object (ScheduledPackageId)

required

Identifies the scheduled package to be updated.

packageDimensions

object (Dimensions)

required

Dimensions of an Amazon catalog item or item in its packaging.

packageWeight

object (Weight)

required

The weight of the scheduled package

packageItems

array[object (Item) {7}]

optional

A list of items contained in the package.

<= 500 items

packageTimeSlot

object (TimeSlot)

required

A time window to hand over an Easy Ship package to Amazon Logistics.

packageIdentifier

string

optional

Optional seller-created identifier that is printed on the shipping label to help the seller identify the package.

invoice

object (InvoiceData)

optional

Invoice number and date.

packageStatus

enum<string>

optional

The status of the package.

Allowed values:

ReadyForPickupPickedUpAtOriginFCAtDestinationFCDeliveredRejectedUndeliverableReturnedToSellerLostInTransitLabelCanceledDamagedInTransitOutForDelivery

trackingDetails

object (TrackingDetails)

optional

Representation of tracking metadata.

valueAddedServicesDetails

array[object (OneClickShipmentValueAddedService) {2}]

optional

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

string

required

The identifier of the selected value-added service.

amount

object (Currency)

optional

The type and amount of currency.

taxDetails

array[object (TaxDetail) {2}]

optional

A list of tax detail information.

taxType

enum<string>

required

Indicates the type of tax.

Allowed value:

GST

taxRegistrationNumber

string

required

The shipper's tax registration number associated with the shipment for customs compliance purposes in certain regions.

channelDetails

object (ChannelDetails)

required

Shipment source channel related information.

channelType

enum<string>

required

The shipment source channel type.

Allowed values:

AMAZONEXTERNAL

amazonOrderDetails

object (AmazonOrderDetails)

optional

Amazon order information. This is required if the shipment source channel is Amazon.

amazonShipmentDetails

object (AmazonShipmentDetails)

optional

Amazon shipment information.

labelSpecifications

object (RequestedDocumentSpecification)

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.

format

enum<string>

required

The file format of the document.

Allowed values:

PDFPNGZPL

size

object (DocumentSize)

required

The size dimensions of the label.

dpi

integer

optional

The dots per inch (DPI) value used in printing. This value represents a measure of the resolution of the document.

pageLayout

string

optional

Indicates the position of the label on the paper. Should be the same value as returned in getRates response.

needFileJoining

boolean

required

When true, files should be stitched together. Otherwise, files should be returned separately. Defaults to false.

requestedDocumentTypes

array[string]

required

A list of the document types requested.

Allowed values:

PACKSLIPLABELRECEIPTCUSTOM_FORM

serviceSelection

object (ServiceSelection)

required

Service Selection Criteria.

serviceId

array[string]

required

A list of ServiceId.

shipperInstruction

object (ShipperInstruction)

optional

The shipper instruction.

deliveryNotes

string

optional

The delivery notes for the shipment

<= 256 characters

destinationAccessPointDetails

object (AccessPointDetails)

optional

accessPointId

string

optional

Unique identifier for the access point

Example

{
    "shipTo": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "shipFrom": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "returnTo": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "shipDate": "2019-08-24T14:15:22Z",
    "packages": [
        {
            "scheduledPackageId": {
                "amazonOrderId": "string",
                "packageId": "string"
            },
            "packageDimensions": {
                "height": {
                    "unit": "string",
                    "value": 0
                },
                "length": {
                    "unit": "string",
                    "value": 0
                },
                "weight": {
                    "unit": "string",
                    "value": 0
                },
                "width": {
                    "unit": "string",
                    "value": 0
                }
            },
            "packageWeight": {
                "value": 11,
                "unit": "Grams"
            },
            "packageItems": [
                {
                    "sku": "string",
                    "summaries": [
                        {
                            "marketplaceId": "string",
                            "asin": "string",
                            "productType": "string",
                            "conditionType": "new_new",
                            "status": [
                                "BUYABLE"
                            ],
                            "fnSku": "string",
                            "itemName": "string",
                            "createdDate": "2019-08-24T14:15:22Z",
                            "lastUpdatedDate": "2019-08-24T14:15:22Z",
                            "mainImage": {
                                "link": "string",
                                "height": 0,
                                "width": 0
                            }
                        }
                    ],
                    "attributes": {},
                    "issues": [
                        {
                            "code": "string",
                            "message": "string",
                            "severity": "ERROR",
                            "attributeNames": [
                                "string"
                            ],
                            "categories": [
                                "INVALID_ATTRIBUTE"
                            ],
                            "enforcements": {
                                "actions": [
                                    {
                                        "action": "LISTING_SUPPRESSED"
                                    }
                                ],
                                "exemption": {
                                    "status": "EXEMPT",
                                    "expiryDate": "2023-10-28T00:36:48.914Z"
                                }
                            }
                        }
                    ],
                    "offers": [
                        {
                            "marketplaceId": "string",
                            "offerType": "B2C",
                            "price": {
                                "currencyCode": "string",
                                "amount": "string"
                            },
                            "points": {
                                "pointsNumber": 0,
                                "pointsMonetaryValue": {
                                    "currencyCode": "string",
                                    "amount": 0
                                }
                            },
                            "audience": {
                                "value": "ALL",
                                "displayName": "string"
                            }
                        }
                    ],
                    "fulfillmentAvailability": [
                        {
                            "fulfillmentChannelCode": "string",
                            "quantity": 0
                        }
                    ],
                    "procurement": [
                        {
                            "costPrice": {
                                "currencyCode": "string",
                                "amount": "string"
                            }
                        }
                    ]
                }
            ],
            "packageTimeSlot": {
                "slotId": "string",
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "handoverMethod": "Pickup"
            },
            "packageIdentifier": "string",
            "invoice": {
                "invoiceNumber": "string",
                "invoiceDate": "2019-08-24T14:15:22Z"
            },
            "packageStatus": "ReadyForPickup",
            "trackingDetails": {
                "trackingId": "string"
            }
        }
    ],
    "valueAddedServicesDetails": [
        {
            "id": "string",
            "amount": {
                "amount": 0,
                "code": "str"
            }
        }
    ],
    "taxDetails": [
        {
            "taxType": "GST",
            "taxRegistrationNumber": "string"
        }
    ],
    "channelDetails": {
        "channelType": "AMAZON",
        "amazonOrderDetails": {
            "orderId": "string"
        },
        "amazonShipmentDetails": {
            "shipmentId": "string"
        }
    },
    "labelSpecifications": {
        "format": "PDF",
        "size": {
            "width": 0,
            "length": 0,
            "unit": "INCH"
        },
        "dpi": 0,
        "pageLayout": "string",
        "needFileJoining": true,
        "requestedDocumentTypes": [
            "PACKSLIP"
        ]
    },
    "serviceSelection": {
        "serviceId": [
            "string"
        ]
    },
    "shipperInstruction": {
        "deliveryNotes": "string"
    },
    "destinationAccessPointDetails": {
        "accessPointId": "string"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.sellingpartnerapi-na.amazon.com/shipping/v2/oneClickShipment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipTo": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "shipFrom": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "returnTo": {
        "addressLine1": "address_1",
        "addressLine2": "address_2",
        "addressLine3": "address_3",
        "city": "Seattle",
        "countryCode": "US",
        "county": "Washington",
        "district": "District1",
        "name": "address_name",
        "phoneNumber": "+14155552671",
        "postalCode": "123456",
        "stateOrRegion": "Washington"
    },
    "shipDate": "2019-08-24T14:15:22Z",
    "packages": [
        {
            "scheduledPackageId": {
                "amazonOrderId": "string",
                "packageId": "string"
            },
            "packageDimensions": {
                "height": {
                    "unit": "string",
                    "value": 0
                },
                "length": {
                    "unit": "string",
                    "value": 0
                },
                "weight": {
                    "unit": "string",
                    "value": 0
                },
                "width": {
                    "unit": "string",
                    "value": 0
                }
            },
            "packageWeight": {
                "value": 11,
                "unit": "Grams"
            },
            "packageItems": [
                {
                    "sku": "string",
                    "summaries": [
                        {
                            "marketplaceId": "string",
                            "asin": "string",
                            "productType": "string",
                            "conditionType": "new_new",
                            "status": [
                                "BUYABLE"
                            ],
                            "fnSku": "string",
                            "itemName": "string",
                            "createdDate": "2019-08-24T14:15:22Z",
                            "lastUpdatedDate": "2019-08-24T14:15:22Z",
                            "mainImage": {
                                "link": "string",
                                "height": 0,
                                "width": 0
                            }
                        }
                    ],
                    "attributes": {},
                    "issues": [
                        {
                            "code": "string",
                            "message": "string",
                            "severity": "ERROR",
                            "attributeNames": [
                                "string"
                            ],
                            "categories": [
                                "INVALID_ATTRIBUTE"
                            ],
                            "enforcements": {
                                "actions": [
                                    {
                                        "action": "LISTING_SUPPRESSED"
                                    }
                                ],
                                "exemption": {
                                    "status": "EXEMPT",
                                    "expiryDate": "2023-10-28T00:36:48.914Z"
                                }
                            }
                        }
                    ],
                    "offers": [
                        {
                            "marketplaceId": "string",
                            "offerType": "B2C",
                            "price": {
                                "currencyCode": "string",
                                "amount": "string"
                            },
                            "points": {
                                "pointsNumber": 0,
                                "pointsMonetaryValue": {
                                    "currencyCode": "string",
                                    "amount": 0
                                }
                            },
                            "audience": {
                                "value": "ALL",
                                "displayName": "string"
                            }
                        }
                    ],
                    "fulfillmentAvailability": [
                        {
                            "fulfillmentChannelCode": "string",
                            "quantity": 0
                        }
                    ],
                    "procurement": [
                        {
                            "costPrice": {
                                "currencyCode": "string",
                                "amount": "string"
                            }
                        }
                    ]
                }
            ],
            "packageTimeSlot": {
                "slotId": "string",
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "handoverMethod": "Pickup"
            },
            "packageIdentifier": "string",
            "invoice": {
                "invoiceNumber": "string",
                "invoiceDate": "2019-08-24T14:15:22Z"
            },
            "packageStatus": "ReadyForPickup",
            "trackingDetails": {
                "trackingId": "string"
            }
        }
    ],
    "valueAddedServicesDetails": [
        {
            "id": "string",
            "amount": {
                "amount": 0,
                "code": "str"
            }
        }
    ],
    "taxDetails": [
        {
            "taxType": "GST",
            "taxRegistrationNumber": "string"
        }
    ],
    "channelDetails": {
        "channelType": "AMAZON",
        "amazonOrderDetails": {
            "orderId": "string"
        },
        "amazonShipmentDetails": {
            "shipmentId": "string"
        }
    },
    "labelSpecifications": {
        "format": "PDF",
        "size": {
            "width": 0,
            "length": 0,
            "unit": "INCH"
        },
        "dpi": 0,
        "pageLayout": "string",
        "needFileJoining": true,
        "requestedDocumentTypes": [
            "PACKSLIP"
        ]
    },
    "serviceSelection": {
        "serviceId": [
            "string"
        ]
    },
    "shipperInstruction": {
        "deliveryNotes": "string"
    },
    "destinationAccessPointDetails": {
        "accessPointId": "string"
    }
}'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the OneClickShipment operation.

payload

object (OneClickShipmentResult)

optional

The payload for the OneClickShipment API.

shipmentId

string

required

An Amazon-defined shipment identifier.

packageDocumentDetails

array[object (PackageDocumentDetail) {3}]

required

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

promise

object (Promise)

required

The time windows promised for pickup and delivery events.

carrier

object (Carrier)

required

The carrier for the inbound shipment.

service

object (Service)

required

Service Related Info

totalCharge

object (Currency)

required

The type and amount of currency.

Example

{
    "shipmentId": "87852211788104",
    "packageDocumentDetails": [
        {
            "packageClientReferenceId": "#abcd",
            "packageDocuments": [
                {
                    "type": "LABEL",
                    "format": "PNG",
                    "contents": "sdioadaiosfhdodsaiufhouafhoudfhdouahfac=="
                }
            ],
            "trackingId": 1578648261977
        }
    ],
    "promise": {
        "pickupWindow": {
            "start": "2019-12-11T07:09:05.513Z",
            "end": "2019-12-11T09:09:05.513Z"
        },
        "deliveryWindow": {
            "start": "2019-12-13T07:09:05.513Z",
            "end": "2019-12-13T09:09:05.513Z"
        }
    },
    "carrier": {
        "id": "AMZN_UK",
        "name": "Amazon Shipping"
    },
    "service": {
        "id": "SWA-UK-PREM",
        "name": "Amazon Shipping One Day"
    },
    "totalCharge": {
        "unit": "GBP",
        "value": 4.76
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable