QUICKSTART
API Quick Start
Authentication
SignString
Versioning
Rate Limit
Body Envelope
Request Errors
Common Scenarios
Tracking
Sending Notifications
Estimated Delivery Date
Branded Tracking Page
Product Recommendation
Buy Online, Pickup In Store (BOPIS)
Next Couriers
Other Scenarios
Shipping
Returns
CHANGELOG
Changelog
Migration Guide
Past Changelog
REFERENCE
API Overview
Orders
Create an order
post
Get orders
get
Get order by ID
get
Update order by ID
patch
Create an order item
post
Get order item by ID
get
Update order item by ID
patch
Delete an order item
delete
Products
Create a product
post
Get product by ID
get
Update product by ID
patch
Stores
Create a store
post
Get stores
get
Get store by ID
get
Update store by ID
patch
Fulfillments
Create a fulfillment
post
Get fulfillments
get
Get fulfillment by ID
get
Update fulfillment by ID
patch
Update fulfillment status
post
Ship fulfillment
post
Model
Envelope
Meta
v1
Error
v1
Pagination
v2
Primitive
Address
v1
AddressWithCoordinate
v1
Customer
v1
Location
v1
Money
v1
OpeningHours
v1
OpeningHourPeriod
v1
OrderItem
v1
Pickup
v1
PickupLocation
v1
Tracking
v1
Weight
v1
OrderCustomFields
v1
StatusTimestamps
v1
Resource
Order
v1
Product
v1
Fulfillment
v1
Store
v1
Support
Contact Support

Error

The Error model contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

The Error model contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a human-readable description of the error.

path
string

The JSON path of the request object to indicate the error location.

Example:
data.product.title
info
string

A human-readable description of the error.

Example:
Title is invalid
Example
preparing...