Pedidos
Get orders
get/api/orders
Query parameters
idinteger
The ID of the order to filter orders by.
Example:8
The ID of the order to filter orders by.
order_idinteger
The ID of the order to filter orders by.
Example:12345
The ID of the order to filter orders by.
pdv_idinteger
The ID of the PDV to filter orders by.
Example:981
The ID of the PDV to filter orders by.
payment_methodinteger
The ID of the payment method to filter orders by.
Example:1
The ID of the payment method to filter orders by.
statusinteger
The ID of the status to filter orders by.
Example:1
The ID of the status to filter orders by.
deliveryboolean
Specifies if only delivery orders should be returned to filter orders by.
Example:true
Specifies if only delivery orders should be returned to filter orders by.
userIdinteger
The ID of the user to filter orders by.
Example:1
The ID of the user to filter orders by.
datesstring[]
[ "2022-08-15T11:45:38", "2022-08-15T11:45:38" ]
Response
Example response
{
"data": [
{
"id": "int",
"user_name": "string",
"user_cpf": "string",
"user_cep": "string",
"created_at": "datetime",
"time_to_pay": "int",
"status_pedido": "int",
"pdv_id": "int",
"pdv_description": "string",
"delivery": "boolean",
"paid_at": "datetime",
"payment_method": "int",
"itens": {
"data": [
{
"code": "string",
"description": "string",
"value": "float",
"total_value": "float",
"delivery": "boolean",
"unit": "string",
"amount": "int"
}
]
}
}
],
"links": {
"first": "string",
"last": "string",
"prev": "nullable_string",
"next": "string"
},
"meta": {
"current_page": "int",
"from": "int",
"last_page": "int",
"links": [
{
"url": "nullable_string",
"label": "string",
"active": "boolean"
},
{
"url": "string",
"label": "string",
"active": "boolean"
}
],
"path": "string",
"per_page": "int",
"to": "int",
"total": "int"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.