Stores

Get Stores

Changed on
get/v1/stores

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/stores
  • Auth
    HTTP bearer

Query parameters

search_stringstring
limitinteger

A limit on the number of objects to be returned

offsetinteger

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

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

    • warning

      for the query request parameter limit, the max was set to 300.00

    • warning

      for the query request parameter offset, the min was set to 0.00