OnBox API v1

API REST para conectar tu sistema con OnBox — pedidos, stock y seguimiento de envíos.

Autenticación

Todas las llamadas usan una API key en el header. Pedila a tu contacto en OnBox; queda atada a tu cuenta y solo ve tus datos.

Authorization: Bearer obx_tuClaveSecreta

La clave se muestra una sola vez al crearla. Si se pierde, se revoca y se emite otra.

Base URL

https://api.onboxservicioslogisticos.com

Endpoints

GET /v1/ping

Verifica la clave. Devuelve tu seller y el grupo de cuentas al que da acceso.

GET /v1/orders

Lista tus pedidos. Paginado por cursor.

Parámetro	Descripción
from, to	Rango de fechas (YYYY-MM-DD)
status	Filtrar por estado (ej: pendiente, entregado)
limit	1–200 (default 50)
cursor	Para la página siguiente (viene en paging.nextCursor)

curl https://api.onboxservicioslogisticos.com/v1/orders?limit=20 \
  -H "Authorization: Bearer obx_tuClave"

GET /v1/orders/{id}

Un pedido con sus líneas de producto, dirección y estado.

GET /v1/stock

Stock disponible por SKU. Filtrable con ?sku=.

GET /v1/tracking/{id}

Estado vivo y línea de tiempo de un envío (por número de pedido o de seguimiento).

Respuestas

Siempre JSON. Éxito: { "ok": true, "data": ... }. Error: { "ok": false, "error": { "code", "message" } }.

HTTP	Significado
200	OK
401	Falta la clave o es inválida
403	La clave no tiene ese permiso
404	No encontrado
500	Error del servidor

Especificación

OpenAPI 3.0 en /openapi.json — importable en Postman/Insomnia o para generar un cliente.

OnBox Servicios Logísticos — soporte: onboxlogistica@gmail.com