Skip to content
Colleqtive Developer
Get started
API Reference
Stores

Creates or updates stores.

stores.create_stores(StoreCreateStoresParams**kwargs) -> StoreCreateStoresResponse
POST/api/v2/public/stores

Creates or updates stores.

ParametersExpand Collapse
flush: Optional[bool]

When true, removes existing stores before inserting.

stores: Optional[Iterable[Store]]

The list of stores to create or update.

is_active: bool
is_active_data_exchange: bool
is_warehouse: bool
store_name: str

Display name of the store.

minLength1
store_number: str

Unique store number identifier.

minLength1
address: Optional[str]
area_description: Optional[str]
area_id: Optional[str]
area_manager_user_id: Optional[int]
formatint64
city: Optional[str]
contact_details: Optional[str]
cost_center: Optional[str]
country_code: Optional[str]
country_name: Optional[str]
esl_server_path: Optional[str]
free_fields: Optional[Iterable[StoreFreeField]]
key: Optional[str]
sort_order: Optional[int]
formatint32
value: Optional[str]
ip_range_begin: Optional[str]
ip_range_end: Optional[str]
local_server_path: Optional[str]
opening_hours: Optional[Iterable[StoreOpeningHour]]
key: Optional[str]
sort_order: Optional[int]
formatint32
value: Optional[str]
ordering_schema: Optional[Iterable[StoreOrderingSchema]]
day: int
formatint32
delivery_offset: int
formatint32
time: Union[str, datetime]
formatdate-time
category_code: Optional[str]
ordering_offset: Optional[int]
formatint32
week_numbers: Optional[str]
phone_number: Optional[str]
postal_code: Optional[str]
price_line_id: Optional[int]
formatint32
store_gln: Optional[str]
store_next_delivery_datetime: Optional[Union[str, datetime, null]]
formatdate-time
store_next_ordering_datetime: Optional[Union[str, datetime, null]]
formatdate-time
store_printers: Optional[Iterable[StoreStorePrinter]]
is_bluetooth: bool
printer_ip: Optional[str]
printer_name: Optional[str]
printer_serial: Optional[str]
printer_type: Optional[int]
formatint32
vendor: Optional[str]
store_stock_pool_1: Optional[str]
store_stock_pool_10: Optional[str]
store_stock_pool_2: Optional[str]
store_stock_pool_3: Optional[str]
store_stock_pool_4: Optional[str]
store_stock_pool_5: Optional[str]
store_stock_pool_6: Optional[str]
store_stock_pool_7: Optional[str]
store_stock_pool_8: Optional[str]
store_stock_pool_9: Optional[str]
store_type_code: Optional[str]
store_type_description: Optional[str]
ReturnsExpand Collapse
class StoreCreateStoresResponse: …

Standard success response returned by mutation endpoints.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

success: Optional[bool]

Indicates whether the operation completed successfully.

Creates or updates 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.create_stores()
print(response.data)
{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}
Returns Examples
{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}