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

Body Params application/json

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

Body

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