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
Migration Guide (From legacy API)
Migration Guide (From 2024-04)
Migration Guide (From 2024-07 or 2024-10)
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 products
get
Get product by ID
get
Update product by ID
patch
Create a new product variant
post
Get variant by ID
get
Update product variant
patch
Delete product variant
delete
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
Pickup
v1
PickupLocation
v1
Tracking
v1
Weight
v1
OrderCustomFields
v1
StatusTimestamps
v1
Resource
Order
v1
OrderItem
v1
Product
v1
ProductVariant
v1
Fulfillment
v1
Store
v1
Support
Contact Support

StatusTimestamps

This object tracks the timestamps for each status change.

  • Explicit Input: If provides a timestamp, including null, it is stored as given.
  • Default Behavior: If no timestamp is specified and a status is set, the current time is automatically stored for that status. Example: If status is set to open and opened_at is not provided, opened_at will be assigned the current time.

This object tracks the timestamps for each status change.Show all...

opened_at
string<date-time> or null

Datetime when the status was set to open.

canceled_at
string<date-time> or null

Datetime when the status was set to canceld.

closed_at
string<date-time> or null

Datetime when the status was set to closed.

Example
preparing...