Stores

Get store locations for a company.

Returns a paginated list of stores and branch locations associated with the specified company.

Endpoint

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

Parameters

Parameter	Type	In	Description
`company_id`	`integer`	path	The unique identifier of the company.
`page`	`integer`	body	Page number (default: 1).
`limit`	`integer`	body	Records per page (default: 100).

Code Examples

import requests

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

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

Response

Success response

{
  "ok": true,
  "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
}

Error Handling

Error response

{
  "ok": false,
  "error": {
    "code": 403,
    "message": "Forbidden"
  }
}