Ir al contenido

Get order by id

GET
/v1/orders/{id}
curl --request GET \
--url https://api.orderfast.com.ar/v1/orders/example \
--header 'Authorization: Bearer <token>'
id
required
string

Successful response

Media typeapplication/json
object
data
required
object
id
required
string
number
required
number
status
required
string
Allowed values: pending canceled ready closed
total
required
number
created_at
required
string
payment
required
object
id
required
string
status
required
string
Allowed values: pending completed canceled refunded error
external_id
string
channel
string
is_take_away
boolean
identifier
string
items
required
Array<object>
object
product_id
required
string
quantity
required
number
comment
string
subselections
Array<object>
object
item_id
required
string
quantity
required
number
payment_method_id
string
Examples
Examplesuccess

Successful response

{
"data": {
"id": "ord_123",
"number": 24445,
"status": "pending",
"total": 21100,
"created_at": "2026-07-06T11:08:26.085497-03:00",
"payment": {
"id": "pay_123",
"status": "pending"
},
"external_id": "partner-order-1001",
"is_take_away": true,
"identifier": "Mesa 12",
"payment_method_id": "pm_123",
"items": [
{
"product_id": "prod_9f03",
"quantity": 2,
"comment": "Sin cebolla",
"subselections": [
{
"item_id": "item_1",
"quantity": 1
}
]
}
]
}
}

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..."
}
}

Resource not found

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
Exampleresource_not_found

Not found

{
"error": {
"code": "resource_not_found",
"message": "Order not found",
"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..."
}
}