Easy Ship API
Learn how to use the Easy Ship API.
You use the Easy Ship API to build applications that help you manage and ship Amazon Easy Ship orders. You can schedule or reschedule Easy Ship packages. You can also get invoices, shipping labels, and warranties for scheduled Easy Ship orders.
Release notes
To learn more about the terms that are used in this guide, refer to Terminology.
Easy Ship workflow
The following diagram shows the steps to ship an Easy Ship order.
Detect new orders with the
ORDER_CHANGE notification or batch process▼
Call
getOrder or getOrderItems to retrieve the unshipped Easy Ship orders▼
▼
▼
▼
Call
createFeed to request an Easy Ship feed document (POST_EASY_SHIP_DOCUMENTS). Specify the warranty document if required▼
▼
Use cases
The following use case examples are available for the Easy Ship API v2022-03-23:
- Schedule an Easy Ship package: Get available time slots and schedule an Easy Ship order.
- Reschedule an Easy Ship package: Get available time slots and reschedule an Easy Ship order
- Check the status of an Easy Ship package: View the specified weight, dimensions, time slot, and other details of an Easy Ship package.
- Find order items that require serial numbers: Locate items in an Amazon Easy Ship order that require serial numbers.
- Get shipping labels, invoice, and warranty documents: Submit an Easy Ship Feed request and get a PDF that contains the invoice, shipping label, and warranty (if available) documents for an Amazon Easy Ship order.
Roles
createScheduledPackage
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
createScheduledPackageBulk
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
getScheduledPackage
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
listHandoverSlots
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
updateScheduledPackages
| Attribute | Value |
|---|---|
| Regions | NA, EU, FE |
| Required roles (need at least one) | Direct to Consumer Shipping (Restricted) |
Marketplace support
Easy Ship operations are only available in select marketplaces and support for specific operations varies in each marketplace. Refer to the following table for marketplace supported operations.
| Marketplace | Region | Supported handover methods | Get time slots | Create package | Update package | Get package status | Shipping label | Invoice | Warranty | Bulk Package Scheduling |
|---|---|---|---|---|---|---|---|---|---|---|
| Mexico | NA | Pickup and Dropoff | Unscheduled orders only | Supported | Not supported | Supported | Supported | Not supported | Not supported | Not supported |
| India | EU | Pickup only | Scheduled and unscheduled Orders | Supported | Supported | Supported | Supported | Supported | Supported | Not supported |
| Turkey | EU | Pickup and Dropoff | Unscheduled orders only | Supported | Not supported | Supported | Supported | Not supported | Not supported | Not supported |
| Australia | FE | Pickup only | Unscheduled orders only | Supported | Not supported | Supported | Supported | Not supported | Not supported | Not supported |
| Singapore | FE | Pickup only | Unscheduled orders only | Supported | Not supported | Supported | Supported | Not supported | Not supported | Not supported |
| Japan | FE | Pickup only | Unscheduled orders only | Supported | Not supported | Supported | Supported | Not supported | Not supported | Not supported |
| The Netherlands | EU | Dropoff only | Not supported | Not supported | Not supported | Not supported | Not supported | Not supported | Not supported | Supported |
| Poland | EU | Pickup only | Not supported | Not supported | Not supported | Not supported | Not supported | Not supported | Not Supported | Supported |
Updated 13 days ago