Inventarios
Inventarios de un local: alcance, conteo ciego y estado desde el borrador hasta el registro. Las líneas tienen su propio feed.
Inventarios
Objetos
Stocktake
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
numberstring o nullobligatorioNúmero del inventario en la tienda.
location_idintegerobligatorioID del local inventariado (/v1/locations).
statusstringobligatoriodraft — el conteo está en curso; committing — los ajustes se escriben en segundo plano; committed — registrado, los ajustes son movimientos de stock con document.type = stocktake; voided — el borrador se anuló, no hay movimientos. Un registro fallido devuelve el inventario a draft.
- Valores:
draftcommittingcommittedvoided
blindbooleanobligatorioConteo ciego: mientras el inventario es borrador, el esperado y la diferencia de sus líneas son null.
coverageobjectobligatorioQué se cuenta.
Campos · 2
typestringobligatoriofull — todo el local; category — las categorías elegidas; selection — los artículos agregados durante el conteo.
- Valores:
fullcategoryselection
category_idsarray de integer o nullobligatorioID de las categorías (/v1/categories) en el alcance category; en los demás, null.
notestring o nullobligatorioNota del inventario; null si no la hay.
submitted_atstring (date-time) o nullobligatorioCuándo quien contó pasó el inventario a registro; null si no lo pasó.
committed_atstring (date-time) o nullobligatorioCuándo se aplicaron los ajustes; null si el inventario no está registrado.
voided_atstring (date-time) o nullobligatorioCuándo se anuló el borrador; null si no se anuló.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Inventarios: alcance, estado y fechas, modificados desde un momento dado
get/stocktakes
Scope: inventory: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})$
location_idintegerSolo inventarios de este local.
- Mínimo:
- 1
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/stocktakes" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"location_id": 0,
"status": "draft",
"blind": true,
"coverage": {
"type": "full",
"category_ids": [
0
]
},
"note": "string",
"submitted_at": "2026-01-15T12:00:00Z",
"committed_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_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"
}Inventario
get/stocktakes/{stocktake}
Scope: inventory:read
Parámetros
Ruta
stocktakeintegerobligatorioID del inventario.
Respuestas
200Éxito
application/json
Devuelve Stocktake
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
404El objeto no existe o no está disponible para la aplicación
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
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/stocktakes/{stocktake}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"location_id": 0,
"status": "draft",
"blind": true,
"coverage": {
"type": "full",
"category_ids": [
0
]
},
"note": "string",
"submitted_at": "2026-01-15T12:00:00Z",
"committed_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}