Orders
Overview
Orders endpoints expose read-only order data. The public API includes order listing, single order retrieval, order statuses, and invoice files linked to an order.
Endpoint Summary
| Method | Route | Purpose |
|---|---|---|
GET | /v2.3/orders | List orders |
GET | /v2.3/orders/{orderId} | Get order by ID |
GET | /v2.3/orders/statuses | List order statuses |
GET | /v2.3/orders/{orderId}/invoices | List order invoices |
GET /v2.3/orders
Return paginated orders visible to the authenticated user.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer {{ACCESS_TOKEN}} |
Accept | Yes | application/json |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | number | No | Page number. |
per_page | number | No | Items per page. |
search_text | string | No | Search value. |
order | string | No | Sort field. |
order_direction | string | No | asc or desc. |
status_id | number | No | Filter by order status. |
provider_id | number | No | Filter by provider. |
entity_id | number | No | Filter by client/entity. |
Example Request
curl -X GET "{{BASE_URL}}/v2.3/orders?page=1&per_page=20" \
-H "Authorization: Bearer {{ACCESS_TOKEN}}" \
-H "Accept: application/json"
Success Response (200)
{
"success": true,
"result": {
"items": [
{
"id": 123,
"group_number": 456,
"identity_number": 789,
"user_id": 1001,
"author_user_id": 1001,
"entity_id": 2001,
"entity_type": "client",
"provider_id": 3001,
"company_name": "Example Client",
"amount": 1000,
"currency_code": "EUR",
"created_at": "2026-04-30 12:00:00",
"placed_on": "2026-04-30 12:00:00",
"max_due_date": "2026-05-30",
"status_id": 1,
"status_name": "New",
"status_updated_at": "2026-04-30 12:00:00",
"declined_reason": null,
"accepted_on": "",
"legal_entity": {
"id": 9901,
"name": "Example Legal Entity"
},
"managers": [],
"provider": {
"id": 3001,
"company_name": "Example Provider",
"entity_type_id": 2,
"slug": "example-provider"
},
"client": {
"id": 2001,
"company_name": "Example Client",
"slug": "example-client",
"entity_type": "client",
"entity_type_id": 1
},
"details": [],
"billing": null
}
],
"current_page": 1,
"per_page": 20,
"last_page": 1,
"total": 1
}
}
GET /v2.3/orders/{orderId}
Return one order by ID.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer {{ACCESS_TOKEN}} |
Accept | Yes | application/json |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | number | Yes | Order identifier. |
Example Request
curl -X GET "{{BASE_URL}}/v2.3/orders/{{ORDER_ID}}" \
-H "Authorization: Bearer {{ACCESS_TOKEN}}" \
-H "Accept: application/json"
Success Response (200)
{
"success": true,
"result": {
"id": 123,
"group_number": 456,
"identity_number": 789,
"user_id": 1001,
"author_user_id": 1001,
"entity_id": 2001,
"entity_type": "client",
"provider_id": 3001,
"company_name": "Example Client",
"amount": 1000,
"currency_code": "EUR",
"created_at": "2026-04-30 12:00:00",
"placed_on": "2026-04-30 12:00:00",
"max_due_date": "2026-05-30",
"status_id": 1,
"status_name": "New",
"status_updated_at": "2026-04-30 12:00:00",
"declined_reason": null,
"accepted_on": "",
"legal_entity": {
"id": 9901,
"name": "Example Legal Entity"
},
"managers": [
{
"id": 4001,
"first_name": "Jane",
"last_name": "Manager",
"name": "Jane Manager",
"primary_image_path": "https://cdn.example.com/users/4001.jpg"
}
],
"provider": {
"id": 3001,
"company_name": "Example Provider",
"entity_type_id": 2,
"slug": "example-provider"
},
"client": {
"id": 2001,
"company_name": "Example Client",
"slug": "example-client",
"entity_type": "client",
"entity_type_id": 1
},
"details": [
{
"id": 5001,
"order_id": 123,
"offer_id": 7001,
"provider_id": 3001,
"offer_name": "Immigration service",
"currency_code": "EUR",
"unit_price": "1000.00",
"total_price": "1000.00",
"quantity": 1,
"expats": [
{
"id": 6001,
"expat_id": 8001,
"assignment_id": 9001,
"dependent_id": null,
"created_at": "2026-04-30 12:00:00",
"arriving_on": "2026-05-15",
"delivery_date": "2026-05-30",
"case_id": 11001,
"case_status": "open"
}
],
"rfq_id": null,
"answer_status_id": 1,
"order_identity_number": 789,
"primary_image_path": "https://cdn.example.com/offers/7001.jpg"
}
],
"billing": {
"id": 12001,
"company_name": "Example Client",
"address": "1 Example Street",
"city": "Berlin",
"region": "Berlin",
"country_code": "DE",
"zip_code": "10115",
"tax_number": "DE123456789",
"bank_name": "Example Bank",
"swift_code": "EXAMPLEBIC",
"bank_account_number": "DE001234567890"
}
}
}
GET /v2.3/orders/statuses
Return available order statuses.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer {{ACCESS_TOKEN}} |
Accept | Yes | application/json |
Example Request
curl -X GET "{{BASE_URL}}/v2.3/orders/statuses" \
-H "Authorization: Bearer {{ACCESS_TOKEN}}" \
-H "Accept: application/json"
Success Response (200)
{
"success": true,
"result": [
{
"id": 1,
"text": "New"
},
{
"id": 2,
"text": "In Progress"
}
]
}
GET /v2.3/orders/{orderId}/invoices
Return invoice files linked to one order. Each file item includes order_invoice metadata.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer {{ACCESS_TOKEN}} |
Accept | Yes | application/json |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | number | Yes | Order identifier. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | number | No | Page number. |
per_page | number | No | Items per page. |
search_text | string | No | Search invoice number. |
status | string | No | Filter by invoice status. |
invoice_issue_start_date | date | No | Filter by invoice issue date lower bound. |
invoice_issue_end_date | date | No | Filter by invoice issue date upper bound. |
invoice_due_start_date | date | No | Filter by invoice due date lower bound. |
invoice_due_end_date | date | No | Filter by invoice due date upper bound. |
invoice_payment_start_date | date | No | Filter by payment date lower bound. |
invoice_payment_end_date | date | No | Filter by payment date upper bound. |
Example Request
curl -X GET "{{BASE_URL}}/v2.3/orders/{{ORDER_ID}}/invoices?page=1&per_page=20" \
-H "Authorization: Bearer {{ACCESS_TOKEN}}" \
-H "Accept: application/json"
Success Response (200)
{
"success": true,
"result": {
"items": [
{
"id": 123,
"file": "invoice.pdf",
"name": "Invoice 2026-001",
"status": "uploaded",
"user": {
"id": 1001,
"first_name": "Jane",
"last_name": "User",
},
"order_invoice": {
"id": 9001,
"order_id": 123,
"file_id": 123,
"invoice_number": "2026-001",
"invoice_amount": 1000,
"invoice_currency": "EUR",
"invoice_status": "New",
"invoice_due_date": "2026-05-30",
"invoice_issue_date": "2026-04-30",
"payment_date": null,
"transaction_id": null,
"payment_method": null,
"payment_id": null,
"user_id": 1001,
"provider_id": 3001,
"deleted_reason": null
}
}
],
"current_page": 1,
"per_page": 20,
"last_page": 1,
"total": 1
}
}