Get Scheduled Orders

get

https://api.qpilot.cloud/Sites/{siteId}/ScheduledOrders

Path Params

siteId

int64

required

The site identifier

Query Params

customerId

string

The customer identifier

string

Search criteria

statusNames

array of strings

Scheduled Order status names to be included in the results

statusNames

metadataKey

array of strings

A metadata keys array. See Querying by metadata

metadataKey

metadataValue

array of strings

A metadata values array. See Querying by metadata

metadataValue

scheduledOrderCreatedFromDate

date-time

Include Scheduled Orders created since this date parameter in the results

scheduledOrderCreatedToDate

date-time

Include Scheduled Orders created before this date parameter in the results

nextOccurrenceFromDate

date-time

Include Scheduled Orders that are due after this date parameter in the results

nextOccurrenceToDate

date-time

Include Scheduled Orders that are due before this date parameter in the results

customerCreatedFromDate

date-time

Include Scheduled Orders from Customers created since this date parameter in the results

customerCreatedToDate

date-time

Include Scheduled orders from Customers created before this date parameter in the results

page

int32

Defaults to 1

The one-based page number

pageSize

int32

Defaults to 100

The page size

orderBy

string

Defaults to NextOccurrenceUtc

Order by field

order

string

Defaults to asc

Order asc or desc

snoozed

boolean

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success