Orders
Customer orders.
List orders
- Method:
GET /obapi/v1/orders - Headers:
Authorization: Bearer {apikey}
| Parameter | Type | Required | Description |
|---|---|---|---|
page |
integer | no | Page number (default: 1) |
per_page |
integer | no | Items per page (default: 50, max: 200) |
date_start |
string | no | From date (YYYY-MM-DD) |
date_end |
string | no | To date (YYYY-MM-DD) |
status |
string | no | draft, validated, in_progress, delivered, cancelled |
sort |
string | no | date_asc, date_desc (default), ref_asc, ref_desc |
Get a single order
- Method:
GET /obapi/v1/orders/{id}
Status values
| Value | Description |
|---|---|
draft |
Draft order |
validated |
Validated |
in_progress |
Being processed / shipped |
delivered |
Fully delivered |
cancelled |
Cancelled |
Response (list)
{
"items": [
{
"id": "350",
"ref": "CO2405-0018",
"customer_ref": "PO-2024-042",
"date_order": "2024-05-15",
"status": "validated",
"is_billed": false,
"total_excl_tax": "5000.00",
"total_vat": "1000.00",
"total_incl_tax": "6000.00"
}
],
"pagination": {
"page": 1,
"per_page": 50,
"total_items": 3,
"total_pages": 1
}
}Response (single)
{
"order": {
"id": "350",
"ref": "CO2405-0018",
"customer_ref": "PO-2024-042",
"date_order": "2024-05-15",
"date_delivery": "2024-06-01",
"validated_at": "2024-05-15T10:00:00Z",
"created_at": "2024-05-14T16:00:00Z",
"updated_at": "2024-05-15T10:00:00Z",
"status": "validated",
"is_billed": false,
"payment_terms": "Net 30 days",
"payment_method": "Bank transfer",
"shipping_method": "Colissimo",
"total_excl_tax": "5000.00",
"total_vat": "1000.00",
"total_incl_tax": "6000.00",
"public_note": "",
"lines": [
{
"id": "720",
"position": 1,
"product_ref": "CONSULTING-01",
"product_label": "Consulting service",
"product_type": "service",
"description": "Technical consulting",
"quantity": "50.00",
"unit": "hour",
"unit_price_excl_tax": "100.00",
"discount_percent": "0.00",
"vat_rate": "20.000",
"total_excl_tax": "5000.00",
"total_vat": "1000.00",
"total_incl_tax": "6000.00"
}
]
}
}Download PDF
GET /obapi/v1/download/{id}?type=order