Estados de pedido
Lista de estados de la tienda con los propios, el significado permanente de cada uno y las transiciones permitidas.
Estados de pedido
Objetos
OrderStatus
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
codestringobligatorioCódigo del estado: el valor de status de un pedido. Los códigos de los estados del sistema son iguales en todas las tiendas.
namemapa de stringobligatorioNombre del estado por idioma, como lo muestra la tienda.
status_groupstringobligatorioSignificado permanente del estado, los mismos valores que status_group de un pedido.
- Valores:
pos_openplacedpending_paymentpaidconfirmedpreparingreadyready_for_pickupout_for_deliverydelivery_faileddeliveredcompletedcancelledrefunded
allowed_nextarray de stringobligatorioCódigos de los estados a los que un pedido pasa desde este, según las reglas de transición de la tienda. El cambio también se verifica con el pedido: un retiro no pasa a un cadete, un envío necesita cadete, completar exige el pedido pagado.
is_systembooleanobligatorioUn estado del sistema: uno por cada significado de status_group, igual en todas las tiendas. Los estados que agrega la tienda tienen false.
positionintegerobligatorioPosición en la lista de estados de la tienda.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
deleted_atstring (date-time) o nullobligatorioCuándo la tienda retiró el estado: los pedidos ya no pasan a él, los pedidos pasados lo siguen mostrando. null en un estado en uso.
Endpoints
Listar los estados de pedido de la tienda y las transiciones entre ellos
get/order-statuses
Scope: orders:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.
- Largo máximo:
- 4096
updated_sincestring (date-time)Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.
- Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.
Campos · 2
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/order-statuses" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"code": "string",
"name": {
"key": "string"
},
"status_group": "pos_open",
"allowed_next": [
"string"
],
"is_system": true,
"position": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z",
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}