Skip to content
Colleqtive Developer
Get started
API Reference
Deliveries

Retrieves a paginated list of delivery orders.

GET/api/v2/public/orders/deliveries

Retrieves a paginated list of delivery orders.

Query ParametersExpand Collapse
delivery_date: optional string

Filter by delivery date.

group_code: optional string

Filter by group code.

is_submitted: optional boolean

Filter by submission status.

last_modified_date: optional string

Filter by last modified date.

order_number: optional string

Filter by order number.

page_size: optional string
page_start: optional string
secondary_order_number: optional string

Filter by secondary order number.

status: optional string

Filter by order status.

store_number: optional string

Filter by store number.

supplier_code: optional string

Filter by supplier code.

supplier_name: optional string

Filter by supplier name.

ReturnsExpand Collapse
page_size: number

Maximum number of items returned per page.

formatint32
page_start: number

Current page number (1-based).

formatint32
total_count: number

Total number of records matching the query across all pages.

formatint64
list: optional array of object { datetime_created, datetime_expected, import_id, 14 more }

Collection of items for the current page.

datetime_created: string
formatdate-time
datetime_expected: string
formatdate-time
import_id: number
formatint64
is_downloaded: boolean
updated_on: string
formatdate-time
external_reference_number: optional string
no_of_containers: optional number
formatint32
order_lines: optional array of object { line_number, quantity, received_quantity, 16 more }
line_number: number
formatint32
quantity: number
formatdouble
received_quantity: number
formatdouble
target_stock_pool: number
formatint32
barcode: optional string
base_unit: optional string
category_code: optional string
container_barcode: optional string
customer_order_number: optional string
customer_order_shipment_number: optional string
customer_order_shipment_number_line_number: optional number
formatint32
description: optional string
group_code: optional string
product_number: optional string
purchase_unit_barcode: optional string
purchase_unit_product_number: optional string
purchase_unit_quantity: optional number
formatdouble
rounded_quantity: optional number
formatdouble
secondary_order_number: optional string
order_number: optional string
order_type: optional string
status: optional string
store_gln: optional string
store_number: optional string
store_origin: optional string
supplier_code: optional string
supplier_name: optional string
tracing_url: optional string
list_body: optional map[unknown]

Additional body-level metadata for the list.

list_filters: optional map[array of string]

Active filter criteria applied to the result set, keyed by field name.

next_page: optional number

Next page number, or null when on the last page.

formatint32
previous_page: optional number

Previous page number, or null when on the first page.

formatint64
project_last_modified_date: optional string

Last modified date/time of the project.

scroll_id: optional string

Opaque scroll identifier for deep-pagination scenarios.

server_time: optional string

Server UTC date/time when the response was generated.

sort_column: optional string

Column name the results are sorted by.

sort_order: optional string

Sort direction (asc or desc).

task_last_modified_date: optional string

Last modified date/time of the task.

Retrieves a paginated list of delivery orders.

curl https://api.colleqtive.net/api/v2/public/orders/deliveries \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "is_downloaded": true,
      "updated_on": "2019-12-27T18:11:19.117Z",
      "external_reference_number": "external_reference_number",
      "no_of_containers": 0,
      "order_lines": [
        {
          "line_number": 0,
          "quantity": 0,
          "received_quantity": 0,
          "target_stock_pool": 0,
          "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",
          "product_number": "product_number",
          "purchase_unit_barcode": "purchase_unit_barcode",
          "purchase_unit_product_number": "purchase_unit_product_number",
          "purchase_unit_quantity": 0,
          "rounded_quantity": 0,
          "secondary_order_number": "secondary_order_number"
        }
      ],
      "order_number": "order_number",
      "order_type": "order_type",
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "store_origin": "store_origin",
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name",
      "tracing_url": "tracing_url"
    }
  ],
  "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"
}
Returns Examples
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "is_downloaded": true,
      "updated_on": "2019-12-27T18:11:19.117Z",
      "external_reference_number": "external_reference_number",
      "no_of_containers": 0,
      "order_lines": [
        {
          "line_number": 0,
          "quantity": 0,
          "received_quantity": 0,
          "target_stock_pool": 0,
          "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",
          "product_number": "product_number",
          "purchase_unit_barcode": "purchase_unit_barcode",
          "purchase_unit_product_number": "purchase_unit_product_number",
          "purchase_unit_quantity": 0,
          "rounded_quantity": 0,
          "secondary_order_number": "secondary_order_number"
        }
      ],
      "order_number": "order_number",
      "order_type": "order_type",
      "status": "status",
      "store_gln": "store_gln",
      "store_number": "store_number",
      "store_origin": "store_origin",
      "supplier_code": "supplier_code",
      "supplier_name": "supplier_name",
      "tracing_url": "tracing_url"
    }
  ],
  "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"
}