curl -X GET "https://beta.api-iobot-desarrollo.com/catalogs/order/272992" \
-H "x-api-key: TU_APP_KEY"
Método: GET
URL: https://beta.api-iobot-desarrollo.com/catalogs/order/272992
Headers
x-api-key TU_APP_KEY
{
"data": {
"id": 272992,
"status": 1,
"type": "wa",
"shipment_method": "delivery",
"payment_method": "cash",
"total": 245.5,
"discount": 0,
"speedy_delivery_price": null,
"tax_id_label": "NIT",
"details": [
{
"id": 55021,
"quantity": 2,
"type": "item",
"articulo": {
"id": 1834,
"name": "Hamburguesa Clásica",
"price": "95.00"
},
"extras": [
{
"id": 9021,
"extra_id": 57,
"extra": {
"id": 57,
"name": "Queso extra",
"charge": "10.00"
}
}
]
}
],
"chat": {
"id": 252037,
"contacto": {
"id": 139458,
"nombre": "Juan Pérez",
"numero": "50494898989"
}
},
"zona": {
"id": 12,
"precio": "35.00",
"sucursal": {
"id": 4,
"nombre": "Sucursal Centro"
}
},
"empresa": {
"id": 92,
"nombre": "Mi Negocio"
},
"driver": null
}
}
{
"message": "Invalid API key"
}
{
"message": "Internal server error"
}
Ordenes
Obtener Orden por ID
Obtiene el detalle completo de una orden, incluyendo productos, totales y relaciones
GET
/
catalogs
/
order
/
{orderId}
curl -X GET "https://beta.api-iobot-desarrollo.com/catalogs/order/272992" \
-H "x-api-key: TU_APP_KEY"
Método: GET
URL: https://beta.api-iobot-desarrollo.com/catalogs/order/272992
Headers
x-api-key TU_APP_KEY
{
"data": {
"id": 272992,
"status": 1,
"type": "wa",
"shipment_method": "delivery",
"payment_method": "cash",
"total": 245.5,
"discount": 0,
"speedy_delivery_price": null,
"tax_id_label": "NIT",
"details": [
{
"id": 55021,
"quantity": 2,
"type": "item",
"articulo": {
"id": 1834,
"name": "Hamburguesa Clásica",
"price": "95.00"
},
"extras": [
{
"id": 9021,
"extra_id": 57,
"extra": {
"id": 57,
"name": "Queso extra",
"charge": "10.00"
}
}
]
}
],
"chat": {
"id": 252037,
"contacto": {
"id": 139458,
"nombre": "Juan Pérez",
"numero": "50494898989"
}
},
"zona": {
"id": 12,
"precio": "35.00",
"sucursal": {
"id": 4,
"nombre": "Sucursal Centro"
}
},
"empresa": {
"id": 92,
"nombre": "Mi Negocio"
},
"driver": null
}
}
{
"message": "Invalid API key"
}
{
"message": "Internal server error"
}
Retorna una orden completa: sus datos base más productos (
details), totales calculados, chat/contacto, zona, sucursal, empresa y conductor asignado (si aplica).
Autenticación
Requiere el encabezadox-api-key con el App Key del negocio. Consulta Autenticación.
Parámetros de ruta
number
required
ID de la orden a consultar.
Comportamiento
- Busca la orden por
orderId, incluyendo sus relaciones:chat(concontacto),zona(consucursal),empresa,user,sucursalydriver. - Calcula y agrega campos derivados a la orden antes de responder:
details: lista de productos de la orden, cada uno con suarticulo(producto del catálogo) y susextras(con elProductExtraasociado a cada uno).total: suma de productos y extras (usando precio personalizado desdeorder.extra_datacuando existe) más el costo de envío. Si la orden incluye un producto tipodelivery_coupon, el envío se cobra en0.discount: suma de descuentos por cupones (coupon), recompensas (reward/reward_points) y puntos reclamados (claimed_points).speedy_delivery_price: si el envío esdeliveryy la orden tiene un precio calculado por la integración Speedy, se usa ese valor en lugar del precio de la zona.tax_id_label: etiqueta del identificador fiscal según la configuración del negocio (por defecto"NIT").tracker(opcional): si la orden tienedriverasignado, intenta incluir su ubicación actual — vía la integración VAES si el negocio la tiene configurada, o la última ubicación conocida del conductor en el sistema.
- Si la orden tiene
external_user_id, busca el contacto y chat “in-app” correspondientes (pormeta_id) y los agrega comoin_app_chat.
El endpoint no valida explícitamente que la orden exista antes de procesarla: si
orderId no corresponde a ninguna orden, la búsqueda inicial devuelve null y el cálculo de campos derivados falla, resultando en una respuesta 500 en lugar de un 404.Respuesta
object
Orden completa con sus relaciones y campos calculados.
Show Propiedades principales
Show Propiedades principales
number
ID de la orden.
number
Estado de la orden.
string
Canal de origen (
wa, app, web, call, etc.).string
Método de entrega (
delivery, pickup) o null.string
Método de pago o
null.number
Total calculado de la orden (productos + extras + envío - descuentos).
number
Total de descuentos aplicados (cupones, recompensas, puntos).
number
Precio de envío calculado por Speedy, o
null si no aplica.string
Etiqueta del identificador fiscal a mostrar (por defecto
"NIT").object[]
Productos de la orden, cada uno con su
articulo y sus extras.object
Chat asociado a la orden, con su
contacto.object
Zona de entrega de la orden, con su
sucursal.object
Sucursal asignada a la orden.
object
Negocio dueño de la orden.
object
Conductor asignado a la orden, o
null.object
Ubicación actual del conductor asignado. Solo presente si la orden tiene
driver y se pudo obtener su ubicación.object
Chat in-app del usuario, si la orden tiene
external_user_id y existe un contacto/chat correspondiente.curl -X GET "https://beta.api-iobot-desarrollo.com/catalogs/order/272992" \
-H "x-api-key: TU_APP_KEY"
Método: GET
URL: https://beta.api-iobot-desarrollo.com/catalogs/order/272992
Headers
x-api-key TU_APP_KEY
{
"data": {
"id": 272992,
"status": 1,
"type": "wa",
"shipment_method": "delivery",
"payment_method": "cash",
"total": 245.5,
"discount": 0,
"speedy_delivery_price": null,
"tax_id_label": "NIT",
"details": [
{
"id": 55021,
"quantity": 2,
"type": "item",
"articulo": {
"id": 1834,
"name": "Hamburguesa Clásica",
"price": "95.00"
},
"extras": [
{
"id": 9021,
"extra_id": 57,
"extra": {
"id": 57,
"name": "Queso extra",
"charge": "10.00"
}
}
]
}
],
"chat": {
"id": 252037,
"contacto": {
"id": 139458,
"nombre": "Juan Pérez",
"numero": "50494898989"
}
},
"zona": {
"id": 12,
"precio": "35.00",
"sucursal": {
"id": 4,
"nombre": "Sucursal Centro"
}
},
"empresa": {
"id": 92,
"nombre": "Mi Negocio"
},
"driver": null
}
}
{
"message": "Invalid API key"
}
{
"message": "Internal server error"
}