---
title: "Get detailed order by given ID."
method: GET
path: "/rest/api/orders/{id}/"
tags: ["Order"]
---

# Get detailed order by given ID.

`GET /rest/api/orders/{id}/`

## Path parameters

- `id` string, required

## Response `200`

Detailed order object

- RestOrderDetailDTO — This object represents a single order.
  - `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?
  - `customerLogin` string
  - `paymentStatus` string, required — 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
  - `originalAmountTotalWithoutTax` string, nullable, required — Value of the order items without tax
  - `originalAmountTotalWithTax` string, nullable, required — Value of order items including tax
  - `originalAmountTotalPaid` string, nullable, required — Gross amount paid by customer in original currency
  - `sendDateMin` string, date-time, nullable — Minimal shipping date
  - `sendDateMax` string, date-time, nullable — Maximum shipping date
  - `isEncrypted` boolean — Is order customer data encrypted?
  - `preferences` object — Extra order fields
    - `idUser` string
  - `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` RestOrderItemsDTO2[], 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`)
    - `productId` integer, nullable — Internal <a href='#tag/Warehouse/operation/get_rest_warehouse_product_index'>Product ID</a> in Apilo (according to product card)
    - `productSet` integer, nullable — Product Set
  - `orderPayments` RestOrderPaymentDTO2[] — Order payments list
    - `id` integer — Internal payment ID in Apilo
    - `idExternal` string — External payment ID
    - `type` integer, required — <a href='#tag/Order/operation/get_rest_orders_payment_map'>Payment method ID</a>
    - `paymentDate` string, date-time, nullable, required — Date of payment
    - `amount` string, nullable, required — Amount of payment
    - `currency` string, nullable — Payment currency
    - `comment` string
  - `addressCustomer` RestOrderAddressDTO4, 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
    - `parcelIdExternal` string — Pickup point ID
    - `parcelName` string — Pickup point name
    - `class` 'customer' | 'house' | 'company' | 'parcel'
    - `companyTaxNumber` string — Company tax ID
    - `companyName` string — Company name
  - `addressDelivery` RestOrderAddressDTO5, 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
    - `parcelIdExternal` string — Pickup point ID
    - `parcelName` string — Pickup point name
    - `class` 'customer' | 'house' | 'company' | 'parcel'
    - `companyTaxNumber` string — Company tax ID
    - `companyName` string — Company name
  - `addressInvoice` RestOrderAddressDTO6
    - `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
    - `parcelIdExternal` string — Pickup point ID
    - `parcelName` string — Pickup point name
    - `class` 'customer' | 'house' | 'company' | 'parcel'
    - `companyTaxNumber` string — Company tax ID
    - `companyName` string — Company name
  - `carrierAccount` integer, required — <a href='#tag/Order/operation/get_rest_orders_carrier_account_map'>Carrier account ID</a>
  - `orderNotes` RestOrderNoteDTO3[] — Order notes and comments
    - `id` integer — Internal order ID in Apilo
    - `type` 1 | 2 — Type of the note
    - `createdAt` string, date-time, nullable — Time when created note
    - `comment` string, required — Note content
  - `orderedAt` string, date-time, nullable, required — Date when the order was created by the customer
  - `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>
  - `orderDiscounts` RestOrderDiscountDTO[], nullable — Order discounts
    - `id` integer — Internal addres ID in Apilo
    - `idExternal` string — External order discount ID
    - `type` 1 | 2 — Discount type. 1 - product, 2 - shipment
    - `note` string — Additional information about discount
    - `discountValue` string — Discount value

## Other responses

- `401` — Authorization failed
- `404` — Order not found

---

[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)