Creates or updates stores.

stores.create_stores() -> StoreCreateStoresResponse

POST/api/v2/public/stores

Creates or updates stores in bulk. When flush is true, removes existing stores before inserting.

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

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.

store_name: str

Display name of the store.

minLength1

store_number: str

Unique store number identifier.

minLength1

address: Optional[str]

Street address of the store.

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 identifier of the area manager assigned to the store.

formatint64

city: Optional[str]

City of the store.

contact_details: Optional[str]

Free-form contact details for the store.

cost_center: Optional[str]

Cost center associated with the store.

country_code: Optional[str]

ISO country code.

country_name: Optional[str]

Country name.

esl_server_path: Optional[str]

Path to the ESL server.

free_fields: Optional[Iterable[StoreFreeField]]

Custom free-field key/value pairs.

sort_order: int

Sort order for display purposes.

formatint32

key: Optional[str]

Free-field key.

value: Optional[str]

Free-field value.

invent_location: Optional[str]

Inventory location associated with the store.

ip_range_begin: Optional[str]

Start of the store’s IP range.

ip_range_end: Optional[str]

End of the store’s IP range.

legal_entity: Optional[str]

Legal entity associated with the store.

local_server_path: Optional[str]

Path to the local server.

opening_hours: Optional[Iterable[StoreOpeningHour]]

Opening hours for the store, as key/value pairs (e.g. day → 09:00-18:00).

sort_order: int

Sort order for display purposes.

formatint32

key: Optional[str]

Free-field key.

value: Optional[str]

Free-field value.

ordering_schema: Optional[Iterable[StoreOrderingSchema]]

Ordering and delivery calendar entries for the store.

day: int

Day of the week (1=Monday, 7=Sunday).

formatint32

delivery_offset: int

Delivery offset in days.

formatint32

ordering_offset: int

Ordering offset in days.

formatint32

time: Union[str, datetime]

Time of day for the calendar entry.

formatdate-time

category_code: Optional[str]

Optional category code this calendar entry applies to.

week_numbers: Optional[str]

Comma-separated week numbers when this entry applies.

phone_number: Optional[str]

Contact phone number of the store.

postal_code: Optional[str]

Postal code of the store.

price_line_id: Optional[int]

Identifier of the price line applied to the store.

formatint32

store_gln: Optional[str]

Global Location Number (GLN) of the store.

store_next_delivery_datetime: Optional[Union[str, datetime, null]]

Next scheduled delivery datetime for the store.

formatdate-time

store_next_ordering_datetime: Optional[Union[str, datetime, null]]

Next scheduled ordering datetime for the store.

formatdate-time

store_printers: Optional[Iterable[StoreStorePrinter]]

Printers configured at the store.

is_bluetooth: bool

Whether the printer connects via Bluetooth.

printer_type: int

Numeric printer type identifier.

formatint32

printer_ip: Optional[str]

IP address of the printer.

printer_name: Optional[str]

Display name of the printer.

printer_serial: Optional[str]

Serial number of the printer.

vendor: Optional[str]

Vendor / manufacturer of the printer.

store_stock_pool_1: Optional[str]

Name of stock pool 1.

store_stock_pool_10: Optional[str]

Name of stock pool 10.

store_stock_pool_2: Optional[str]

Name of stock pool 2.

store_stock_pool_3: Optional[str]

Name of stock pool 3.

store_stock_pool_4: Optional[str]

Name of stock pool 4.

store_stock_pool_5: Optional[str]

Name of stock pool 5.

store_stock_pool_6: Optional[str]

Name of stock pool 6.

store_stock_pool_7: Optional[str]

Name of stock pool 7.

store_stock_pool_8: Optional[str]

Name of stock pool 8.

store_stock_pool_9: Optional[str]

Name of stock pool 9.

store_type_code: Optional[str]

Code identifying the store type.

store_type_description: Optional[str]

Description of the store type.

ReturnsExpand Collapse

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.

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.success)

{
  "success": true,
  "data": "data",
  "message": "message"
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}