List Customer Orders

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.

Path ParametersExpand Collapse

store_number: string

Query ParametersExpand Collapse

fulfillment_status: optional string

Filter on the fulfillment status of the order.

include_locations: optional boolean

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

is_active: optional boolean

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

is_picked: optional boolean

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

order_number: optional string

Returns the single order with this order number.

page_size: optional number

Number of orders per page.

formatint32

page_start: optional number

Page number, starting at 1.

formatint32

pickup_offset: optional number

Shifts the pickup-date window by this many days.

formatint32

reference: optional string

Returns orders carrying this reference.

search_text: optional string

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

show_lines: optional boolean

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

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 { is_active, is_claimed, is_picked, 19 more }

Collection of items for the current page.

is_active: boolean

is_claimed: boolean

is_picked: boolean

is_rejected: boolean

status_id: number

formatint32

total_lines: number

formatint32

total_quantity: number

formatdouble

comment: optional string

customer_name: optional string

description: optional string

lines: optional array of object { id, explicit_order, is_picked, 21 more }

id: number

formatint64

explicit_order: boolean

is_picked: boolean

is_template: boolean

line_number: number

formatint64

picked_quantity: number

formatdouble

price: number

formatdouble

quantity: number

formatdouble

stock_pool: number

formatint32

store_walking_order: number

formatint64

barcode: optional string

delivery_date: optional string

formatdate-time

delivery_qty: optional number

formatdouble

description: optional string

moved_quantity: optional number

formatdouble

next_ordering_datetime: optional string

formatdate-time

picked_username: optional string

picking_stock_pool_array: optional array of string

pickup_date: optional string

formatdate-time

preferred_location_code: optional string

product_number: optional string

reference: optional string

stock_location: optional string

store_locations: optional array of object { location_order, quantity, customer_order_line_number, 16 more }

location_order: number

formatint32

quantity: number

formatdouble

customer_order_line_number: optional number

formatint32

customer_order_number: optional string

customer_order_shipment_line_number: optional number

formatint32

customer_order_shipment_number: optional string

default_stock_pool: optional string

location_code: optional string

most_likely_pool_1: optional number

formatdouble

most_likely_pool_10: optional number

formatdouble

most_likely_pool_2: optional number

formatdouble

most_likely_pool_3: optional number

formatdouble

most_likely_pool_4: optional number

formatdouble

most_likely_pool_5: optional number

formatdouble

most_likely_pool_6: optional number

formatdouble

most_likely_pool_7: optional number

formatdouble

most_likely_pool_8: optional number

formatdouble

most_likely_pool_9: optional number

formatdouble

tags: optional array of string

order_number: optional string

order_type_code: optional string

order_type_description: optional string

pickup_date: optional string

reference: optional string

rejection_reason_code: optional string

rejection_reason_code_description: optional string

sales_order_id: optional string

store_number: optional string

stores_allowed: optional string

total_delivery_quantity: optional number

formatdouble

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.

List Customer Orders

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

{
  "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."
}