v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBScheduledOrders
Update Scheduled Order
put/Sites/{siteId}/ScheduledOrders/{id}
Path parameters
siteIdinteger required
The site identifier
idinteger required
The scheduled order identifier
Request body
customerIdstring nullable
siteIdinteger nullable
namestring nullable
nextOccurrenceUtcstring nullable
nextOccurrenceOffsetinteger nullable
status'Processing' | 'Success' | 'Failed' | 'Retry' | 'Active' | 'Paused' | 'Deleted' | 'Queued' | 'Snoozed'
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
customerIdstring nullable
siteIdinteger nullable
namestring nullable
nextOccurrenceUtcstring nullable
nextOccurrenceOffsetinteger nullable
status'Processing' | 'Success' | 'Failed' | 'Retry' | 'Active' | 'Paused' | 'Deleted' | 'Queued' | 'Snoozed'
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