v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBScheduledOrders
Update Scheduled Order Frequency
put/Sites/{siteId}/ScheduledOrders/{scheduledOrderId}/Frequency
Path parameters
siteIdinteger required
The site identifier
scheduledOrderIdinteger required
The scheduled order identifier
Request body
frequencyType'Days' | 'Weeks' | 'Months' | 'DayOfTheWeek' | 'DayOfTheMonth'
frequencyinteger
Response
Success
idinteger
lastProcessingCycleIdinteger nullable
customerIdinteger
siteIdinteger
namestring nullable
lastOccurrenceUtcstring date-time nullable
nextOccurrenceUtcstring date-time required
nextOccurrenceOffsetinteger nullable
status'Processing' | 'Success' | 'Failed' | 'Retry' | 'Active' | 'Paused' | 'Deleted' | 'Queued' | 'Snoozed'
lastChangeToDeletedstring date-time nullable
createdUtcstring date-time
updatedUtcstring date-time
frequencyType'Days' | 'Weeks' | 'Months' | 'DayOfTheWeek' | 'DayOfTheMonth' required
frequencyinteger required
utcOffsetinteger nullable
cyclesinteger
paymentMethodIdinteger nullable
authorizeOnlyboolean
currencyIsostring nullable
subtotalnumber float nullable
shippingTotalnumber float nullable
taxTotalnumber float nullable
totalnumber float nullable
shippingRateNamestring nullable
shippingFirstNamestring nullable
shippingLastNamestring nullable
shippingStreet1string nullable
shippingStreet2string nullable
shippingCitystring nullable
shippingStatestring nullable
shippingPostcodestring nullable
shippingCountrystring nullable
siteShippingAddressIdinteger nullable
phoneNumberstring nullable
companystring nullable
lifetimeValuenumber double
originalExternalIdstring nullable
clientContractIdstring nullable
notestring nullable
frequencyDisplayNamestring nullable
estimatedDeliveryDatestring date-time nullable
scheduledOrderFailureReasonstring nullable
scheduledOrderFailureSlugstring nullable
processingErrorCode99 | 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 2000 | 2001 | 3000 | 3001 | 3002
preProcessingValidationResultCode1 | 2 | 4 | 8 | 16 | 32 | 64 | 128 | 256
origin'Merchant' | 'CustomerCheckout' | 'CustomerApi' | 'Import'
isCreationRetryboolean
preferredShippingRateOptionstring nullable
enableAutoShippingRateboolean
importTransactionIdstring uuid nullable
originSubscriptionIdstring nullable
metadataobject nullable