Skip to main content

Get POs

GET /v1/purchase-order

Retrieves a paginated list of purchase orders for the authenticated tenant. Results include order status, amounts, distributor and customer references, item lines, and timestamps for order lifecycle events.

Query Parameters​

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

Request Example​

GET /v1/purchase-order

Response Example​

{
  "orders": [
    {
      "_id": "order-id-1",
      "tenant": "tenant-id-1",
      "status": "accepted",
      "state": "",
      "deleted": false,
      "currency": {
        "type": "NOK",
        "rate": 1
      },
      "price": 1732,
      "distributor": {
        "id": "distributor-id-1",
        "name": "Example Distributor"
      },
      "date": {
        "order": "2025-06-20T08:59:55.051Z",
        "accepted": "2025-06-20T09:01:10.466Z",
        "canceled": null,
        "draft": "2025-06-20T09:01:10.467Z",
        "confirmed": null,
        "delivered": null
      },
      "customer": {
        "id": "account-id-1",
        "name": "Example Account",
        "tenant": "tenant-id-2"
      },
      "items": [
        {
          "unit": { "price": 1732 },
          "date": { "delivery": null, "rest": null },
          "id": "product-id-1",
          "group_id": "product-group-id-1",
          "name": "Example Product A",
          "sku": "SKU-001",
          "isSubscription": false,
          "amount": 1,
          "price": 1732
        }
      ],
      "orderId": "external-order-id-1",
      "created": "2025-06-20T08:59:55.098Z",
      "updated": "2025-06-20T09:01:10.468Z"
    },
    {
      "_id": "order-id-2",
      "tenant": "tenant-id-1",
      "status": "accepted",
      "state": "",
      "deleted": false,
      "currency": {
        "type": "NOK",
        "rate": 1
      },
      "price": 2595.45,
      "distributor": {
        "id": "distributor-id-1",
        "name": "Example Distributor"
      },
      "date": {
        "order": "2025-06-20T08:35:43.204Z",
        "accepted": "2025-06-20T09:00:45.588Z",
        "canceled": null,
        "draft": "2025-06-20T09:00:45.589Z",
        "confirmed": null,
        "delivered": null
      },
      "customer": {
        "id": "account-id-1",
        "name": "Example Account",
        "tenant": "tenant-id-2"
      },
      "items": [
        {
          "unit": { "price": 519.09 },
          "date": { "delivery": null, "rest": null },
          "id": "product-id-2",
          "group_id": "product-group-id-2",
          "name": "Example Product B",
          "sku": "SKU-002",
          "isSubscription": false,
          "amount": 5,
          "price": 2595.45
        }
      ],
      "orderId": "external-order-id-2",
      "created": "2025-06-20T08:35:43.334Z",
      "updated": "2025-06-20T09:00:45.590Z"
    }
  ],
  "metadata": {
    "total": 2,
    "page": 0,
    "perPage": 25,
    "maxPageSize": 1000"
  }
}