Obtener pedidos
API operation: Open the endpoint in Scalar
Usa GET /orders para obtener pedidos. La operación pública actual es Order.findAll.orders.
Se requiere autenticación. Sin mode=dashboard, los resultados se limitan a los pedidos de cliente del solicitante. El modo dashboard aplica acceso por rol para usuarios operativos; administradores y agentes tienen acceso más amplio.
Para recibir avisos de pedidos nuevos, usa la referencia de Sockets; los nombres de evento y sus datos pueden depender de la integración configurada.
const response = await ordering.orders().get();
Esta sintaxis de SDK es histórica. Confirma el paquete y la versión antes de usarla.
Referencia de OpenAPI
Operación: GET /orders
Parámetros de consulta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
params | string | No | Lista de campos separados por comas. La lista se cruza con $fillable del modelo; si está vacía o no es válida, se devuelven todos los campos. |
orderBy | string | No | Campo de ordenamiento, con - como prefijo para indicar orden descendente. Se pueden encadenar varios campos separados por comas. |
where | string | No | Filtro en JSON sobre los campos que el modelo declara como filtrables. Los campos válidos de cada recurso se exponen en la extensión de schema x-ordering-whereable. |
page | integer | No | Número de página, empezando en 1. Solo se aplica a las listas que devuelven un bloque de paginación. |
page_size | integer | No | Cantidad de elementos por página. |
business_id | integer | No | — |
customer_phone | string | No | — |
limit | integer | No | — |
mode | string | No | — |
scope | string | No | — |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Envelope de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error para el código declarado por la operación. Consulta result para ver los detalles disponibles. Envelope de error: el proyecto no existe o no tiene una suscripción activa. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |