Create Scheduled Order

Creates a Scheduled Order. Related entities can also be created on the fly if the data is sent as follows:

Scheduled Order Items

Use the scheduledOrderItems field to specify items to be created along with the Scheduled Order

Customer

A new Customer will be created and assigned to the new Scheduled Order provided it's required data is set in the customer field and the customerId field is empty.

Payment Method

A new Payment Method will be created and assigned to the new Scheduled Order provided its required data is set in the paymentMethod field and the paymentMethodId field is empty.
If neither of the fields are specified, then QPilot will assign the Customer's default Payment Method (a Payment Method where the isDefault attribute is true) to the Scheduled Order.

Products on Scheduled Order Items

A new Product will be created and assigned to the corresponding Scheduled Order Item provided its required data is set in the product field within the item.

Shipping Information

If no shipping fields are specified on the Scheduled Order, then the Customer shipping data will be used for the Scheduled Order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The site identifier

Body Params

The scheduled order to create

string | null
customer
object
int64 | null
site
object
string | null
string | null
int32 | null
string
enum
string
enum
required
Allowed:
string | null
int32
required
1 to 365
int32 | null
int64 | null
paymentMethod
object
boolean | null
string | null
float | null
float | null
float | null
float | null
string | null
string | null
string | null
boolean
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
double | null
string | null
string | null
string | null
scheduledOrderItems
array of objects | null
scheduledOrderItems
date-time | null
string
enum
Allowed:
coupons
array of strings | null
coupons
metadata
object | null
int32 | null
uuid | null
date-time | null
int32 | null
string | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json