Skip to main content

Get Orders Details

GET /v2/order/detailed

Returns a detailed collection of order line items. Each item includes subscription terms, key dates, sales contact, customer and service info, pricing, currency, tenant identifiers, and pagination metadata.

Query Parameters​

  • filter[tenant] - Parameter for filter[tenant]
  • ~sort - Parameter for ~sort
  • ~search - Parameter for ~search
  • ~page - Parameter for ~page
  • ~perPage - Parameter for ~perPage
  • ~filter[from] - Parameter for ~filter[from]
  • ~filter[status] - Parameter for ~filter[status]
  • ~filter[to] - Parameter for ~filter[to]

Request Example​

GET /v2/order/detailed?filter[tenant]=!6065a9eb6783e09eb34bb844

Headers​

  • \~session - Custom header for ~session (Example: \{\{AUTH_TOKEN\}\})

Response Example​

{
  "orders": [
    {
      "status": "accepted",
      "state": "open",
      "subscription": {
        "id": "subscription-id-1",
        "name": "Custom: 36 months",
        "length": 36,
        "discount": 0
      },
      "date": {
        "delivery": "2025-06-27T00:00:00.000Z",
        "order": "2025-06-27T00:00:00.000Z",
        "start": "2025-06-27T00:00:00.000Z",
        "end": "2026-06-26T23:59:59.999Z",
        "confirmation": null
      },
      "sales_contact": {
        "id": "user-id-1",
        "firstname": "Example",
        "lastname": "User",
        "email": "user@example.com",
        "phone": "+4790000000"
      },
      "created": "2025-10-02T19:08:06.270Z",
      "updated": "2025-10-02T19:08:06.270Z",
      "_id": "orderline-id-1",
      "orderId": "order-id-1",
      "customer": {
        "id": "customer-id-1",
        "name": "Example Customer A"
      },
      "item": {
        "id": "item-id-1",
        "name": "BaaS M365 Unlimited",
        "quantity": 1000
      },
      "totalPrice": null,
      "currency": "NOK",
      "service": {
        "name": "M365 Backup"
      },
      "tenant": "tenant-id-1",
      "subscriptionId": "subscription-ref-1"
    },
    {
      "status": "draft",
      "state": "open",
      "subscription": {
        "id": "subscription-id-2",
        "name": "Custom: 36 months",
        "length": 36,
        "discount": 0
      },
      "date": {
        "delivery": "2025-10-02T19:06:32.046Z",
        "order": "2025-10-02T19:06:32.046Z",
        "start": "2025-10-02T19:06:32.046Z",
        "end": "2025-10-31T23:59:59.999Z",
        "confirmation": null
      },
      "sales_contact": {
        "id": "user-id-1",
        "firstname": "Example",
        "lastname": "User",
        "email": "user@example.com",
        "phone": "+4790000000"
      },
      "created": "2025-10-02T19:08:04.608Z",
      "updated": "2025-10-29T00:05:18.085Z",
      "_id": "orderline-id-2",
      "orderId": "order-id-2",
      "customer": {
        "id": "customer-id-1",
        "name": "Example Customer A"
      },
      "item": {
        "id": "item-id-2",
        "name": "BaaS M365 Unlimited",
        "quantity": 0
      },
      "totalPrice": null,
      "currency": "NOK",
      "service": {
        "name": "M365 Backup"
      },
      "tenant": "tenant-id-1",
      "subscriptionId": "subscription-ref-1"
    },
    {
      "status": "confirmed",
      "state": "open",
      "subscription": {
        "id": "subscription-id-3",
        "name": "3 years",
        "length": 36,
        "discount": 20
      },
      "date": {
        "delivery": "2025-06-20T08:39:21.978Z",
        "order": "2025-06-20T08:39:21.978Z",
        "start": "2025-06-20T08:39:21.978Z",
        "end": "2028-06-27T11:16:40.737Z",
        "confirmation": "2025-06-27T11:16:40.737Z"
      },
      "sales_contact": {
        "id": "user-id-1",
        "firstname": "Example",
        "lastname": "User",
        "email": "user@example.com",
        "phone": "+4790000000"
      },
      "created": "2025-06-20T08:39:21.978Z",
      "updated": "2025-06-27T11:16:40.785Z",
      "_id": "orderline-id-3",
      "orderId": "order-id-3",
      "customer": {
        "id": "customer-id-1",
        "name": "Example Customer A"
      },
      "item": {
        "id": "item-id-3",
        "name": "BaaS M365 Unlimited",
        "quantity": 1000,
        "unitPrice": 55
      },
      "totalPrice": 55000,
      "currency": "NOK",
      "service": {
        "name": "M365 Backup"
      },
      "tenant": "tenant-id-1"
    }
  ],
  "metadata": {
    "total": 41
  }
}