Skip to content
Colleqtive Developer
Get started
API Reference
Customer Orders

Create Customer Orders

customer_orders.create_customer_orders(strstore_number, CustomerOrderCreateCustomerOrdersParams**kwargs) -> CustomerOrderCreateCustomerOrdersResponse
POST/api/v2/public/stores/{store_number}/orders/customerorders

Creates customer orders and their lines for one store. Every product_number must already exist in the catalogue; an unknown one rejects the whole request. Setting flush to true first deletes all existing customer orders and lines for the stores in the request, so only use it when you are sending the complete set.

ParametersExpand Collapse
store_number: str
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]
file_name: Optional[str]
is_active: Optional[bool]
is_picked: Optional[bool]
is_rejected: 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]
full_fillment_status: 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
picking_stock_pool_array: Optional[Sequence[str]]
pickup_date: Optional[Union[str, datetime, null]]
formatdate-time
preferred_location_code: Optional[str]
price: Optional[float]
formatdouble
reference: Optional[str]
stock_pool: Optional[int]
formatint32
order_type: Optional[str]
order_type_code: Optional[str]
order_type_description: Optional[str]
reference: Optional[str]
sales_order_id: Optional[str]
status_id: Optional[int]
formatint32
ReturnsExpand Collapse
class CustomerOrderCreateCustomerOrdersResponse: …

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 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_customer_orders(
    store_number="store_number",
)
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."
}