Skip to content
Colleqtive Developer
Get started
API Reference

Customer Orders

List Customer Orders
customer_orders.list_customer_orders(strstore_number, CustomerOrderListCustomerOrdersParams**kwargs) -> SyncCursorPage[CustomerOrderListCustomerOrdersResponse]
GET/api/v2/public/stores/{store_number}/orders/customerorders
Create Customer Orders
customer_orders.create_customer_orders(strstore_number, CustomerOrderCreateCustomerOrdersParams**kwargs) -> CustomerOrderCreateCustomerOrdersResponse
POST/api/v2/public/stores/{store_number}/orders/customerorders
Create Multi Store Customer Orders
customer_orders.create_multi_store_customer_orders(CustomerOrderCreateMultiStoreCustomerOrdersParams**kwargs) -> CustomerOrderCreateMultiStoreCustomerOrdersResponse
POST/api/v2/public/orders/customerorders
Update Customer Order
customer_orders.update_customer_order(strstore_number, CustomerOrderUpdateCustomerOrderParams**kwargs) -> CustomerOrderUpdateCustomerOrderResponse
PUT/api/v2/public/stores/{store_number}/orders/customerorder
Create Customer Order Clearance
customer_orders.create_customer_order_clearance(CustomerOrderCreateCustomerOrderClearanceParams**kwargs) -> CustomerOrderCreateCustomerOrderClearanceResponse
POST/api/v2/public/customerorders/clearance
ModelsExpand Collapse
class CustomerOrderListCustomerOrdersResponse: …

Properties

is_active: bool
is_claimed: bool
is_picked: bool
is_rejected: bool
status_id: int
formatint32
total_lines: int
formatint32
total_quantity: float
formatdouble
comment: Optional[str]
customer_name: Optional[str]
description: Optional[str]
lines: Optional[List[Line]]
id: int
formatint64
explicit_order: bool
is_picked: bool
is_template: bool
line_number: int
formatint64
picked_quantity: float
formatdouble
price: float
formatdouble
quantity: float
formatdouble
stock_pool: int
formatint32
store_walking_order: int
formatint64
barcode: Optional[str]
delivery_date: Optional[datetime]
formatdate-time
delivery_qty: Optional[float]
formatdouble
description: Optional[str]
moved_quantity: Optional[float]
formatdouble
next_ordering_datetime: Optional[datetime]
formatdate-time
picked_username: Optional[str]
picking_stock_pool_array: Optional[List[str]]
pickup_date: Optional[datetime]
formatdate-time
preferred_location_code: Optional[str]
product_number: Optional[str]
reference: Optional[str]
stock_location: Optional[str]
store_locations: Optional[List[LineStoreLocation]]
location_order: int
formatint32
quantity: float
formatdouble
customer_order_line_number: Optional[int]
formatint32
customer_order_number: Optional[str]
customer_order_shipment_line_number: Optional[int]
formatint32
customer_order_shipment_number: Optional[str]
default_stock_pool: Optional[str]
location_code: Optional[str]
most_likely_pool_1: Optional[float]
formatdouble
most_likely_pool_10: Optional[float]
formatdouble
most_likely_pool_2: Optional[float]
formatdouble
most_likely_pool_3: Optional[float]
formatdouble
most_likely_pool_4: Optional[float]
formatdouble
most_likely_pool_5: Optional[float]
formatdouble
most_likely_pool_6: Optional[float]
formatdouble
most_likely_pool_7: Optional[float]
formatdouble
most_likely_pool_8: Optional[float]
formatdouble
most_likely_pool_9: Optional[float]
formatdouble
tags: Optional[List[str]]
order_number: Optional[str]
order_type_code: Optional[str]
order_type_description: Optional[str]
pickup_date: Optional[str]
reference: Optional[str]
rejection_reason_code: Optional[str]
rejection_reason_code_description: Optional[str]
sales_order_id: Optional[str]
store_number: Optional[str]
stores_allowed: Optional[str]
total_delivery_quantity: Optional[float]
formatdouble
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.

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.

class CustomerOrderUpdateCustomerOrderResponse: …

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.

class CustomerOrderCreateCustomerOrderClearanceResponse: …

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.