Skip to content
Colleqtive Developer
Get started
API Reference
Deliveries

Retrieves a paginated list of delivery orders.

DeliveryListDeliveriesResponse Deliveries.ListDeliveries(DeliveryListDeliveriesParams?parameters, CancellationTokencancellationToken = default)
GET/api/v2/public/orders/deliveries

Retrieves a paginated list of delivery orders.

ParametersExpand Collapse
DeliveryListDeliveriesParams parameters
string deliveryDate

Filter by delivery date.

string groupCode

Filter by group code.

Boolean isSubmitted

Filter by submission status.

string lastModifiedDate

Filter by last modified date.

string orderNumber

Filter by order number.

string pageSize
string pageStart
string secondaryOrderNumber

Filter by secondary order number.

string status

Filter by order status.

string storeNumber

Filter by store number.

string supplierCode

Filter by supplier code.

string supplierName

Filter by supplier name.

ReturnsExpand Collapse
class DeliveryListDeliveriesResponse:

Generic paginated response wrapper.

required Int PageSize

Maximum number of items returned per page.

formatint32
required Int PageStart

Current page number (1-based).

formatint32
required Long TotalCount

Total number of records matching the query across all pages.

formatint64
IReadOnlyList<List>? List

Collection of items for the current page.

required DateTimeOffset DatetimeCreated
formatdate-time
required DateTimeOffset DatetimeExpected
formatdate-time
required Long ImportID
formatint64
required Boolean IsDownloaded
required DateTimeOffset UpdatedOn
formatdate-time
string? ExternalReferenceNumber
Int? NoOfContainers
formatint32
IReadOnlyList<OrderLine>? OrderLines
required Int LineNumber
formatint32
required Double Quantity
formatdouble
required Double ReceivedQuantity
formatdouble
required Int TargetStockPool
formatint32
string? Barcode
string? BaseUnit
string? CategoryCode
string? ContainerBarcode
string? CustomerOrderNumber
string? CustomerOrderShipmentNumber
Int? CustomerOrderShipmentNumberLineNumber
formatint32
string? Description
string? GroupCode
string? ProductNumber
string? PurchaseUnitBarcode
string? PurchaseUnitProductNumber
Double? PurchaseUnitQuantity
formatdouble
Double? RoundedQuantity
formatdouble
string? SecondaryOrderNumber
string? OrderNumber
string? OrderType
string? Status
string? StoreGln
string? StoreNumber
string? StoreOrigin
string? SupplierCode
string? SupplierName
string? TracingUrl
IReadOnlyDictionary<string, JsonElement>? ListBody

Additional body-level metadata for the list.

IReadOnlyDictionary<string, IReadOnlyList<string>>? ListFilters

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

Int? NextPage

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

formatint32
Long? PreviousPage

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

formatint64
string? ProjectLastModifiedDate

Last modified date/time of the project.

string? ScrollID

Opaque scroll identifier for deep-pagination scenarios.

string? ServerTime

Server UTC date/time when the response was generated.

string? SortColumn

Column name the results are sorted by.

string? SortOrder

Sort direction (asc or desc).

string? TaskLastModifiedDate

Last modified date/time of the task.

Retrieves a paginated list of delivery orders.

DeliveryListDeliveriesParams parameters = new();

var response = await client.Deliveries.ListDeliveries(parameters);

Console.WriteLine(response);
{
  "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"
}