Skip to content
Colleqtive Developer
Get started
API Reference
Deliveries

Retrieves a paginated list of delivery orders.

deliveries.list_deliveries(DeliveryListDeliveriesParams**kwargs) -> SyncCursorPage[DeliveryListDeliveriesResponse]
GET/api/v2/public/orders/deliveries

Retrieves a paginated list of delivery orders.

ParametersExpand Collapse
delivery_date: Optional[str]

Filter by delivery date.

group_code: Optional[str]

Filter by group code.

is_submitted: Optional[bool]

Filter by submission status.

last_modified_date: Optional[str]

Filter by last modified date.

order_number: Optional[str]

Filter by order number.

page_size: Optional[int]

The number of records per page.

formatint32
page_start: Optional[int]

The page number to start from.

formatint32
status: Optional[str]

Filter by order status.

store_number: Optional[str]

Filter by store number.

supplier_code: Optional[str]

Filter by supplier code.

supplier_name: Optional[str]

Filter by supplier name.

ReturnsExpand Collapse
class DeliveryListDeliveriesResponse: …
datetime_created: Optional[datetime]
formatdate-time
datetime_expected: Optional[datetime]
formatdate-time
external_reference_number: Optional[str]
import_id: Optional[int]
formatint64
is_downloaded: Optional[bool]
no_of_containers: Optional[int]
formatint32
order_lines: Optional[List[OrderLine]]
barcode: Optional[str]
base_unit: Optional[str]
category_code: Optional[str]
container_barcode: Optional[str]
customer_order_number: Optional[str]
customer_order_shipment_number: Optional[str]
customer_order_shipment_number_line_number: Optional[int]
formatint32
description: Optional[str]
group_code: Optional[str]
line_number: Optional[int]
formatint32
product_number: Optional[str]
purchase_unit_barcode: Optional[str]
purchase_unit_product_number: Optional[str]
purchase_unit_quantity: Optional[float]
formatdouble
quantity: Optional[float]
formatdouble
received_quantity: Optional[float]
formatdouble
target_stock_pool: Optional[int]
formatint32
order_number: Optional[str]
order_type: Optional[str]
status: Optional[str]
store_gln: Optional[str]
store_number: Optional[str]
store_origin: Optional[int]
formatint64
supplier_code: Optional[str]
supplier_name: Optional[str]
tracing_url: Optional[str]
updated_on: Optional[datetime]
formatdate-time

Retrieves a paginated list of delivery 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
)
page = client.deliveries.list_deliveries()
page = page.list[0]
print(page.import_id)
{
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "external_reference_number": "external_reference_number",
      "import_id": 0,
      "is_downloaded": true,
      "no_of_containers": 0,
      "order_lines": [
        {
          "barcode": "barcode",
          "base_unit": "base_unit",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "customer_order_number": "customer_order_number",
          "customer_order_shipment_number": "customer_order_shipment_number",
          "customer_order_shipment_number_line_number": 0,
          "description": "description",
          "group_code": "group_code",
          "line_number": 0,
          "product_number": "product_number",
          "purchase_unit_barcode": "purchase_unit_barcode",
          "purchase_unit_product_number": "purchase_unit_product_number",
          "purchase_unit_quantity": 0,
          "quantity": 0,
          "received_quantity": 0,
          "target_stock_pool": 0
        }
      ],
      "order_number": "order_number",
      "order_type": "order_type",
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "store_origin": 0,
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name",
      "tracing_url": "tracing_url",
      "updated_on": "2019-12-27T18:11:19.117Z"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 4,
  "page_size": 25,
  "page_start": 3,
  "previous_page": 2,
  "project_last_modified_date": "2025-06-10T08:00:00Z",
  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2g",
  "server_time": "2025-06-15T14:30:00Z",
  "sort_column": "name",
  "sort_order": "asc",
  "task_last_modified_date": "2025-06-12T10:15:00Z",
  "total_count": 142
}
Returns Examples
{
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "external_reference_number": "external_reference_number",
      "import_id": 0,
      "is_downloaded": true,
      "no_of_containers": 0,
      "order_lines": [
        {
          "barcode": "barcode",
          "base_unit": "base_unit",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "customer_order_number": "customer_order_number",
          "customer_order_shipment_number": "customer_order_shipment_number",
          "customer_order_shipment_number_line_number": 0,
          "description": "description",
          "group_code": "group_code",
          "line_number": 0,
          "product_number": "product_number",
          "purchase_unit_barcode": "purchase_unit_barcode",
          "purchase_unit_product_number": "purchase_unit_product_number",
          "purchase_unit_quantity": 0,
          "quantity": 0,
          "received_quantity": 0,
          "target_stock_pool": 0
        }
      ],
      "order_number": "order_number",
      "order_type": "order_type",
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "store_origin": 0,
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name",
      "tracing_url": "tracing_url",
      "updated_on": "2019-12-27T18:11:19.117Z"
    }
  ],
  "list_body": {
    "foo": "bar"
  },
  "list_filters": {
    "foo": [
      "string"
    ]
  },
  "next_page": 4,
  "page_size": 25,
  "page_start": 3,
  "previous_page": 2,
  "project_last_modified_date": "2025-06-10T08:00:00Z",
  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2g",
  "server_time": "2025-06-15T14:30:00Z",
  "sort_column": "name",
  "sort_order": "asc",
  "task_last_modified_date": "2025-06-12T10:15:00Z",
  "total_count": 142
}