Stores

A store is a brand in a place: reference data per store.

GET/storesLevel 2+coming soon

List stores

Stores of monitored brands.

Parameter	In	Type	Description
`brand`	query	string	Brand id or slug.
`mall`	query	string	Mall id or slug.
`country`	query	string	ISO 3166-1 alpha-2 country code. Repeat or comma-separate for several.
`limit`	query	integer	Items per page, 1 to 100 (default 25).
`cursor`	query	string	The `next_cursor` of the previous page.

Request

curl "https://api.retailbrands.global/v1/stores?country=GB&limit=25" \
  -H "Authorization: Bearer $RB_API_KEY"

Response 200 · StoreList

{
  "data": [
    {
      "id": "sto_4Vb9nMc",
      "brand_id": "zara",
      "mall_id": "liverpool-one",
      "name": "Zara Liverpool ONE",
      "address": "12 Paradise Street, Liverpool",
      "country": "GB",
      "status": "open"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Object fields: Data model · Store

GET/stores/{id}Level 2+coming soon

Get a store

One store. Level 3 adds deduced figures (occupancy cost, conversion, traffic) with their confidence.

Parameter	In	Type	Description
`id`	path	string · required	Identifier of the store, as returned in `id`.

Request

curl "https://api.retailbrands.global/v1/stores/sto_4Vb9nMc" \
  -H "Authorization: Bearer $RB_API_KEY"

Response 200 · Store

{
  "id": "sto_4Vb9nMc",
  "brand_id": "zara",
  "mall_id": "liverpool-one",
  "name": "Zara Liverpool ONE",
  "address": "12 Paradise Street, Liverpool",
  "country": "GB",
  "status": "open",
  "size_m2": null
}

Object fields: Data model · Store

Objects

Store

A brand in a place.

Field	Type	Description
`id`	string	`sto_…`
`brand_id`	string
`mall_id`	string \| null	Null for a street store.
`address`	string \| null
`country`	string	ISO alpha-2.
`status`	"open" \| "closed" \| "unknown"

← Operators Changelog →