Skip to content

Reference / Stores

List stores

GET/api/v1/stores

The workspace's stores with how much each one has sent in.

Guide: e-commerce →

Scope

  • ecommerce:read Read e-commerce – the person behind the key must be all members.

Response

200 All stores.

dataarray<object>required
data[].idstringrequired
The store's ID.
data[].namestringrequired
data[].domainstring | nullrequired
data[].currencystringrequired
data[].countsobjectrequired
How much the store has sent in.
data[].counts.customersintegerrequired
data[].counts.productsintegerrequired
data[].counts.ordersintegerrequired
data[].counts.cartsintegerrequired
data[].created_atstring (time, ISO 8601)required
When the store was created.
data[].updated_atstring (time, ISO 8601)required
When the store was last changed.

Errors