Maintenance Mode
Enables or disables maintenance mode for the specified store.
Requires the stores.update permission.
The reason is the switch
There is noenabled flag - maintenance is on or off depending on whether reason has a value.
Message rules
Up to 1024 characters, and only letters, digits, spaces and. , ! ? ' -.
The message is public, so write it for shoppers.
Reading the current state
The store object returnsmaintenanceReason; null means live.
maintenanceReason is null, this endpoint
won’t fix it - that’s an expired plan, an unpaid Buyer Protection invoice, or
a suspended account.Authorizations
Your API key goes here
Path Parameters
The ID of the store to update.
Body
The form containing the new data to update the store with.
Represents a form used to set maintenance mode details for a store.
Gets or sets the reason the store is in maintenance mode.
1024^[a-zA-Z0-9\s.,!?'-]*$"\n Examples of maintenance reasons include:\n - \"System updates in progress.\"\n - \"Inventory restocking.\"\n - \"Technical difficulties.\"\n "
Response
The object was successfully updated.
Represents a default generic response for API endpoints.
Indicates whether the operation or response was successful.
A descriptive message providing additional context or information about the response.
The error code (if there was an error) to use when referencing the error
Represents the data associated with a response.