Esquemas de datos: Inventario

Esquemas de datos: Inventario. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Cantidades asignadas a ubicaciones del almacén

AllocationData · Esquema · Esquemas de datos: Inventario

location_codeCadena de textoObligatorio: Código de la ubicación del almacén.

Ejemplo: "example"
location_idCadena de textoObligatorio: Identificador de la ubicación del almacén.

Ejemplo: "example"
location_nameCadena de textoObligatorio: Nombre de la ubicación del almacén.

Ejemplo: "example"
on_handNúmero enteroObligatorio: Cantidad física en existencias.

Ejemplo: 10

Campos adicionales: No

Listar · Existencias — Inventario — Respuesta

ApiResponse_list_StockData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <StockData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_StockData__.

Ejemplo: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio: Metadatos de la respuesta.

Ejemplo: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campos adicionales: No

Obtener · Existencias — Inventario — Respuesta

ApiResponse_StockDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataStockDetailData Obligatorio: Ejemplo de respuesta · StockDetailData.

Ejemplo: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio: Metadatos de la respuesta.

Ejemplo: {"request_id":"example"}

Campos adicionales: No

Actualizar · Reserva manual — Inventario — Cuerpo de la solicitud

ManualReservationUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

expected_versionNúmero enteroObligatorio: Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1
manual_reservedNúmero enteroObligatorio: Cantidad reservada manualmente.

minimum: 0maximum: 2147483647

Ejemplo: 1
reasonCadena de textoOpcional: Motivo registrado para el cambio.

maxLength: 500

Valor predeterminado: ""

Campos adicionales: No

Actualizar · Límite de ventas — Inventario — Cuerpo de la solicitud

SalesLimitUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

expected_versionNúmero enteroObligatorio: Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1
reasonCadena de textoOpcional: Motivo registrado para el cambio.

maxLength: 500

Valor predeterminado: ""
sellable_limitNúmero enteroObligatorio: Límite de venta: -1 significa ilimitado y 0 deshabilita la disponibilidad para la venta.

minimum: -1maximum: 2147483647

Ejemplo: 1

Campos adicionales: No

Crear · Ajuste de existencias — Inventario — Cuerpo de la solicitud

StockAdjustmentCreate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 0maximum: 9223372036854775807

Ejemplo: 0

locationsLista <LocationQuantity > Obligatorio

Ubicaciones del almacén.

minItems: 1maxItems: 100

Ejemplo: [{"location_id":"example","on_hand":1}]

reasonCadena de textoObligatorio

Motivo registrado para el cambio.

minLength: 1maxLength: 500

Ejemplo: "Example"

target_idCadena de textoObligatorio

Identificador del producto o variante afectado por la operación.

Restricciones

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Ejemplo: "example"

target_typeCadena de textoObligatorio

Indica si la operación afecta a un producto o a una variante.

Restricciones

enum: ["product", "variant"]

Ejemplo: "product"

warehouse_idCadena de textoObligatorio

Identificador del almacén.

Restricciones

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Ejemplo: "example"

Campos adicionales: No

Actualizar · Existencias — Inventario — Cuerpo de la solicitud

StockAdjustmentUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

expected_versionNúmero enteroObligatorio: Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1
locationsLista <LocationQuantity > Obligatorio: Ubicaciones del almacén.

minItems: 1maxItems: 100

Ejemplo: [{"location_id":"example","on_hand":1}]
reasonCadena de textoObligatorio: Motivo registrado para el cambio.

minLength: 1maxLength: 500

Ejemplo: "Example"

Campos adicionales: No

Listar · Existencias — Inventario — Respuesta

StockData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

activeBooleanoObligatorio

Indica si el recurso está activo.

Ejemplo: true

availableNúmero entero nullObligatorio

Cantidad disponible para la venta; null representa una cantidad ilimitada.

Ejemplo: 5

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (StockData).

Ejemplo: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNúmero enteroObligatorio

Cantidad reservada manualmente.

Ejemplo: 2

on_handNúmero enteroObligatorio

Cantidad física en existencias.

Ejemplo: 10

reservedNúmero enteroObligatorio

Cantidad reservada por pedidos.

Ejemplo: 3

sellable_limitNúmero enteroObligatorio

Límite de venta: -1 significa ilimitado y 0 deshabilita la disponibilidad para la venta.

Ejemplo: 10

target_idCadena de textoObligatorio

Identificador del producto o variante afectado por la operación.

Ejemplo: "example"

target_typeCadena de textoObligatorio

Indica si la operación afecta a un producto o a una variante.

Restricciones

enum: ["product", "variant"]

Ejemplo: "product"

total_reservedNúmero enteroObligatorio

Cantidad total reservada.

Ejemplo: 5

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

warehouse_idCadena de textoObligatorio

Identificador del almacén.

Ejemplo: "example"

Campos adicionales: No

Obtener · Existencias — Inventario — Respuesta

StockDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

activeBooleanoObligatorio

Indica si el recurso está activo.

Ejemplo: true

allocationsLista <AllocationData > Obligatorio

Cantidades asignadas a ubicaciones del almacén.

Ejemplo: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableNúmero entero nullObligatorio

Cantidad disponible para la venta; null representa una cantidad ilimitada.

Ejemplo: 5

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (StockDetailData).

Ejemplo: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedNúmero enteroObligatorio

Cantidad reservada manualmente.

Ejemplo: 2

on_handNúmero enteroObligatorio

Cantidad física en existencias.

Ejemplo: 10

reservedNúmero enteroObligatorio

Cantidad reservada por pedidos.

Ejemplo: 3

sellable_limitNúmero enteroObligatorio

Límite de venta: -1 significa ilimitado y 0 deshabilita la disponibilidad para la venta.

Ejemplo: 10

target_idCadena de textoObligatorio

Identificador del producto o variante afectado por la operación.

Ejemplo: "example"

target_typeCadena de textoObligatorio

Indica si la operación afecta a un producto o a una variante.

Restricciones

enum: ["product", "variant"]

Ejemplo: "product"

total_reservedNúmero enteroObligatorio

Cantidad total reservada.

Ejemplo: 5

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

warehouse_idCadena de textoObligatorio

Identificador del almacén.

Ejemplo: "example"

Campos adicionales: No