---
title: "List Customer Orders"
method: GET
path: "/customer-orders"
tags: ["customer_order"]
---

# List Customer Orders

`GET /customer-orders`

## Request

- Base URL: `https://app.allocadence.com/rest`
- URL: `https://app.allocadence.com/rest/customer-orders`
- Auth: none declared

Get a list of customer orders based on search parameters.

## Query parameters

- `open` boolean
- `completed` boolean
- `draft` boolean
- `cancelled` boolean
- `includePickedItemMetadata` boolean
- `...` string

## Response `200`

Success

- CustomerOrderList
  - `customerOrders` CustomerOrder[]
    - `id` integer
    - `orderNumber` string
    - `orderReference` string
    - `customer` CustomerCompact
      - `id` integer
      - `title` string
      - `name` string
      - `surname` string
      - `email` string
      - `company` string
      - `accountNumber` string
    - `client` ClientCompact
      - `id` integer
      - `name` string
    - `orderedDate` string, date-time
    - `createdDate` string, date-time
    - `modifiedDate` string, date-time
    - `orderPlaced` boolean
    - `createdBy` UserCompact
      - `id` integer
      - `name` string
    - `completed` boolean
    - `completedDate` string, date-time
    - `cancelled` boolean
    - `cancelledDate` string, date-time
    - `cancelledReason` string
    - `cancelledBy` UserCompact
      - `id` integer
      - `name` string
    - `onHold` boolean
    - `onHoldUntil` string, date-time
    - `postageAccount` string
    - `buyerPaidShipping` number
    - `shippingAddress` Address
      - `id` integer
      - `company` string
      - `name` string
      - `line1` string
      - `line2` string
      - `line3` string
      - `city` string
      - `state` string
      - `zip` string
      - `country` string
      - `countryCode` string
      - `phone` string
      - `code` string
      - `verifiedStatus` string
      - `verifiedDate` string, date-time
      - `verifiedMessage` string
    - `billingAddress` Address
      - `id` integer
      - `company` string
      - `name` string
      - `line1` string
      - `line2` string
      - `line3` string
      - `city` string
      - `state` string
      - `zip` string
      - `country` string
      - `countryCode` string
      - `phone` string
      - `code` string
      - `verifiedStatus` string
      - `verifiedDate` string, date-time
      - `verifiedMessage` string
    - `shipVia` string
    - `shipViaPackaging` string
    - `shipViaConfirmation` string
    - `dryIceWeight` number
    - `packageSku` string
    - `shipFromWarehouse` WarehouseCompact
      - `id` integer
      - `name` string
    - `projectNumber` string
    - `discountPercentage` number
    - `orderSource` string
    - `internalNote` string
    - `noteFromCustomer` string
    - `noteToCustomer` string
    - `notificationEmail` string
    - `userField1` string
    - `userField2` string
    - `userField3` string
    - `myList1` string
    - `myList2` string
    - `tags` Tag[]
      - `id` integer
      - `tag` string
      - `note` string
    - `items` CustomerOrderItem[]
      - `id` integer
      - `itemId` integer
      - `sku` string
      - `description` string
      - `orderQuantity` integer
      - `uom` string
      - `quantity` integer
      - `allocatedQuantity` integer
      - `pickedQuantity` integer
      - `price` number
      - `discountPercentage` number
      - `partOfKit` boolean
      - `componentOf` integer
      - `additionalFields` CustomerOrderAdditionalFields
        - `pickedLotNumbers` object[]
          - `lotNumber` string
          - `quantity` number
        - `pickedExpirationDates` object[]
          - `expirationDate` unknown
          - `quantity` number
        - `pickedLotNumbersAndExpirationDates` object[]
          - `lotNumber` string
          - `expirationDate` unknown
          - `quantity` number
        - `pickedSerialNumbers` object[]
          - `serial` string
          - `serialField1` string
          - `serialField2` string
          - `serialField3` string
          - `serialField4` string
  - `meta` PaginationMeta
    - `count` integer: Total number of objects in the result set.
    - `page` integer: The page of the result set in the response.
    - `perPage` integer: Number of objects per page.
    - `totalPages` integer: Total number of pages in the result set.

---

[API](https://skmtc.dev/allocadence/apis/allocadence-rest-api.md) · [All operations](https://skmtc.dev/allocadence/apis/allocadence-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/allocadence/apis/allocadence-rest-api/revisions/0bcd45f547a9?raw)