List Orders

Date range filter is inclusive of both start and end dates and only filters via the day and not the time of day

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collectionId

string

required

Body

application/json

filter

object

required

companyId

string

Response

200 - application/json

count

number

required

data

object[]

required

data.id

string

required

data.orderLineItems

object[]

required

data.orderLineItems.id

string

required

data.orderLineItems.image

object

required

data.orderLineItems.price

number

required

data.orderLineItems.productId

string

required

data.orderLineItems.productTitle

string

required

data.orderLineItems.quantity

number

required

data.orderLineItems.retailPrice

number | null

required

data.orderLineItems.title

string

required

data.orderLineItems.variantId

string

required

data.orderLineItems.variantTitle

string

required

data.orderLineItems.personalizations

object | null

data.orderLineItems.personalizations.anniversary

object

required

data.orderLineItems.personalizations.birth

object

required

data.orderLineItems.personalizations.name

object

required

data.orderLineItems.personalizations.work

object

required

data.orderLineItems.sha

string | null

data.createdAt

string | null

data.externalId

string | null

data.orderNumber

string | null

data.user

object

Introduction

Auth

Guides

API Reference

API Changelog

Authorizations

Path Parameters

Body

Response