Skip to content

Get Order by id

GET
/orders/{id}

Returns a single order by its id.

Authorizations

BearerAuth
Type
HTTP (bearer)
Example"Bearer ..."

Parameters

Path Parameters

id*

ID of the resource

Type
integer
Required

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
  
  
  
}
  
  
]
  
},
  
"meta": {
  
  
"timestamp": "2026-04-13T17:17:49",
  
  
"version": "1.0.0"
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI