Upsert Scheduled Order

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

siteId

int64

required

Body Params

The scheduled order

customerId

string | null

customer

object

siteId

int64 | null

site

object

name

string | null

nextOccurrenceUtc

string | null

nextOccurrenceOffset

int32 | null

status

string

enum

frequencyType

string

enum

required

Allowed:

frequencyDisplayName

string | null

frequency

int32

required

1 to 365

cycles

int32 | null

paymentMethodId

int64 | null

paymentMethod

object

authorizeOnly

boolean | null

currencyIso

string | null

subtotal

float | null

shippingTotal

float | null

taxTotal

float | null

total

float | null

shippingRateName

string | null

shippingRateId

string | null

preferredShippingRateOption

string | null

enableAutoShippingRate

boolean

shippingFirstName

string | null

shippingLastName

string | null

shippingStreet1

string | null

shippingStreet2

string | null

shippingCity

string | null

shippingState

string | null

shippingPostcode

string | null

shippingCountry

string | null

phoneNumber

string | null

company

string | null

lifetimeValue

double | null

originalExternalId

string | null

clientContractId

string | null

note

string | null

scheduledOrderItems

array of objects | null

scheduledOrderItems

estimatedDeliveryDate

date-time | null

origin

string

enum

Allowed:

coupons

array of strings | null

coupons

metadata

object | null

utcOffset

int32 | null

importTransactionId

uuid | null

snoozeUntilUtc

date-time | null

snoozeDuration

int32 | null

snoozeDurationType

string | null

Headers

string

enum

Defaults to application/json

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Allowed:

Response

Language

Credentials

Header

Loading…

Response

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

text/plain

application/json

text/json

200Success