List Stores

stores.list_stores() -> StoreListStoresResponse

GET/api/v2/public/stores

Stores and warehouses for the organisation. Returns the store_number values used by every store-scoped endpoint.

ParametersExpand Collapse

is_warehouse: Optional[bool]

True returns only warehouses, false excludes them. Omit for both.

page_size: Optional[str]

Number of stores per page. Defaults to 10. Pass -1 to return every match in one page.

page_start: Optional[str]

Page number, starting at 1. Defaults to 1.

search_text: Optional[str]

Case-insensitive search in store number and name.

secondary_key: Optional[str]

Filters on the store’s secondary key, the alternate identifier from the source system.

maxLength500

ReturnsExpand Collapse

class StoreListStoresResponse: …

Generic paginated response wrapper.

page_size: int

Maximum number of items returned per page.

formatint32

page_start: int

Current page number (1-based).

formatint32

total_count: int

Total number of records matching the query across all pages.

formatint64

list: Optional[List[List]]

Collection of items for the current page.

id: int

Internal store identifier.

formatint64

is_active: bool

Whether the store is active.

is_active_data_exchange: bool

Whether data exchange is active for this store.

is_warehouse: bool

Whether the store is a warehouse.

area_description: Optional[str]

Description of the area.

area_id: Optional[str]

Area identifier the store belongs to.

area_manager_user_id: Optional[int]

User who manages the area.

formatint64

city: Optional[str]

City the store is located in.

cost_center: Optional[str]

Cost centre the store books to.

country_code: Optional[str]

ISO country code.

country_name: Optional[str]

Country name.

esl_server_path: Optional[str]

Address of the electronic shelf label server for this store.

free_fields: Optional[List[ListFreeField]]

Free key/value fields carried against the store.

label: Optional[str]

sort_order: Optional[int]

formatint32

value: Optional[str]

ip_range_begin: Optional[str]

First address in the store’s network range.

ip_range_end: Optional[str]

Last address in the store’s network range.

local_server_path: Optional[str]

Address of the store’s local server.

opening_hours: Optional[str]

Opening hours for the store.

ordering_schema: Optional[List[ListOrderingSchema]]

Ordering and delivery calendar for the store.

day: int

formatint32

delivery_offset: int

formatint32

ordering_offset: int

formatint32

time: str

formatdate-span

category_code: Optional[str]

week_numbers: Optional[str]

phone_number: Optional[str]

Contact number for the store.

price_line_id: Optional[int]

Price line applied to the store.

formatint32

printers: Optional[List[ListPrinter]]

Printers configured in the store.

is_bluetooth: bool

true when the printer connects over Bluetooth.

printer_ip: Optional[str]

Network address of the printer.

printer_name: Optional[str]

Name of the printer.

printer_type: Optional[int]

Type of printer.

formatint32

secondary_key: Optional[str]

Alternate identifier for the store in the source system. The secondary_key filter matches on this.

store_gln: Optional[str]

Global Location Number of the store.

store_name: Optional[str]

Display name of the store.

store_next_delivery_datetime: Optional[datetime]

Next moment a delivery is expected at this store.

formatdate-time

store_next_ordering_datetime: Optional[datetime]

Next moment this store can place an order.

formatdate-time

store_number: Optional[str]

Unique store number.

store_stock_pool_1: Optional[str]

Name given to stock pool 1 in this store.

store_stock_pool_10: Optional[str]

Name given to stock pool 10 in this store.

store_stock_pool_2: Optional[str]

Name given to stock pool 2 in this store.

store_stock_pool_3: Optional[str]

Name given to stock pool 3 in this store.

store_stock_pool_4: Optional[str]

Name given to stock pool 4 in this store.

store_stock_pool_5: Optional[str]

Name given to stock pool 5 in this store.

store_stock_pool_6: Optional[str]

Name given to stock pool 6 in this store.

store_stock_pool_7: Optional[str]

Name given to stock pool 7 in this store.

store_stock_pool_8: Optional[str]

Name given to stock pool 8 in this store.

store_stock_pool_9: Optional[str]

Name given to stock pool 9 in this store.

store_type_code: Optional[str]

Type of store.

store_type_description: Optional[str]

Name of that store type.

tertiary_key: Optional[str]

A further alternate identifier for the store.

warehouse_id: Optional[str]

Warehouse this store is supplied from.

list_body: Optional[Dict[str, Optional[object]]]

Additional body-level metadata for the list.

list_filters: Optional[Dict[str, Optional[List[str]]]]

Active filter criteria applied to the result set, keyed by field name.

next_page: Optional[int]

Next page number, or null when on the last page.

formatint32

previous_page: Optional[int]

Previous page number, or null when on the first page.

formatint64

project_last_modified_date: Optional[str]

Last modified date/time of the project.

scroll_id: Optional[str]

Opaque scroll identifier for deep-pagination scenarios.

server_time: Optional[str]

Server UTC date/time when the response was generated.

sort_column: Optional[str]

Column name the results are sorted by.

sort_order: Optional[str]

Sort direction (asc or desc).

task_last_modified_date: Optional[str]

Last modified date/time of the task.

List Stores

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.stores.list_stores()
print(response.scroll_id)

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "id": 0,
      "is_active": true,
      "is_active_data_exchange": true,
      "is_warehouse": true,
      "area_description": "area_description",
      "area_id": "area_id",
      "area_manager_user_id": 0,
      "city": "city",
      "cost_center": "cost_center",
      "country_code": "country_code",
      "country_name": "country_name",
      "esl_server_path": "esl_server_path",
      "free_fields": [
        {
          "label": "label",
          "sort_order": 0,
          "value": "value"
        }
      ],
      "ip_range_begin": "ip_range_begin",
      "ip_range_end": "ip_range_end",
      "local_server_path": "local_server_path",
      "opening_hours": "opening_hours",
      "ordering_schema": [
        {
          "day": 0,
          "delivery_offset": 0,
          "ordering_offset": 0,
          "time": "time",
          "category_code": "category_code",
          "week_numbers": "week_numbers"
        }
      ],
      "phone_number": "phone_number",
      "price_line_id": 0,
      "printers": [
        {
          "is_bluetooth": true,
          "printer_ip": "printer_ip",
          "printer_name": "printer_name",
          "printer_type": 0
        }
      ],
      "secondary_key": "secondary_key",
      "store_gln": "store_gln",
      "store_name": "store_name",
      "store_next_delivery_datetime": "2019-12-27T18:11:19.117Z",
      "store_next_ordering_datetime": "2019-12-27T18:11:19.117Z",
      "store_number": "store_number",
      "store_stock_pool_1": "store_stock_pool_1",
      "store_stock_pool_10": "store_stock_pool_10",
      "store_stock_pool_2": "store_stock_pool_2",
      "store_stock_pool_3": "store_stock_pool_3",
      "store_stock_pool_4": "store_stock_pool_4",
      "store_stock_pool_5": "store_stock_pool_5",
      "store_stock_pool_6": "store_stock_pool_6",
      "store_stock_pool_7": "store_stock_pool_7",
      "store_stock_pool_8": "store_stock_pool_8",
      "store_stock_pool_9": "store_stock_pool_9",
      "store_type_code": "store_type_code",
      "store_type_description": "store_type_description",
      "tertiary_key": "tertiary_key",
      "warehouse_id": "warehouse_id"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "id": 0,
      "is_active": true,
      "is_active_data_exchange": true,
      "is_warehouse": true,
      "area_description": "area_description",
      "area_id": "area_id",
      "area_manager_user_id": 0,
      "city": "city",
      "cost_center": "cost_center",
      "country_code": "country_code",
      "country_name": "country_name",
      "esl_server_path": "esl_server_path",
      "free_fields": [
        {
          "label": "label",
          "sort_order": 0,
          "value": "value"
        }
      ],
      "ip_range_begin": "ip_range_begin",
      "ip_range_end": "ip_range_end",
      "local_server_path": "local_server_path",
      "opening_hours": "opening_hours",
      "ordering_schema": [
        {
          "day": 0,
          "delivery_offset": 0,
          "ordering_offset": 0,
          "time": "time",
          "category_code": "category_code",
          "week_numbers": "week_numbers"
        }
      ],
      "phone_number": "phone_number",
      "price_line_id": 0,
      "printers": [
        {
          "is_bluetooth": true,
          "printer_ip": "printer_ip",
          "printer_name": "printer_name",
          "printer_type": 0
        }
      ],
      "secondary_key": "secondary_key",
      "store_gln": "store_gln",
      "store_name": "store_name",
      "store_next_delivery_datetime": "2019-12-27T18:11:19.117Z",
      "store_next_ordering_datetime": "2019-12-27T18:11:19.117Z",
      "store_number": "store_number",
      "store_stock_pool_1": "store_stock_pool_1",
      "store_stock_pool_10": "store_stock_pool_10",
      "store_stock_pool_2": "store_stock_pool_2",
      "store_stock_pool_3": "store_stock_pool_3",
      "store_stock_pool_4": "store_stock_pool_4",
      "store_stock_pool_5": "store_stock_pool_5",
      "store_stock_pool_6": "store_stock_pool_6",
      "store_stock_pool_7": "store_stock_pool_7",
      "store_stock_pool_8": "store_stock_pool_8",
      "store_stock_pool_9": "store_stock_pool_9",
      "store_type_code": "store_type_code",
      "store_type_description": "store_type_description",
      "tertiary_key": "tertiary_key",
      "warehouse_id": "warehouse_id"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}