Stores

List Stores

stores.list_stores() -> StoreListStoresResponse

GET/api/v2/public/stores

Create Stores

stores.create_stores() -> StoreCreateStoresResponse

POST/api/v2/public/stores

ModelsExpand 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.

class StoreCreateStoresResponse: …

Standard success response returned by mutation endpoints.

success: bool

Indicates whether the operation completed successfully.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.