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
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
Resource
Order
v1
Product
v1
Fulfillment
v1
Store
v1
Support
Contact Support

Pickup

The Pickup model provides comprehensive pickup information, which can be displayed on the branded tracking page or included in buyer notifications.

The Pickup model provides comprehensive pickup information, which can be displayed on the branded tracking page or included in buyer notifications.

instructions
string

Instructions for the pickup process.Show all...

Example:
Shop open from Mon to Fri
estimated_ready_for_pickup_at
object

The expected date and time when the items in this fulfillment order will be ready for pickup.Show all...

min
string<date-time>

The earliest anticipated date and time, formatted in ISO 8601.

Example:
2021-04-15T20:02:09Z
max
string<date-time>

The latest anticipated date and time, formatted in ISO 8601.

Example:
2021-04-15T20:02:09Z
pickup_deadline_at
string<date-time>

The latest time by which the pickup must be completed, formatted in ISO 8601.Show all...

Example:
2021-04-15T20:02:09Z
Example
preparing...