KOkomerza
Store

Toggle maintenance mode

Enables or disables maintenance mode for the specified store. Requires the stores.update permission.

put/stores/{storeId}/maintenance

Request

Path parameters

storeIdstring uuid required

The ID of the store to update.

Request body

reasonstring nullable

Gets or sets the reason the store is in maintenance mode.

Example request

{
  "reason": "\n                Examples of maintenance reasons include:\n                - \"System updates in progress.\"\n                - \"Inventory restocking.\"\n                - \"Technical difficulties.\"\n            "
}

Response

The object was successfully updated.

successboolean required

Indicates whether the operation or response was successful.

messagestring nullable

A descriptive message providing additional context or information about the response.

codestring nullable

The error code (if there was an error) to use when referencing the error

dataunknown

Changes

No recorded changes to this operation across all 1 revision of this API.