Ir al contenido

Get sales report

GET
/v2/reports/sales
curl --request GET \
--url 'https://api.orderfast.com.ar/v2/reports/sales?from=2026-07-01&to=2026-07-07' \
--header 'Authorization: Bearer <token>'
from
required
string
Example
2026-07-01
to
required
string
Example
2026-07-07

Successful response

Media typeapplication/json
object
data
required
object
total_orders
required
number
total_collected
required
number
average_ticket
required
number
payments
required
Array<object>
object
method
required
string
amount
required
number
Example
{
"data": {
"total_orders": 42,
"total_collected": 250000,
"average_ticket": 5952.38,
"payments": [
{
"method": "qr",
"amount": 150000
},
{
"method": "qr",
"amount": 150000
}
]
}
}

Unauthorized — missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleunauthorized

Invalid API key

{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key",
"request_id": "req_01J..."
}
}

Permission denied

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Examplepermission_denied

Missing permission

{
"error": {
"code": "permission_denied",
"message": "The API key does not have the required permission",
"request_id": "req_01J..."
}
}

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Examplevalidation_error

Invalid body or query

{
"error": {
"code": "validation_error",
"message": "One or more fields failed validation",
"request_id": "req_01J..."
}
}

Internal server error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleinternal_error

Unexpected failure

{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred",
"request_id": "req_01J..."
}
}