List Orders

Orders index

Get a list of orders

Query Parameters

Parameter	Details
storeId required	integer storeId (integer) or referenceKey (prefixed with key=) Examples: { "type": "integer" } { "type": "string" }
filters[orderType]	string Optional storeId Example: pickupCollect
filters[orderStatus]	string Optional Order status Example: accepted
filters[orderItemStatus]	string Optional OrderItem status Example: accepted
filters[date]	string Optional Order Date (YYYY-MM-DD) Example: 2023-06-20
sort	string Optional Sort (defaults to Order createdAt) Example: createdAt
sortDir	string Optional Sort direction (defaults desc) Example: desc
page	integer Pagination
perPage	integer Pagination, items per page

Responses

200

successful operation

application/json

Success

data

Array of object

links

object

meta

object

401

Unauthorized

Error

422

Unprocessable Entity

application/json

Error

GET/orders

Copy

Request samples

PHPcURLnodeJS

Copy

Available Filters

• filters.s
  • type: string
  • searches in orderId and orderKey
• filters.orderScope
  • type: string
  • options
    • incomingPackages
    • openFulfillment
    • readyForPickup
• filters.orderType
  • type: string
  • options
    • pickupCollect
    • fulfillment (subject to change to shippingFulfillment)
    • pickupFulfillment
• filters.orderStatus
  • type: string
  • options
    • confirmed
    • inFulfillment
    • readyForPickup
    • closed
• filters.orderItemStatus
  • type: string
  • options
    • confirmed
    • delegated
    • waitingForShipment
    • inPicking
    • picked
    • readyForShipping
    • shipped
    • readyForPickup
    • pickedUp
    • canceled
• filters.date
  • type: date (YYYY-MM-DD)

Sorting

• sort
  • options
    • orderId
    • createdAt
• sortDir
  • options
    • asc
    • desc

Get order count by their scope

Provided scopes can be one or multiple.

• scopes
  • options
    • incomingPackages
    • openFulfillment
    • readyForPickup

Get order count by scope

Get the count of orders grouped by their scope (incomingPackages, openFulfillment, readyForPickup)

Query Parameters

Parameter	Details
scopes[scopeName] required	string Available scopeNames: incomingPackages, openFulfillment, readyForPickup Example: incomingPackages

Responses

200

successful operation

application/json

Success

incomingPackages

number

Example:

12

openFulfillment

number

Example:

84

readyForPickup

number

Example:

2

401

Unauthorized

Error

422

Unprocessable Entity

application/json

Error

GET/order/scope-count

Copy