QUICKSTART

API Quick Start

Common Scenarios

Sending Notifications

Estimated Delivery Date

Branded Tracking Page

Product Recommendation

Buy Online, Pickup In Store (BOPIS)

Other Scenarios

CHANGELOG

Migration Guide

REFERENCE

Orders

Create an order

Get order by ID

Update order by ID

Create an order item

Get order item by ID

Update order item by ID

Delete an order item

Products

Create a product

Get product by ID

Update product by ID

Create a new product variant

Get variant by ID

Update product variant

Delete product variant

Stores

Get store by ID

Update store by ID

Fulfillments

Create a fulfillment

Get fulfillments

Get fulfillment by ID

Update fulfillment by ID

Update fulfillment status

Ship fulfillment

Model

Envelope

Primitive

AddressWithCoordinate

OpeningHourPeriod

OrderCustomFields

StatusTimestamps

Resource

Support

Contact Support

Get fulfillments

get

/fulfillments

Get fulfillment results with multiple fulfillments.

In the query parameters, you must include only one of the following: order_id or ids[]. All other parameters should be omitted.

Only a single filter parameter can be included in each request.

Request

Security: API Key

Query Parameters

ids[]

string

Fulfillment IDs. Max length is 20

>= 1 characters<= 20 characters

limit

integer

>= 1<= 50

Default:

10

order_id

string

Order ID

page

integer

>= 1<= 200

Default:

1

Headers

as-store-id

string

required

This value equals to store.id of Store Resource. You can obtain this id by making a GET /stores call to get existing stores or a POST /stores to create a new store.

Auth

:

Parameters

:

:

:

:

: