Skip to content
Colleqtive Developer
Get started
API Reference
Stores

List Stores

StoreListStoresResponse Stores.ListStores(StoreListStoresParams?parameters, CancellationTokencancellationToken = default)
GET/api/v2/public/stores

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

ParametersExpand Collapse
StoreListStoresParams parameters
Boolean isWarehouse

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

string pageSize

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

string pageStart

Page number, starting at 1. Defaults to 1.

string searchText

Case-insensitive search in store number and name.

string secondaryKey

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

maxLength500
ReturnsExpand Collapse
class StoreListStoresResponse:

Generic paginated response wrapper.

required Int PageSize

Maximum number of items returned per page.

formatint32
required Int PageStart

Current page number (1-based).

formatint32
required Long TotalCount

Total number of records matching the query across all pages.

formatint64
IReadOnlyList<List>? List

Collection of items for the current page.

required Long ID

Internal store identifier.

formatint64
required Boolean IsActive

Whether the store is active.

required Boolean IsActiveDataExchange

Whether data exchange is active for this store.

required Boolean IsWarehouse

Whether the store is a warehouse.

string? AreaDescription

Description of the area.

string? AreaID

Area identifier the store belongs to.

Long? AreaManagerUserID

User who manages the area.

formatint64
string? City

City the store is located in.

string? CostCenter

Cost centre the store books to.

string? CountryCode

ISO country code.

string? CountryName

Country name.

string? EslServerPath

Address of the electronic shelf label server for this store.

IReadOnlyList<FreeField>? FreeFields

Free key/value fields carried against the store.

string? Label
Int? SortOrder
formatint32
string? Value
string? IPRangeBegin

First address in the store’s network range.

string? IPRangeEnd

Last address in the store’s network range.

string? LocalServerPath

Address of the store’s local server.

string? OpeningHours

Opening hours for the store.

IReadOnlyList<OrderingSchema>? OrderingSchema

Ordering and delivery calendar for the store.

required Int Day
formatint32
required Int DeliveryOffset
formatint32
required Int OrderingOffset
formatint32
required string Time
formatdate-span
string? CategoryCode
string? WeekNumbers
string? PhoneNumber

Contact number for the store.

Int? PriceLineID

Price line applied to the store.

formatint32
IReadOnlyList<Printer>? Printers

Printers configured in the store.

required Boolean IsBluetooth

true when the printer connects over Bluetooth.

string? PrinterIP

Network address of the printer.

string? PrinterName

Name of the printer.

Int? PrinterType

Type of printer.

formatint32
string? SecondaryKey

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

string? StoreGln

Global Location Number of the store.

string? StoreName

Display name of the store.

DateTimeOffset? StoreNextDeliveryDatetime

Next moment a delivery is expected at this store.

formatdate-time
DateTimeOffset? StoreNextOrderingDatetime

Next moment this store can place an order.

formatdate-time
string? StoreNumber

Unique store number.

string? StoreStockPool1

Name given to stock pool 1 in this store.

string? StoreStockPool10

Name given to stock pool 10 in this store.

string? StoreStockPool2

Name given to stock pool 2 in this store.

string? StoreStockPool3

Name given to stock pool 3 in this store.

string? StoreStockPool4

Name given to stock pool 4 in this store.

string? StoreStockPool5

Name given to stock pool 5 in this store.

string? StoreStockPool6

Name given to stock pool 6 in this store.

string? StoreStockPool7

Name given to stock pool 7 in this store.

string? StoreStockPool8

Name given to stock pool 8 in this store.

string? StoreStockPool9

Name given to stock pool 9 in this store.

string? StoreTypeCode

Type of store.

string? StoreTypeDescription

Name of that store type.

string? TertiaryKey

A further alternate identifier for the store.

string? WarehouseID

Warehouse this store is supplied from.

IReadOnlyDictionary<string, JsonElement>? ListBody

Additional body-level metadata for the list.

IReadOnlyDictionary<string, IReadOnlyList<string>>? ListFilters

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

Int? NextPage

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

formatint32
Long? PreviousPage

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

formatint64
string? ProjectLastModifiedDate

Last modified date/time of the project.

string? ScrollID

Opaque scroll identifier for deep-pagination scenarios.

string? ServerTime

Server UTC date/time when the response was generated.

string? SortColumn

Column name the results are sorted by.

string? SortOrder

Sort direction (asc or desc).

string? TaskLastModifiedDate

Last modified date/time of the task.

List Stores

StoreListStoresParams parameters = new();

var response = await client.Stores.ListStores(parameters);

Console.WriteLine(response);
{
  "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."
}