Stores

List Stores

GET/api/v2/public/stores

Create Stores

POST/api/v2/public/stores

ModelsExpand Collapse

StoreListStoresResponse object { page_size, page_start, total_count, 11 more }

Generic paginated response wrapper.

page_size: number

Maximum number of items returned per page.

formatint32

page_start: number

Current page number (1-based).

formatint32

total_count: number

Total number of records matching the query across all pages.

formatint64

list: optional array of object { id, is_active, is_active_data_exchange, 38 more }

Collection of items for the current page.

id: number

Internal store identifier.

formatint64

is_active: boolean

Whether the store is active.

is_active_data_exchange: boolean

Whether data exchange is active for this store.

is_warehouse: boolean

Whether the store is a warehouse.

area_description: optional string

Description of the area.

area_id: optional string

Area identifier the store belongs to.

area_manager_user_id: optional number

User who manages the area.

formatint64

city: optional string

City the store is located in.

cost_center: optional string

Cost centre the store books to.

country_code: optional string

ISO country code.

country_name: optional string

Country name.

esl_server_path: optional string

Address of the electronic shelf label server for this store.

free_fields: optional array of object { label, sort_order, value }

Free key/value fields carried against the store.

label: optional string

sort_order: optional number

formatint32

value: optional string

ip_range_begin: optional string

First address in the store’s network range.

ip_range_end: optional string

Last address in the store’s network range.

local_server_path: optional string

Address of the store’s local server.

opening_hours: optional string

Opening hours for the store.

ordering_schema: optional array of object { day, delivery_offset, ordering_offset, 3 more }

Ordering and delivery calendar for the store.

day: number

formatint32

delivery_offset: number

formatint32

ordering_offset: number

formatint32

time: string

formatdate-span

category_code: optional string

week_numbers: optional string

phone_number: optional string

Contact number for the store.

price_line_id: optional number

Price line applied to the store.

formatint32

printers: optional array of object { is_bluetooth, printer_ip, printer_name, printer_type }

Printers configured in the store.

is_bluetooth: boolean

true when the printer connects over Bluetooth.

printer_ip: optional string

Network address of the printer.

printer_name: optional string

Name of the printer.

printer_type: optional number

Type of printer.

formatint32

secondary_key: optional string

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

store_gln: optional string

Global Location Number of the store.

store_name: optional string

Display name of the store.

store_next_delivery_datetime: optional string

Next moment a delivery is expected at this store.

formatdate-time

store_next_ordering_datetime: optional string

Next moment this store can place an order.

formatdate-time

store_number: optional string

Unique store number.

store_stock_pool_1: optional string

Name given to stock pool 1 in this store.

store_stock_pool_10: optional string

Name given to stock pool 10 in this store.

store_stock_pool_2: optional string

Name given to stock pool 2 in this store.

store_stock_pool_3: optional string

Name given to stock pool 3 in this store.

store_stock_pool_4: optional string

Name given to stock pool 4 in this store.

store_stock_pool_5: optional string

Name given to stock pool 5 in this store.

store_stock_pool_6: optional string

Name given to stock pool 6 in this store.

store_stock_pool_7: optional string

Name given to stock pool 7 in this store.

store_stock_pool_8: optional string

Name given to stock pool 8 in this store.

store_stock_pool_9: optional string

Name given to stock pool 9 in this store.

store_type_code: optional string

Type of store.

store_type_description: optional string

Name of that store type.

tertiary_key: optional string

A further alternate identifier for the store.

warehouse_id: optional string

Warehouse this store is supplied from.

list_body: optional map[unknown]

Additional body-level metadata for the list.

list_filters: optional map[array of string]

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

next_page: optional number

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

formatint32

previous_page: optional number

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

formatint64

project_last_modified_date: optional string

Last modified date/time of the project.

scroll_id: optional string

Opaque scroll identifier for deep-pagination scenarios.

server_time: optional string

Server UTC date/time when the response was generated.

sort_column: optional string

Column name the results are sorted by.

sort_order: optional string

Sort direction (asc or desc).

task_last_modified_date: optional string

Last modified date/time of the task.

StoreCreateStoresResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.