API Reference

Customer Orders

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Customer Orders

customer_orders.list_customer_orders(strstore_number, CustomerOrderListCustomerOrdersParams**kwargs) -> SyncCursorPage[CustomerOrderListCustomerOrdersResponse]

GET/api/v2/public/stores/{store_number}/orders/customerorders

Customer orders for one store, with their lines when you ask for them. Use it to follow what has been reserved, picked or handed over for a customer.

ParametersExpand Collapse

store_number: str

fulfillment_status: Optional[str]

Filter on the fulfillment status of the order.

include_locations: Optional[bool]

Include the stock location per line. Only takes effect when store product locations are enabled for your organisation, otherwise the field stays empty.

is_active: Optional[bool]

Return only active orders. Set to false to include finished ones.

is_picked: Optional[bool]

Filter on whether the order has been picked. Omit for no filtering.

order_number: Optional[str]

Returns the single order with this order number.

page_size: Optional[int]

Number of orders per page.

formatint32

page_start: Optional[int]

Page number, starting at 1.

formatint32

pickup_offset: Optional[int]

Shifts the pickup-date window by this many days.

formatint32

reference: Optional[str]

Returns orders carrying this reference.

search_text: Optional[str]

Case-insensitive search across the order and its customer details.

show_lines: Optional[bool]

Include the order lines. Left out, only the order headers are returned.

ReturnsExpand 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

List Customer Orders

Python

HTTP

C#

Python

TypeScript

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
)
page = client.customer_orders.list_customer_orders(
    store_number="store_number",
)
page = page.list[0]
print(page.status_id)

200 example

401 example

500 example

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "is_active": true,
      "is_claimed": true,
      "is_picked": true,
      "is_rejected": true,
      "status_id": 0,
      "total_lines": 0,
      "total_quantity": 0,
      "comment": "comment",
      "customer_name": "customer_name",
      "description": "description",
      "lines": [
        {
          "id": 0,
          "explicit_order": true,
          "is_picked": true,
          "is_template": true,
          "line_number": 0,
          "picked_quantity": 0,
          "price": 0,
          "quantity": 0,
          "stock_pool": 0,
          "store_walking_order": 0,
          "barcode": "barcode",
          "delivery_date": "2019-12-27T18:11:19.117Z",
          "delivery_qty": 0,
          "description": "description",
          "moved_quantity": 0,
          "next_ordering_datetime": "2019-12-27T18:11:19.117Z",
          "picked_username": "picked_username",
          "picking_stock_pool_array": [
            "string"
          ],
          "pickup_date": "2019-12-27T18:11:19.117Z",
          "preferred_location_code": "preferred_location_code",
          "product_number": "product_number",
          "reference": "reference",
          "stock_location": "stock_location",
          "store_locations": [
            {
              "location_order": 0,
              "quantity": 0,
              "customer_order_line_number": 0,
              "customer_order_number": "customer_order_number",
              "customer_order_shipment_line_number": 0,
              "customer_order_shipment_number": "customer_order_shipment_number",
              "default_stock_pool": "default_stock_pool",
              "location_code": "location_code",
              "most_likely_pool_1": 0,
              "most_likely_pool_10": 0,
              "most_likely_pool_2": 0,
              "most_likely_pool_3": 0,
              "most_likely_pool_4": 0,
              "most_likely_pool_5": 0,
              "most_likely_pool_6": 0,
              "most_likely_pool_7": 0,
              "most_likely_pool_8": 0,
              "most_likely_pool_9": 0,
              "tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "order_number": "order_number",
      "order_type_code": "order_type_code",
      "order_type_description": "order_type_description",
      "pickup_date": "pickup_date",
      "reference": "reference",
      "rejection_reason_code": "rejection_reason_code",
      "rejection_reason_code_description": "rejection_reason_code_description",
      "sales_order_id": "sales_order_id",
      "store_number": "store_number",
      "stores_allowed": "stores_allowed",
      "total_delivery_quantity": 0
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

{
  "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

200 example

401 example

500 example

{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "is_active": true,
      "is_claimed": true,
      "is_picked": true,
      "is_rejected": true,
      "status_id": 0,
      "total_lines": 0,
      "total_quantity": 0,
      "comment": "comment",
      "customer_name": "customer_name",
      "description": "description",
      "lines": [
        {
          "id": 0,
          "explicit_order": true,
          "is_picked": true,
          "is_template": true,
          "line_number": 0,
          "picked_quantity": 0,
          "price": 0,
          "quantity": 0,
          "stock_pool": 0,
          "store_walking_order": 0,
          "barcode": "barcode",
          "delivery_date": "2019-12-27T18:11:19.117Z",
          "delivery_qty": 0,
          "description": "description",
          "moved_quantity": 0,
          "next_ordering_datetime": "2019-12-27T18:11:19.117Z",
          "picked_username": "picked_username",
          "picking_stock_pool_array": [
            "string"
          ],
          "pickup_date": "2019-12-27T18:11:19.117Z",
          "preferred_location_code": "preferred_location_code",
          "product_number": "product_number",
          "reference": "reference",
          "stock_location": "stock_location",
          "store_locations": [
            {
              "location_order": 0,
              "quantity": 0,
              "customer_order_line_number": 0,
              "customer_order_number": "customer_order_number",
              "customer_order_shipment_line_number": 0,
              "customer_order_shipment_number": "customer_order_shipment_number",
              "default_stock_pool": "default_stock_pool",
              "location_code": "location_code",
              "most_likely_pool_1": 0,
              "most_likely_pool_10": 0,
              "most_likely_pool_2": 0,
              "most_likely_pool_3": 0,
              "most_likely_pool_4": 0,
              "most_likely_pool_5": 0,
              "most_likely_pool_6": 0,
              "most_likely_pool_7": 0,
              "most_likely_pool_8": 0,
              "most_likely_pool_9": 0,
              "tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "order_number": "order_number",
      "order_type_code": "order_type_code",
      "order_type_description": "order_type_description",
      "pickup_date": "pickup_date",
      "reference": "reference",
      "rejection_reason_code": "rejection_reason_code",
      "rejection_reason_code_description": "rejection_reason_code_description",
      "sales_order_id": "sales_order_id",
      "store_number": "store_number",
      "stores_allowed": "stores_allowed",
      "total_delivery_quantity": 0
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 0,
  "previous_page": 0,
  "project_last_modified_date": "project_last_modified_date",
  "scroll_id": "scroll_id",
  "server_time": "server_time",
  "sort_column": "sort_column",
  "sort_order": "sort_order",
  "task_last_modified_date": "task_last_modified_date"
}

{
  "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."
}