Sign in
latestOpenAPI 3.1.02026-08-18171438933.7 KB

ef61f771db1d

Stores

Get Stores

get/v1/stores

Query parameters

search_stringstring
limitinteger

A limit on the number of objects to be returned

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

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

An enumeration.

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
item_countinteger required