API reference
Endpoint overview and conventions.
The API has two parts:
- Data objects (orders, shipments, products and so on): a generic REST API at
/api/v2/{Object}. Its OpenAPI (Swagger) spec is public: openapi.json. Import it into Postman, Insomnia or a code generator. - Shipping and store actions (quotes, labels, tracking, manifests, marking orders shipped): documented in the tables below. They are not in the OpenAPI spec.
Data objects#
Each object supports POST /api/v2/{Object} to create, GET /api/v2/{Object}/{id} to read, PUT or PATCH to update and DELETE to remove. GET /api/v2/{Object} searches, using the object's fields as query parameters plus offset, limit, sortby and sortbyorder.
Available objects: Account, AccountRequest, AppEventLog, Customer, Integration, IntegrationInstall, Inventory, Listing, Location, Message, Notification, Order, Package, Plan, Product, ProductVariant, Shipment, ShipmentManifest, Transaction and User.
Shipping#
| Method | Path | Purpose |
|---|---|---|
| POST | /shipping/quote/{installId} | Get quotes from a carrier |
| POST | /shipping/order/create/{installId} | Create a shipment |
| PUT | /shipping/order/update/{shipmentId} | Update a shipment |
| DELETE | /shipping/order/cancel/{shipmentId} | Cancel a shipment |
| POST | /shipping/order/cancel/{installId} | Cancel several shipments |
| GET | /shipping/order/label/{shipmentId} | Get the label |
| GET | /shipping/shipments/{installId} | List shipments |
| POST | /shipping/shipments/{installId} | Refresh shipments from the carrier |
| POST | /shipping/manifest/create/{installId} | Create a manifest |
| POST | /shipping/manifest/summary/{manifestId} | Get a manifest |
| GET | /shipping/tracking/{shipmentId} | Get tracking |
| POST | /shipping/locations/{installId} | Get pick-up and drop-off locations |
Stores#
| Method | Path | Purpose |
|---|---|---|
| GET | /store/orders/{installId} | Unfulfilled orders |
| POST | /store/orders/search/{installId} | Search the channel's order history |
| GET | /store/listings/{installId} | Active listings |
| POST | /store/order/shipped/{orderId} | Mark an order as shipped |
| GET | /store/order/unshipped/{orderId} | Mark an order as unshipped |
| POST | /store/order/ready/{orderId} | Mark an order ready for collection |
| POST | /store/order/acceptance/{orderId} | Accept or reject an order |
| GET | /store/doco/{orderId}/{docType} | PDF label, invoice or packing slip |
Conventions#
- Responses use the
status,messageandpayloadenvelope. See Access & authentication. - List endpoints accept
offsetandlimitquery parameters. - Weights are in grams and dimensions in centimetres.
- Error responses carry a numeric code. See Error messages.