Sign in
Stores

Update Store

put/v1/stores/{store_id}

Path parameters

store_idstring required

Request body

namestring nullable

The name of the store, used for display purposes.

descriptionstring nullable

The description of the store, such as its purpose, features, or additional details.

keystring nullable

The key of the store.

type'default' | 'special' | 'rotation' | 'limited_stock' | 'webhook'
start_atinteger nullable

The start time of the store in Unix timestamp (seconds) when it becomes available to users.

end_atinteger nullable

The end time of the store in Unix timestamp (seconds) when it closes and is no longer accessible.

Response

Successful Response

namestring required

The name of the store, used for display purposes.

descriptionstring required

The description of the store, such as its purpose, features, or additional details.

keystring nullable

The key of the store.

type'default' | 'special' | 'rotation' | 'limited_stock' | 'webhook' required
start_atinteger nullable

The start time of the store in Unix timestamp (seconds) when it becomes available to users.

end_atinteger nullable

The end time of the store in Unix timestamp (seconds) when it closes and is no longer accessible.

idstring required
current_purchase_countinteger

Changes

Changed in 1 of the 14 revisions of this API.2

  • 8662e77bc1e22See the full diff
    • ●

      the rotation_settings/current_rotated_store_item_ids/items/ request property's maxLength was set to 32

      request-property-max-length-set

    • ●

      the settings/webhook_settings/webhook_id request property's maxLength was set to 32

      request-property-max-length-set

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog