latestOpenAPI 3.0.12026-08-18132038.0 KB

310150fbd68d

Orders

List orders eligible for the weekly client budget export

Returns orders with their items. Supports filtering by customer (Plunet id), completion state (all items approved), and incremental polling via updated_since.

get/V1/orders

Query parameters

customer_plunet_idinteger

Filter to a single customer (matches Order.customer_id, which stores the customer Plunet id).

all_items_approvedboolean

When true, keep only orders that have at least one item AND whose every item is in 'approved' status.

updated_sincestring date-time

ISO 8601 timestamp. Restricts to orders updated since this date.

pageinteger

per_pageinteger

Response

matching orders

Example response

{
  "data": [
    {
      "id": "O-78901",
      "order_reference": "ORD-2025-789",
      "quote_number": "Q-1446-01",
      "status": "completed",
      "all_items_approved": true,
      "client": {
        "id": 12345,
        "name": "AcmeCorp"
      },
      "currency": "EUR",
      "total_price": 4117.92,
      "client_ccy": "USD",
      "total_price_in_client_ccy": 4500,
      "items": [
        {
          "id": "I-44556",
          "language_source": "en-US",
          "language_target": "fr-FR",
          "quantity": 1200,
          "price": 1372.64,
          "currency": "EUR",
          "client_price": 1500,
          "client_currency": "USD",
          "status": "approved"
        }
      ]
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 50
  }
}