Документация API

Магазины

Получение торговых точек компании.

Возвращает постраничный список торговых точек и филиалов указанной компании.

Эндпоинт

GET /api/v1/companies/:company_id/stores

Параметры

ПараметрТипГдеОписание
company_idintegerpathУникальный идентификатор компании.
pageintegerqueryНомер страницы (по умолчанию: 1).
limitintegerqueryЗаписей на странице (по умолчанию: 100).

Примеры кода

Получение магазинов

import requests

url = 'https://statsnet.co/api/v1/companies/12345/stores'
headers = {
  'Authorization': 'Bearer sk_live_YOUR_KEY',
  'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers).json()
print(response)

Ответ

Успешный ответ

{
  "stores": [
    {
      "id": 1,
      "company_identifier": "302233483",
      "name": "Main Branch",
      "store_name": "Store #1",
      "address": "Almaty, Abay Avenue 52",
      "license": "LIC-2024-001",
      "jurisdiction": "kz",
      "created_at": "2021-01-14T00:06:22.439Z",
      "updated_at": "2021-01-15T13:24:54.248Z"
    }
  ],
  "total": 1,
  "pagination_total": 1,
  "pagination_offset": 0
}

Обработка ошибок

Ответ с ошибкой

{
  "status": 403,
  "message": "access denied"
}

Эндпоинт также может вернуть {"status": 402, "message": "payment required"}, если подписка отменена или истекла, и {"status": 429, "message": "quota exhausted"}, если квота отчётов тарифа на текущий период исчерпана.