v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBSites
Update Site
put/Sites/{id}
Path parameters
idinteger required
The site identifier
Request body
urlstring required
baseUrlWebHookstring nullable
logoUrlstring nullable
namestring required
emailstring required
apiKey1string nullable
apiKey2string nullable
apiKey3string nullable
zipCodestring nullable
isProductionboolean
orderProcessingStartTimestring date-span nullable
orderProcessingEndTimestring date-span nullable
orderProcessingOffsetinteger nullable
utcOffsetinteger nullable
lockDurationDaysinteger nullable
isShowingNotesboolean
isShowCouponsboolean
noScheduleOrdersBodystring nullable
noScheduleOrdersLinkstring nullable
isStackedButtonsboolean
isDisplayScheduledOrderIdboolean
showProductTitleOnImagesboolean
enableProductCarouselAutoSlideboolean
isProcessingPausedboolean
metadataobject nullable
defaultWeightUnitType'Pound' | 'Ounce' | 'Kilogram' | 'Gram'
defaultLengthUnitType'Inch' | 'Foot' | 'Yard' | 'Milimeter' | 'Centimeter' | 'Meter'
phoneNumberstring nullable
scheduledOrdersClientPageUrlstring nullable
paymentMethodsPageUrlstring nullable
baseUrlstring nullable
createOrderEndpointstring nullable
orderProcessedEndpointstring nullable
failOrderEndpointstring nullable
updateProductAvailabilityEndpointstring nullable
healthCheckPostEndpointstring nullable
healthCheckPutEndpointstring nullable
repeatProcessingAllowedWindowinteger nullable
repeatProcessingAllowedWindowUnitType'Minutes' | 'Hours' | 'Days'
subscriptionStatusstring nullable
subscriptionPaymentMethodDescriptionstring nullable
subscriptionProductHandlestring nullable
subscriptionNextBillingDatestring date-time nullable
subscriptionIdstring nullable
subscriptionUpdatedUtcstring date-time nullable
currencyIsostring nullable
fallbackToQpilotShippingWhenNextimeFailsboolean
applyUtcToExistingScheduledOrdersboolean
applyProcessingTimesToExistingScheduledOrdersboolean
Response
Success
idinteger
userIdinteger
urlstring nullable
baseUrlWebHookstring nullable
scheduledOrdersClientPageUrlstring nullable
paymentMethodsPageUrlstring nullable
logoUrlstring nullable
namestring nullable
emailstring nullable
zipCodestring nullable
createdUtcstring date-time
updatedUtcstring date-time
isProductionboolean
orderProcessingStartTimestring date-span nullable
orderProcessingEndTimestring date-span nullable
orderProcessingOffsetinteger nullable
utcOffsetinteger nullable
lockDurationDaysinteger nullable
isShowingNotesboolean
isShowCouponsboolean
noScheduleOrdersBodystring nullable
noScheduleOrdersLinkstring nullable
isStackedButtonsboolean
isDisplayScheduledOrderIdboolean
showProductTitleOnImagesboolean
enableProductCarouselAutoSlideboolean
allowRetryScheduledOrderboolean
isProcessingPausedboolean
lastProcessingPausedUtcstring date-time nullable
failedConnectAttemptsinteger
hasActiveInvalidProductsboolean nullable
metadataobject nullable
metadataJsonstring nullable
defaultWeightUnitType'Pound' | 'Ounce' | 'Kilogram' | 'Gram'
defaultLengthUnitType'Inch' | 'Foot' | 'Yard' | 'Milimeter' | 'Centimeter' | 'Meter'
phoneNumberstring nullable
baseUrlstring nullable
createOrderEndpointstring nullable
orderProcessedEndpointstring nullable
failOrderEndpointstring nullable
updateProductAvailabilityEndpointstring nullable
healthCheckPostEndpointstring nullable
healthCheckPutEndpointstring nullable
repeatProcessingAllowedWindowinteger nullable
repeatProcessingAllowedWindowUnitType'Minutes' | 'Hours' | 'Days'
supportsProcessingWindowboolean
activeboolean
currencyIsostring nullable
fallbackToQpilotShippingWhenNextimeFailsboolean