Movimientos de stock

Diario del stock físico del local: ventas, recepciones, bajas, inventarios, traslados y sus reversiones. Solo se agrega.

Cargando el índice de búsqueda…

Movimientos de stock

Objetos

StockMovement

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • variant_idintegerobligatorio

    ID de la variante del producto (/v1/variants).

  • location_idinteger o nullobligatorio

    Local del movimiento (/v1/locations); null en un movimiento del diario anterior a los locales, que solo ve una app sin límite de locales.

  • lot_idinteger o nullobligatorio

    ID del lote (/v1/lots); null en un producto sin lotes.

  • quantitystringobligatorio

    Cambio con signo del stock físico del local, como string decimal en la unidad de la variante: mayor que cero entró, menor que cero salió. La suma por par variante × local es su on_hand.

  • on_hand_afterstring o nullobligatorio

    Stock físico del local después del movimiento — el mismo que on_hand del nivel de stock, como string decimal; null en un movimiento del diario anterior a los locales.

  • reasonstringobligatorio

    Motivo del movimiento — la lista completa de stock. Conviene agrupar por category: un motivo nuevo llega en una de las columnas conocidas.

    Valores:
    order_reserveorder_releaserestockrefund_restockreturn_restockpos_tab_roundorder_editspoilageshort_pickmanual_adjustshrinkageinternal_usetype_change_writeoffprep_consumption_writeoffunit_mergemeasure_basis_changepiece_reweighpiece_shrinkageexternal_inboundexternal_reconcilereceipt_voidreceipt_correctionsupplier_returnsupplier_return_voidsupplier_return_correctionimport_revertlot_relabelstocktakebin_transferlocation_transfergroup_transfer_outgroup_transfer_ingroup_transfer_returnproduction_consumeproduction_outputproduction_voidrestock_voidspoilage_voidshrinkage_voidinternal_use_voidmanual_adjust_voidshort_pick_void
  • categorystringobligatorio

    Columna del libro de existencias: sale — venta y sus devoluciones; receipt — recepción y su reversión; external — importación y conciliación con un sistema externo; production_output y production_consume — producción y consumo; spoilage — merma; shrinkage — faltante; internal_use — consumo propio; stocktake — diferencia de inventario; correction — corrección del registro; supplier_return — devolución a proveedor; transfer — reubicación y traslado; group_transfer — traslado entre tiendas del grupo, al costo; technical — cambio de unidad de stock.

    Valores:
    salereceiptexternalproduction_outputproduction_consumespoilageshrinkageinternal_usestocktakecorrectionsupplier_returntransfergroup_transfertechnical
  • documentobject o nullobligatorio

    Documento primario del movimiento; null en una corrección manual, un picking o un movimiento técnico.

    Campos · 2
    • typestringobligatorio

      Tipo de documento: goods_receipt — recepción (/v1/goods-receipts); stocktake — inventario (/v1/stocktakes); stock_write_off — acta de baja; production_order — acta de producción; location_transfer — traslado entre locales (/v1/location-transfers); group_transfer — traslado entre tiendas del grupo, la copia de esta tienda; supplier_return — devolución a proveedor (/v1/supplier-returns); order — pedido (/v1/orders). El movimiento de un pedido dentro de un acta pertenece al acta.

      Valores:
      goods_receiptstocktakestock_write_offproduction_orderlocation_transfergroup_transfersupplier_returnorder
    • idintegerobligatorio

      ID del documento.

  • write_off_reason_idinteger o nullobligatorio

    ID del motivo de baja (/v1/write-off-reasons); null en los demás movimientos.

  • reverses_movement_idinteger o nullobligatorio

    ID del movimiento que este revierte; null en un movimiento común.

  • posting_idstring o nullobligatorio

    Asiento: un UUID común a todos los movimientos de una operación; null en un movimiento anterior a los asientos.

  • commentstring o nullobligatorio

    Comentario del personal en una corrección manual; null si no hay.

  • created_atstring (date-time)obligatorio

    Cuándo se creó el registro.

Endpoints

Diario de movimientos de stock: cada cambio del stock físico de un local

get/stock-movements

Scope: inventory:read

Parámetros

Query

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor 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})$
  • variant_idinteger

    Solo movimientos de esta variante.

    Mínimo:
    1
  • location_idinteger

    Solo movimientos de este local.

    Mínimo:
    1
  • lot_idinteger

    Solo movimientos de este lote.

    Mínimo:
    1
  • document_typestring

    Tipo de documento primario, junto con document_id: solo los movimientos cuyo documento primario es ese.

    Valores:
    goods_receiptstocktakestock_write_offproduction_orderlocation_transfergroup_transfersupplier_returnorder
  • document_idinteger

    ID del documento primario, junto con document_type.

    Mínimo:
    1

Respuestas

200Éxito

application/json

  • dataarray de StockMovementobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros 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
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En 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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl "https://api.saleya.app/v1/stock-movements" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "data": [
    {
      "id": 0,
      "variant_id": 0,
      "location_id": 0,
      "lot_id": 0,
      "quantity": "string",
      "on_hand_after": "string",
      "reason": "order_reserve",
      "category": "sale",
      "document": {
        "type": "goods_receipt",
        "id": 0
      },
      "write_off_reason_id": 0,
      "reverses_movement_id": 0,
      "posting_id": "string",
      "comment": "string",
      "created_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"
}

Movimiento de stock

get/stock-movements/{stock_movement}

Scope: inventory:read

Parámetros

Ruta

  • stock_movementintegerobligatorio

    ID del movimiento de stock.

Respuestas

200Éxito

application/json

Devuelve StockMovement

401Falta el token, es inválido, venció o fue revocado

Encabezados

  • WWW-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl "https://api.saleya.app/v1/stock-movements/{stock_movement}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "id": 0,
  "variant_id": 0,
  "location_id": 0,
  "lot_id": 0,
  "quantity": "string",
  "on_hand_after": "string",
  "reason": "order_reserve",
  "category": "sale",
  "document": {
    "type": "goods_receipt",
    "id": 0
  },
  "write_off_reason_id": 0,
  "reverses_movement_id": 0,
  "posting_id": "string",
  "comment": "string",
  "created_at": "2026-01-15T12:00:00Z"
}