Get Order By Id

GET /v1/order/:id

Retrieves detailed information about a specific order using its unique identifier. The response includes the order's current status, pricing breakdown, account details, delivery information, and all associated line items. Optional query parameters allow you to populate related resources like reference orders and subscriptions for a more complete view.

Query Parameters

• ~populate[] - Parameter for ~populate[]

Request Example

GET /v1/order/:id

Response Example

{
  "_id": "order-id-1",
  "id": "order-id-1",
  "status": "accepted",
  "state": "open",
  "offering": {
    "name": "Example Offering",
    "description": "{\"blocks\":[{\"key\":\"1\",\"text\":\"Overview:\",\"type\":\"unstyled\"}],\"entityMap\":{}}",
    "image": "https://example.com/image.png"
  },
  "edition": {
    "name": "Standard"
  },
  "parent": {
    "account": {
      "tenant": "tenant-id-parent-1"
    }
  },
  "tenant": "tenant-id-1",
  "account": "account-id-1",
  "account_details": {
    "status": { "active": true },
    "address": {
      "postal": {
        "line2": "",
        "street": "Example Street 1",
        "zip": "0001",
        "city": "Example City",
        "country": "NO",
        "state": "",
        "editable": true,
        "_id": "address-id-1"
      },
      "delivery": {
        "line2": "",
        "street": "Example Street 1",
        "zip": "0001",
        "city": "Example City",
        "country": "NO",
        "state": "",
        "editable": true,
        "_id": "address-id-2"
      },
      "official": {
        "line2": "",
        "street": "Example Street 1",
        "zip": "0001",
        "city": "Example City",
        "country": "NO",
        "state": "",
        "editable": true,
        "_id": "address-id-3"
      },
      "invoice": {
        "line2": "",
        "street": "Example Street 1",
        "zip": "0001",
        "city": "Example City",
        "country": "NO",
        "state": "",
        "editable": true,
        "_id": "address-id-4"
      },
      "visit": {
        "line2": "",
        "street": "Example Street 1",
        "zip": "0001",
        "city": "Example City",
        "country": "NO",
        "state": "",
        "editable": true,
        "_id": "address-id-5"
      }
    },
    "email": { "default": "user@example.com" },
    "metadata": { "last_login": "2025-06-20T07:59:10.167Z" },
    "_id": "account-id-1",
    "type": "customer",
    "comment": "",
    "number": "123456789",
    "country": "NO",
    "name": "Example Account",
    "bankaccount": [],
    "accountmanager": "user-id-1",
    "contacts": [],
    "integrations": [],
    "primaryuser": "user-id-2",
    "tenant": "tenant-id-1",
    "created": "2025-06-19T23:12:09.486Z",
    "updated": "2025-06-20T07:59:10.175Z",
    "__v": 0,
    "partnerLevel": null,
    "id": "account-id-1"
  },
  "currency": {
    "type": "NOK",
    "rate": 1
  },
  "price": {
    "full": 2339.71,
    "discount": 467.94,
    "subtotal": 1871.77,
    "total": 1871.77,
    "cost": 1732,
    "_id": "price-id-1",
    "mrr": 0,
    "monthlyDiscountPrice": 0,
    "monthlyCostPrice": 0,
    "monthlyPrice": 0,
    "billingDiscountPrice": 0,
    "billingCostPrice": 0,
    "billingPrice": 0,
    "agreementDiscountPrice": 467.94,
    "agreementCostPrice": 1732,
    "agreementPrice": 1871.77,
    "dueDiscountPrice": 467.94,
    "dueCostPrice": 1732,
    "duePrice": 1871.77,
    "oneTimeDiscountPrice": 467.94,
    "oneTimeCostPrice": 1732,
    "oneTimePrice": 1871.77
  },
  "sales_contact": {
    "id": "user-id-1",
    "firstname": "Alex",
    "lastname": "Doe",
    "email": "user@example.com",
    "phone": "4700000000"
  },
  "number": "00000001",
  "date": {
    "delivery": "2025-06-20T08:27:58.763Z",
    "order": "2025-06-20T08:27:58.763Z",
    "start": "2025-06-20T08:27:58.763Z",
    "end": "2026-06-20T08:28:56.693Z",
    "confirmation": "2025-06-20T08:28:56.693Z"
  },
  "created": "2025-06-20T08:27:58.763Z",
  "updated": "2025-06-20T08:28:56.736Z",
  "order_date": "2025-06-20T08:27:58.763Z",
  "delivery_date": "2025-06-20T08:27:58.763Z",
  "start_date": null,
  "end_date": null
}