ProcurementOrder List

Retrieve a list of procurement orders for a partner. All costs are converted to the partner's currency. Supports optional filtering by date range and order status.

POST /procurement/v1/order/list

Authentication

Include your API key in the X-API-KEY header.

Request example

{
  "filterBy": {
    "dateFrom": "2026-01-01T00:00:00Z",
    "dateTo": "2026-03-31T23:59:59Z",
    "status": ["delivered", "invoiced"]
  },
  "pagination": {
    "pageNumber": 1,
    "perPage": 50
  }
}

Success response example

{
  "orders": [
    {
      "orderId": 100,
      "partnerPoNumber": "PO-2026-001",
      "supplierUid": "supplier-abc-123",
      "status": "delivered",
      "currency": "EUR",
      "shippingCost": 45.0,
      "totalCost": 1895.0,
      "createdAt": "2026-02-15 10:00:00+00:00",
      "items": [
        {
          "productUid": "prod-cotton-white-l",
          "partnerSku": "SKU-COTTON-WHITE-L",
          "productName": "Cotton T-Shirt White L",
          "quantity": 500,
          "unitCost": 2.5,
          "vatPercentage": 21.0,
          "quantityReceived": 500
        }
      ],
      "invoices": [
        {
          "url": "https://storage.example.com/invoices/INV-2026-001.pdf",
          "originalFilename": "INV-2026-001.pdf",
          "referenceId": "INV-2026-001",
          "dueDate": "2026-04-15"
        }
      ]
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "perPage": 50,
    "totalResult": 1
  },
  "currency": "EUR"
}

Error response example

{
  "error": "Invalid credentials"
}

Request

Parameter	Type	Description
filterBy (optional)	object	Filter criteria for the order list.
filterBy.dateFrom (optional)	string	Start date in ISO 8601 format. Sample: 2026-01-01T00:00:00Z.
filterBy.dateTo (optional)	string	End date in ISO 8601 format. Defaults to now if dateFrom is set.
filterBy.status (optional)	array	Order statuses to filter by. Allowed: supplier, confirmed, in-transit, delivered, verified, invoiced. Default: all.
pagination (optional)	object	Pagination parameters.
pagination.pageNumber	integer	Page number (1-based). Sample: 1.
pagination.perPage	integer	Number of items per page. Default: 1000. Sample: 50.

Success response

Parameter	Type	Description
orders	array	Array of orders.
orders[].orderId	integer	Order ID. Sample: 100.
orders[].partnerPoNumber	string	Partner PO number (nullable). Sample: PO-2026-001.
orders[].supplierUid	string	Supplier UID. Sample: supplier-abc-123.
orders[].status	string	Order status. Sample: delivered.
orders[].currency	string	Currency in ISO 4217 format (partner currency). Sample: EUR.
orders[].shippingCost	float	Shipping cost in partner currency (nullable). Sample: 45.0.
orders[].totalCost	float	Total cost in partner currency. Sample: 1895.0.
orders[].createdAt	string	Created at in ISO 8601 format.
orders[].items	array	Order line items.
orders[].items[].productUid	string	Product UID.
orders[].items[].partnerSku	string	Partner SKU (nullable).
orders[].items[].productName	string	Product name (nullable).
orders[].items[].quantity	integer	Ordered quantity.
orders[].items[].unitCost	float	Unit cost in partner currency.
orders[].items[].vatPercentage	float	VAT percentage (nullable). Sample: 21.0.
orders[].items[].quantityReceived	integer	Quantity received.
orders[].invoices	array	Invoice files attached to the order.
orders[].invoices[].url	string	Invoice file URL.
orders[].invoices[].originalFilename	string	Original filename.
orders[].invoices[].referenceId	string	Reference ID (nullable).
orders[].invoices[].dueDate	string	Due date (nullable), format: YYYY-MM-DD.
pagination	object	Pagination info.
currency	string	Partner currency in ISO 4217 format. Sample: EUR.

HTTP Status Codes

Status	Description
200	Order list returned successfully
400	Validation error (invalid status, etc.)
403	Invalid or missing API key