Search Orders
GET
/orders
Search and list orders with filtering, sorting, and pagination.
Authorizations
BearerAuth
Type
HTTP (bearer)
Example
"Bearer ..."Parameters
Query Parameters
fk_id
Type
string
create_date_from
Type
string
Example
"2026-04-13T17:17:49"Format
"date-time"create_date_to
Type
string
Example
"2026-04-13T17:17:49"Format
"date-time"update_date_from
Type
string
Example
"2026-04-13T17:17:49"Format
"date-time"update_date_to
Type
string
Example
"2026-04-13T17:17:49"Format
"date-time"order_date_from
Type
string
Example
"2026-04-13T17:17:49"Format
"date-time"order_date_to
Type
string
Example
"2026-04-13T17:17:49"Format
"date-time"id_customer
ID of the Customer
Type
integer
Minimum
1limit
Type
integer
Minimum
1Maximum
100Default
25page
Type
integer
Minimum
1Default
1sort
Type
string
Valid values
"id""created_at""updated_at""date""id_customer""-id""-created_at""-updated_at""-date""-id_customer"Responses
Successful operation
application/json
JSON "data": [ { "id": 0, "date": "2026-04-13T17:17:50", "fk_id": "string", "status": { "id": 0, "name": "string", "fk_id": "string" }, "freight": { "id": 0, "name": "string", "value": 0, "fk_id": "string" }, "customer": { "id": 0, "name": "string", "fk_id": "string" }, "user": { "id": 0, "name": "string", "fk_id": "string" }, "observations": "string", "delivery_date": "2026-04-13T17:17:50", "opportunity": { "id": 0, "name": "string", "fk_id": "string" }, "quotation": { "id": 0, "name": "string" }, "payment_type": { "id": 0, "name": "string", "fk_id": "string" }, "payment_method": { "id": 0, "name": "string", "fk_id": "string" }, "category": { "id": 0, "name": "string", "fk_id": "string" }, "shipping_company": { "id": 0, "name": "string", "fk_id": "string" }, "address": { "id": 0, "street": "string", "number": 0, "complement": "string", "zip_code": 0, "neighborhood": "string", "city": "string", "state": "string", "latitude": 0, "longitude": 0, "address_type": "string", "name": "string", "fk_id": "string" }, "branch_company": { "id": 0, "name": "string", "fk_id": "string" }, "total_value": 0, "items": [ { "id": 0, "item": { "id": 0, "name": "string", "fk_id": "string", "type": "string" }, "quantity": 0, "price": 0, "description": "string", "created_at": "2026-04-13T17:17:50", "unit_liq": 0, "perc_desc": 0, "vlr_desc": 0, "total_liq": 0, "fk_id": "string", "base_icms_st": 0, "icms_st": 0, "vlr_icms_st": 0, "base_ipi": 0, "ipi": 0, "value_ipi": 0, "base_icms": 0, "icms": 0, "vlr_icms": 0, "recurrency_period": 0 } ] } ], "pagination": { "page": 1, "limit": 25, "total": 100, "totalPages": 4, "hasNext": true, "hasPrev": false, "links": { "self": "/orders?page=1&limit=25", "first": "/orders?page=1&limit=25", "last": "/orders?page=4&limit=25", "next": "/orders?page=2&limit=25", "prev": "string" } }, "meta": { "timestamp": "2026-04-13T17:17:49", "version": "1.0.0" }
{
}