Skip to content
Colleqtive Developer
Get started
API Reference
Customer Orders

Create Multi Store Customer Orders

customer_orders.create_multi_store_customer_orders(CustomerOrderCreateMultiStoreCustomerOrdersParams**kwargs) -> CustomerOrderCreateMultiStoreCustomerOrdersResponse
POST/api/v2/public/orders/customerorders

Same as the single-store customer order endpoint, but each order names its own store, so one call can cover several stores. flush deletes existing customer orders for every store named in the request.

ParametersExpand Collapse
flush: Optional[bool]

Deletes all existing customer orders for the stores in the request before inserting.

orders: Optional[Iterable[Order]]
order_number: str
minLength1
customer_city: Optional[str]
customer_country: Optional[str]
customer_email: Optional[str]
customer_name: Optional[str]
customer_number: Optional[str]
customer_phone: Optional[str]
customer_street: Optional[str]
customer_zipcode: Optional[str]
delivery_city: Optional[str]
delivery_country: Optional[str]
delivery_street: Optional[str]
delivery_zipcode: Optional[str]
description: Optional[str]
is_picked: Optional[bool]
order_comment: Optional[str]
order_lines: Optional[Iterable[OrderOrderLine]]
line_number: int
formatint64
product_number: str
minLength1
quantity: float
formatdouble
barcode: Optional[str]
delivery_date: Optional[Union[str, datetime]]
formatdate-time
description: Optional[str]
is_picked: Optional[bool]
is_picked_from_warehouse: Optional[bool]
ordering_datetime: Optional[Union[str, datetime]]
formatdate-time
picked_quantity: Optional[float]
formatdouble
pickup_date: Optional[Union[str, datetime]]
formatdate-time
price: Optional[float]
formatdouble
stock_pool: Optional[int]
formatint32
order_type_code: Optional[str]
order_type_description: Optional[str]
reference: Optional[str]
store_number: Optional[str]
stores_allowed: Optional[Sequence[str]]
ReturnsExpand Collapse
class CustomerOrderCreateMultiStoreCustomerOrdersResponse: …

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.

Create Multi Store Customer Orders

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.customer_orders.create_multi_store_customer_orders()
print(response.success)
{
  "success": true,
  "data": "data",
  "message": "message"
}
{
  "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
{
  "success": true,
  "data": "data",
  "message": "message"
}
{
  "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."
}