Skip to content
Colleqtive Developer
Get started
API Reference
Deliveries

List Deliveries

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

Announced inbound deliveries and their current status. Use it to track whether a delivery has been received and submitted.

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

When the order was created.

formatdate-time
required DateTimeOffset DatetimeExpected

When the goods are expected to arrive.

formatdate-time
required Long ImportID

Identifier of the import the order arrived in.

formatint64
required Boolean IsDownloaded

true when the store has pulled the order down.

required Int Type

Type code for the order.

formatint32
required DateTimeOffset UpdatedOn

When the order was last changed.

formatdate-time
string? ExternalReferenceNumber

Reference from the system the order came from.

Int? NoOfContainers

How many containers the goods arrive in.

formatint32
IReadOnlyList<OrderLine>? OrderLines

The lines on this order.

required Int LineNumber

Position of the line within the order.

formatint32
required Double Quantity

Quantity ordered.

formatdouble
required Double ReceivedQuantity

Quantity actually received so far.

formatdouble
required Int TargetStockPool

Stock pool the goods should be booked into.

formatint32
string? Barcode

Barcode for the product.

string? BaseUnit

Unit the quantity is expressed in.

string? CategoryCode

Category the product belongs to.

string? ContainerBarcode

Barcode of the container the line arrives in.

string? CustomerOrderNumber

Customer order this line is reserved for.

string? CustomerOrderShipmentNumber

Shipment this line belongs to.

Int? CustomerOrderShipmentNumberLineNumber

Position of the line within that shipment.

formatint32
string? Description

Product name on the line.

string? GroupCode

Group the product is ordered in.

string? ProductNumber

Product on the line.

string? PurchaseUnitBarcode

Barcode of the purchase unit.

string? PurchaseUnitProductNumber

Product number of the purchase unit.

Double? PurchaseUnitQuantity

How many base units are in one purchase unit.

formatdouble
string? Reference

Your own reference for the order.

Double? RoundedQuantity

Quantity after rounding to a whole purchase unit.

formatdouble
string? SecondaryOrderNumber

Alternate order number, when the source system uses one.

string? OrderNumber

Order number in the source system.

string? OrderType

Type of order, such as a delivery or a transfer.

string? Reference

Your own reference for the order.

string? Status

Current status of the order.

string? StoreGln

Global Location Number of the destination store.

string? StoreNumber

Store the order is for.

string? StoreOrigin

Store the goods come from, for a transfer.

string? SupplierCode

Supplier the order is placed with. Matches supplier_code on the suppliers endpoint.

string? SupplierName

Supplier name.

string? TracingUrl

Link to track the shipment.

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.

List Deliveries

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,
      "type": 0,
      "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,
          "reference": "reference",
          "rounded_quantity": 0,
          "secondary_order_number": "secondary_order_number"
        }
      ],
      "order_number": "order_number",
      "order_type": "order_type",
      "recommended_location": {
        "location_code": "location_code",
        "location_tags_json": "location_tags_json",
        "stock_pool": 0
      },
      "reference": "reference",
      "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"
}
{
  "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
{
  "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,
      "type": 0,
      "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,
          "reference": "reference",
          "rounded_quantity": 0,
          "secondary_order_number": "secondary_order_number"
        }
      ],
      "order_number": "order_number",
      "order_type": "order_type",
      "recommended_location": {
        "location_code": "location_code",
        "location_tags_json": "location_tags_json",
        "stock_pool": 0
      },
      "reference": "reference",
      "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"
}
{
  "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."
}