Retrieves a paginated list of receipt orders with receipt lines.

GET/api/v2/public/orders/receipts

Query ParametersExpand Collapse

receipt_type: number

The receipt type (required).

formatint32

from_id: optional number

Filter from this receipt ID.

formatint64

is_submitted: optional boolean

Filter by submission status.

last_modified_date: optional string

Filter by last modified date.

formatdate-time

order_number: optional string

Filter by order number.

page_size: optional number

The number of records per page.

formatint32

page_start: optional number

The page number to start from.

formatint32

store_number: optional string

Filter by store number.

to_id: optional number

Filter up to this receipt ID.

formatint64

ReturnsExpand Collapse

list: array of object { order_number, store_number, datetime_created, 8 more }

order_number: string

The order number.

store_number: string

The store number.

datetime_created: optional string

The datetime the order was created.

formatdate-time

datetime_expected: optional string

The expected delivery datetime.

formatdate-time

import_id: optional number

The import identifier.

formatint64

order_type_id: optional number

The order type identifier.

formatint32

receipt_lines: optional array of object { id, barcode, category_code, 8 more }

The receipt lines for this order.

id: optional number

The receipt line ID.

formatint64

barcode: optional string

The product barcode.

category_code: optional string

The product category code.

container_barcode: optional string

The container barcode.

description: optional string

A description of the line.

group_code: optional string

The group code.

line_number: optional number

The line number.

formatint32

product_number: optional string

The product number.

received_quantity: optional number

The quantity received.

formatdouble

shipped_quantity: optional number

The quantity shipped.

formatdouble

updated_on: optional string

When the line was last updated.

formatdate-time

status: optional string

The order status.

store_gln: optional string

The store GLN.

supplier_code: optional string

The supplier code.

supplier_name: optional string

The supplier name.

next_page: optional number

formatint32

page_size: optional number

formatint32

page_start: optional number

formatint32

previous_page: optional number

formatint32

total_count: optional number

formatint32

Retrieves a paginated list of receipt orders with receipt lines.

curl https://api.colleqtive.net/api/v2/public/orders/receipts \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"

{
  "list": [
    {
      "order_number": "DEL-2025-001",
      "store_number": "STORE001",
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "receipt_lines": [
        {
          "id": 1001,
          "barcode": "8710400000123",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "Organic Milk 1L",
          "group_code": "group_code",
          "line_number": 1,
          "product_number": "PRD-001",
          "received_quantity": 22,
          "shipped_quantity": 24,
          "updated_on": "2019-12-27T18:11:19.117Z"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "supplier_code": "SUP-042",
      "supplier_name": "Acme Wholesale BV"
    }
  ],
  "next_page": 0,
  "page_size": 0,
  "page_start": 0,
  "previous_page": 0,
  "total_count": 0
}

Returns Examples

{
  "list": [
    {
      "order_number": "DEL-2025-001",
      "store_number": "STORE001",
      "datetime_created": "2019-12-27T18:11:19.117Z",
      "datetime_expected": "2019-12-27T18:11:19.117Z",
      "import_id": 0,
      "order_type_id": 0,
      "receipt_lines": [
        {
          "id": 1001,
          "barcode": "8710400000123",
          "category_code": "category_code",
          "container_barcode": "container_barcode",
          "description": "Organic Milk 1L",
          "group_code": "group_code",
          "line_number": 1,
          "product_number": "PRD-001",
          "received_quantity": 22,
          "shipped_quantity": 24,
          "updated_on": "2019-12-27T18:11:19.117Z"
        }
      ],
      "status": "status",
      "store_gln": "store_gln",
      "supplier_code": "SUP-042",
      "supplier_name": "Acme Wholesale BV"
    }
  ],
  "next_page": 0,
  "page_size": 0,
  "page_start": 0,
  "previous_page": 0,
  "total_count": 0
}