v1

latestOpenAPI 3.0.12026-07-24168217310.4 KB

ScheduledOrders

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.

post/Sites/{siteId}/ScheduledOrders

Path parameters

siteIdinteger required

The site identifier

Request body

customerIdstring nullable

siteIdinteger nullable

namestring nullable

nextOccurrenceUtcstring nullable

nextOccurrenceOffsetinteger nullable

frequencyType'Days' | 'Weeks' | 'Months' | 'DayOfTheWeek' | 'DayOfTheMonth' required

frequencyDisplayNamestring nullable

frequencyinteger required

cyclesinteger nullable

paymentMethodIdinteger nullable

authorizeOnlyboolean nullable

currencyIsostring nullable

subtotalnumber float nullable

shippingTotalnumber float nullable

taxTotalnumber float nullable

totalnumber float nullable

shippingRateNamestring nullable

shippingRateIdstring nullable

preferredShippingRateOptionstring nullable

enableAutoShippingRateboolean

shippingFirstNamestring nullable

shippingLastNamestring nullable

shippingStreet1string nullable

shippingStreet2string nullable

shippingCitystring nullable

shippingStatestring nullable

shippingPostcodestring nullable

shippingCountrystring nullable

phoneNumberstring nullable

companystring nullable

lifetimeValuenumber double nullable

originalExternalIdstring nullable

clientContractIdstring nullable

notestring nullable

estimatedDeliveryDatestring date-time nullable

origin'Merchant' | 'CustomerCheckout' | 'CustomerApi' | 'Import'

couponsstring[] nullable

metadataobject nullable

utcOffsetinteger nullable

importTransactionIdstring uuid nullable

snoozeUntilUtcstring date-time nullable

snoozeDurationinteger nullable

snoozeDurationTypestring nullable

Response

Success

idinteger

lastProcessingCycleIdinteger nullable

lastOccurrenceUtcstring date-time nullable

createdUtcstring date-time

updatedUtcstring date-time

scheduledOrderFailureReasonstring nullable

processingErrorCode99 | 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 2000 | 2001 | 3000 | 3001 | 3002

preProcessingValidationResultCode1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256

lockedboolean

lastEditableDatestring date-time nullable

stripeUrlstring nullable

displaySalePriceboolean

lastChangeToDeletedstring nullable

bundleIdinteger nullable

bundleNamestring nullable

originSubscriptionIdstring nullable