---
title: "Get simple list of orders."
method: GET
path: "/rest/api/orders/"
tags: ["Order"]
---

# Get simple list of orders.

`GET /rest/api/orders/`

Example URL for filters and sort: <code>/rest/api/orders/?orderStatus=7&createdAfter=2022-03-01T14%3A40%3A33%2B0200&order&sort=updatedAtDesc</code><br><br>
    The fields orderItems and addressCustomer will be returned conditionally from end of 2022

## Query parameters

- `createdAfter` string, date-time — The date of order creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`
- `createdBefore` string, date-time — Date of order creation from customer, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`
- `orderedAfter` string, date-time — Date of order to customer, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`
- `orderedBefore` string, date-time — Update date from in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`
- `updatedAfter` string, date-time — Update date to in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`
- `updatedBefore` string, date-time — Update date from in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`
- `isOrderDocument` integer — Determines whether a document exists for the order, takes the value of 1 or 0
- `id` string — Order number in Apilo system, e.g. `AL0012345`
- `idExternal` string — External order number, e.g. `5200669628624`
- `orderStatus` integer — Order status according to the order status map
- `orderStatusIds[]` integer[] — Array of Order Status according to the order status map, example: <code>/rest/api/orders/?orderStatusIds[]=1&orderStatusIds[]=2</code>
- `paymentStatus` integer — Order Payment Status <a href='#tag/Order/operation/get_rest_orders_status_map'>Order payment Status </a>
- `paymentType` integer — Order Payment type <a href='#tag/Order/operation/get_rest_orders_payment_map'> Order Payment Type </a>
- `platformAccountId` integer — Platform account Id <a href='#tag/Order/operation/get_rest_orders_platform_map'> Platform account Id </a>
- `carrierId` integer — Carrier account Id <a href='#tag/Order/operation/get_rest_orders_carrier_map'> Carrier account Id </a>
- `email` string — Client E-mail
- `phone` string — Customer phone number in E.164 format e.g. +48123456789. The phone number must start with + sign which is coded in query as %2B e.g. %2B48123456789
- `sort` integer
- `offset` integer — Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)
- `limit` integer — Limit of returned results, max 512 records

## Response `200`

Order array

- object — This object represents list response.
  - `orders` RestOrderListDTO[] — List of orders
    - `id` string — Internal order ID
    - `status` integer, required — <a href='#tag/Order/operation/get_rest_orders_shipment_status_map'>Status ID</a>
    - `idExternal` string, nullable — External order ID, e.g. on the sales platform
    - `isInvoice` boolean — Does the customer want a VAT invoice?
    - `paymentStatus` string — Payment status (`0-no payment`, `1-partially paid`, `2-paid in full/amount in accordance with the order`, `3-overpayment`)
    - `paymentType` integer, required — <a href='#tag/Order/operation/get_rest_orders_payment_map'>Payment method ID</a>
    - `originalCurrency` string, required — Order currency
    - `isEncrypted` boolean — Is order customer data encrypted?
    - `createdAt` string, date-time, nullable — Date when the order was created in Apilo
    - `updatedAt` string, date-time, nullable — Date when the order was updated in Apilo
    - `orderItems` RestOrderItemsDTO3[], required — Order items list
      - `id` integer — Product ID in create/update process, Unique Order Item ID in reading process
      - `idExternal` string — External product item ID
      - `ean` string — EAN
      - `sku` string — SKU
      - `originalName` string — Product name
      - `originalCode` string — Product unique code
      - `originalPriceWithTax` string, required — Gross product price
      - `originalPriceWithoutTax` string — Net product price
      - `media` string — Image URL
      - `quantity` integer, required — Quantity of products
      - `tax` '27.00' | '25.00' | '24.00' | '23.00' | '22.00' | '21.00' | '20.00' | '19.00' | '18.00' | '17.00' | '16.00' | '8.00' | '7.00' | '5.00' | '0.00' | '-1.00' | '' — The amount of VAT (VAT value | `''` if TAX is not specified and will be calculated | `'-1'` when exempt from VAT)
      - `status` string
      - `unit` string — Product unit
      - `type` string, required — Order item type (`1-Product`, `2-Shipment`, `3-service`)
    - `addressCustomer` RestOrderAddressDTO7, required
      - `id` integer — Internal addres ID in Apilo
      - `name` string, required — Client name
      - `phone` string — Client phone
      - `email` string — Client E-mail
      - `streetName` string — Client street name
      - `streetNumber` string — Client street number
      - `city` string — Client city
      - `zipCode` string — Client zip code
      - `country` string — Client country
      - `department` string, nullable
      - `class` 'customer' | 'house' | 'company' | 'parcel'
    - `platformId` integer, required — <a href='#tag/Order/operation/get_rest_orders_platform_map'>Sale platform account ID</a>
    - `isCanceledByBuyer` boolean — Canceled by buyer (Allegro)
    - `carrierId` integer — <a href='#tag/Order/operation/get_rest_orders_carrier_map'>Carrier Id</a>
    - `platformAccountId` integer — <a href='#tag/Order/operation/get_rest_orders_platform_map'>Sale platform account ID</a>
  - `totalCount` integer — Number of matching results
  - `currentOffset` integer — Current list offset
  - `pageResultCount` integer — Number of results per page

## Other responses

- `401` — Authorization failed

---

[API](https://skmtc.dev/apilo/apis/apilo-rest-api.md) · [All operations](https://skmtc.dev/apilo/apis/apilo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apilo/apilo-rest-api/revisions/a0f9dcdba6cc/schema)