v1

latestOpenAPI 3.0.12026-07-24168217310.4 KB
ScheduledOrders

Get Scheduled Orders

get/Sites/{siteId}/ScheduledOrders

Path parameters

siteIdinteger required

The site identifier

Query parameters

customerIdstring

The customer identifier

searchstring

Search criteria

statusNamesstring[]

Scheduled Order status names to be included in the results

metadataKeystring[]

A metadata keys array. See Querying by metadata

metadataValuestring[]

A metadata values array. See Querying by metadata

scheduledOrderCreatedFromDatestring date-time

Include Scheduled Orders created since this date parameter in the results

scheduledOrderCreatedToDatestring date-time

Include Scheduled Orders created before this date parameter in the results

nextOccurrenceFromDatestring date-time

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

nextOccurrenceToDatestring date-time

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

customerCreatedFromDatestring date-time

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

customerCreatedToDatestring date-time

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

pageinteger

The one-based page number

pageSizeinteger

The page size

orderBystring

Order by field

orderstring

Order asc or desc

snoozedboolean

Response

Success

totalCountinteger
totalPagesinteger
All 168 operations