Skip to content
Colleqtive Developer
Get started
API Reference
Customer Orders

List Customer Orders

CustomerOrderListCustomerOrdersPageResponse CustomerOrders.ListCustomerOrders(CustomerOrderListCustomerOrdersParamsparameters, CancellationTokencancellationToken = default)
GET/api/v2/public/stores/{store_number}/orders/customerorders

Customer orders for one store, with their lines when you ask for them. Use it to follow what has been reserved, picked or handed over for a customer.

ParametersExpand Collapse
CustomerOrderListCustomerOrdersParams parameters
required string storeNumber

The store the orders belong to.

string fulfillmentStatus

Filter on the fulfillment status of the order.

Boolean includeLocations

Include the stock location per line. Only takes effect when store product locations are enabled for your organisation, otherwise the field stays empty.

Boolean isActive

Return only active orders. Set to false to include finished ones.

Boolean isPicked

Filter on whether the order has been picked. Omit for no filtering.

string orderNumber

Returns the single order with this order number.

Int pageSize

Number of orders per page.

formatint32
Int pageStart

Page number, starting at 1.

formatint32
Int pickupOffset

Shifts the pickup-date window by this many days.

formatint32
string reference

Returns orders carrying this reference.

string searchText

Case-insensitive search across the order and its customer details.

Boolean showLines

Include the order lines. Left out, only the order headers are returned.

ReturnsExpand Collapse
class CustomerOrderListCustomerOrdersPageResponse:

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<CustomerOrderListCustomerOrdersResponse>? List

Collection of items for the current page.

required Boolean IsActive
required Boolean IsClaimed
required Boolean IsPicked
required Boolean IsRejected
required Int StatusID
formatint32
required Int TotalLines
formatint32
required Double TotalQuantity
formatdouble
string? Comment
string? CustomerName
string? Description
IReadOnlyList<Line>? Lines
required Long ID
formatint64
required Boolean ExplicitOrder
required Boolean IsPicked
required Boolean IsTemplate
required Long LineNumber
formatint64
required Double PickedQuantity
formatdouble
required Double Price
formatdouble
required Double Quantity
formatdouble
required Int StockPool
formatint32
required Long StoreWalkingOrder
formatint64
string? Barcode
DateTimeOffset? DeliveryDate
formatdate-time
Double? DeliveryQty
formatdouble
string? Description
Double? MovedQuantity
formatdouble
DateTimeOffset? NextOrderingDatetime
formatdate-time
string? PickedUsername
IReadOnlyList<string>? PickingStockPoolArray
DateTimeOffset? PickupDate
formatdate-time
string? PreferredLocationCode
string? ProductNumber
string? Reference
string? StockLocation
IReadOnlyList<StoreLocation>? StoreLocations
required Int LocationOrder
formatint32
required Double Quantity
formatdouble
Int? CustomerOrderLineNumber
formatint32
string? CustomerOrderNumber
Int? CustomerOrderShipmentLineNumber
formatint32
string? CustomerOrderShipmentNumber
string? DefaultStockPool
string? LocationCode
Double? MostLikelyPool1
formatdouble
Double? MostLikelyPool10
formatdouble
Double? MostLikelyPool2
formatdouble
Double? MostLikelyPool3
formatdouble
Double? MostLikelyPool4
formatdouble
Double? MostLikelyPool5
formatdouble
Double? MostLikelyPool6
formatdouble
Double? MostLikelyPool7
formatdouble
Double? MostLikelyPool8
formatdouble
Double? MostLikelyPool9
formatdouble
IReadOnlyList<string>? Tags
string? OrderNumber
string? OrderTypeCode
string? OrderTypeDescription
string? PickupDate
string? Reference
string? RejectionReasonCode
string? RejectionReasonCodeDescription
string? SalesOrderID
string? StoreNumber
string? StoresAllowed
Double? TotalDeliveryQuantity
formatdouble
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 Customer Orders

CustomerOrderListCustomerOrdersParams parameters = new()
{
    StoreNumber = "store_number"
};

var page = await client.CustomerOrders.ListCustomerOrders(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
{
  "page_size": 0,
  "page_start": 0,
  "total_count": 0,
  "list": [
    {
      "is_active": true,
      "is_claimed": true,
      "is_picked": true,
      "is_rejected": true,
      "status_id": 0,
      "total_lines": 0,
      "total_quantity": 0,
      "comment": "comment",
      "customer_name": "customer_name",
      "description": "description",
      "lines": [
        {
          "id": 0,
          "explicit_order": true,
          "is_picked": true,
          "is_template": true,
          "line_number": 0,
          "picked_quantity": 0,
          "price": 0,
          "quantity": 0,
          "stock_pool": 0,
          "store_walking_order": 0,
          "barcode": "barcode",
          "delivery_date": "2019-12-27T18:11:19.117Z",
          "delivery_qty": 0,
          "description": "description",
          "moved_quantity": 0,
          "next_ordering_datetime": "2019-12-27T18:11:19.117Z",
          "picked_username": "picked_username",
          "picking_stock_pool_array": [
            "string"
          ],
          "pickup_date": "2019-12-27T18:11:19.117Z",
          "preferred_location_code": "preferred_location_code",
          "product_number": "product_number",
          "reference": "reference",
          "stock_location": "stock_location",
          "store_locations": [
            {
              "location_order": 0,
              "quantity": 0,
              "customer_order_line_number": 0,
              "customer_order_number": "customer_order_number",
              "customer_order_shipment_line_number": 0,
              "customer_order_shipment_number": "customer_order_shipment_number",
              "default_stock_pool": "default_stock_pool",
              "location_code": "location_code",
              "most_likely_pool_1": 0,
              "most_likely_pool_10": 0,
              "most_likely_pool_2": 0,
              "most_likely_pool_3": 0,
              "most_likely_pool_4": 0,
              "most_likely_pool_5": 0,
              "most_likely_pool_6": 0,
              "most_likely_pool_7": 0,
              "most_likely_pool_8": 0,
              "most_likely_pool_9": 0,
              "tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "order_number": "order_number",
      "order_type_code": "order_type_code",
      "order_type_description": "order_type_description",
      "pickup_date": "pickup_date",
      "reference": "reference",
      "rejection_reason_code": "rejection_reason_code",
      "rejection_reason_code_description": "rejection_reason_code_description",
      "sales_order_id": "sales_order_id",
      "store_number": "store_number",
      "stores_allowed": "stores_allowed",
      "total_delivery_quantity": 0
    }
  ],
  "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": [
    {
      "is_active": true,
      "is_claimed": true,
      "is_picked": true,
      "is_rejected": true,
      "status_id": 0,
      "total_lines": 0,
      "total_quantity": 0,
      "comment": "comment",
      "customer_name": "customer_name",
      "description": "description",
      "lines": [
        {
          "id": 0,
          "explicit_order": true,
          "is_picked": true,
          "is_template": true,
          "line_number": 0,
          "picked_quantity": 0,
          "price": 0,
          "quantity": 0,
          "stock_pool": 0,
          "store_walking_order": 0,
          "barcode": "barcode",
          "delivery_date": "2019-12-27T18:11:19.117Z",
          "delivery_qty": 0,
          "description": "description",
          "moved_quantity": 0,
          "next_ordering_datetime": "2019-12-27T18:11:19.117Z",
          "picked_username": "picked_username",
          "picking_stock_pool_array": [
            "string"
          ],
          "pickup_date": "2019-12-27T18:11:19.117Z",
          "preferred_location_code": "preferred_location_code",
          "product_number": "product_number",
          "reference": "reference",
          "stock_location": "stock_location",
          "store_locations": [
            {
              "location_order": 0,
              "quantity": 0,
              "customer_order_line_number": 0,
              "customer_order_number": "customer_order_number",
              "customer_order_shipment_line_number": 0,
              "customer_order_shipment_number": "customer_order_shipment_number",
              "default_stock_pool": "default_stock_pool",
              "location_code": "location_code",
              "most_likely_pool_1": 0,
              "most_likely_pool_10": 0,
              "most_likely_pool_2": 0,
              "most_likely_pool_3": 0,
              "most_likely_pool_4": 0,
              "most_likely_pool_5": 0,
              "most_likely_pool_6": 0,
              "most_likely_pool_7": 0,
              "most_likely_pool_8": 0,
              "most_likely_pool_9": 0,
              "tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "order_number": "order_number",
      "order_type_code": "order_type_code",
      "order_type_description": "order_type_description",
      "pickup_date": "pickup_date",
      "reference": "reference",
      "rejection_reason_code": "rejection_reason_code",
      "rejection_reason_code_description": "rejection_reason_code_description",
      "sales_order_id": "sales_order_id",
      "store_number": "store_number",
      "stores_allowed": "stores_allowed",
      "total_delivery_quantity": 0
    }
  ],
  "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."
}