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

dataCodeContentData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example-request"}

Campos adicionales: No

dataDigitalUploadData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example-request"}

Campos adicionales: No

dataImportData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example-request"}

Campos adicionales: No

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

dataPoolData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example-request"}

Campos adicionales: No

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

dataUnitsData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Campos adicionales: No

codeCadena de textoObligatorio

El código digital exacto. Conserva las mayúsculas y los espacios internos.

minLength: 1maxLength: 512

Ejemplo: "DEMO-ONE"

delivery_idCadena de texto | nullOpcional

ID de la entrega o asignación del pedido.

Cadena de texto:format: "uuid"

Ejemplo: null

kindCadena de textoOpcional

Variante de la estructura de datos definida por los valores admitidos.

const: "code"

Valor predeterminado: "code"Ejemplo: "code"

payload_idCadena de textoObligatorio

ID del contenido; no es una URL pública de descarga.

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000004"

unit_idCadena de textoObligatorio

ID de un código o archivo individual.

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000003"

Campos adicionales: No

consumer_idCadena de textoObligatorio

ID de la importación o unidad vinculada.

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000001"

consumer_kindCadena de textoObligatorio

Destino de la subida: digital_import / digital_unit.

Restricciones

enum

["digital_import", "digital_unit"]

Ejemplo: "digital_import"

filenameCadena de textoObligatorio

Archivo

minLength: 1maxLength: 255

Ejemplo: "codes.txt"

purposeCadena de textoObligatorio

digital_import: TXT/CSV; digital_unit: archivo vendido individualmente.

Restricciones

enum

["digital_unit", "digital_import"]

Ejemplo: "digital_import"

sha256Cadena de textoObligatorio

SHA-256 (hex, 64)

Restricciones

pattern

"^[0-9a-f]{64}$"

Ejemplo: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNúmero enteroObligatorio

Tamaño en bytes

minimum: 1maximum: 262144000

Ejemplo: 18

Campos adicionales: No

consumer_idCadena de textoObligatorio

ID de la importación o unidad vinculada.

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000001"

consumer_kindCadena de textoObligatorio

Destino de la subida: digital_import / digital_unit.

Restricciones

enum

["digital_import", "digital_unit"]

Ejemplo: "digital_import"

expires_atCadena de textoObligatorio

Fecha de caducidad de esta carga o importación.

format: "date-time"

Ejemplo: "2026-11-03T13:00:00Z"

filenameCadena de textoObligatorio

Archivo

Ejemplo: "codes.txt"

idCadena de textoObligatorio

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

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000002"

product_idCadena de textoObligatorio

Identificador del producto.

Ejemplo: "example"

purposeCadena de textoObligatorio

digital_import: TXT/CSV; digital_unit: archivo vendido individualmente.

Restricciones

enum

["digital_unit", "digital_import"]

Ejemplo: "digital_import"

received_bytesNúmero enteroObligatorio

Subiendo… · Tamaño en bytes

Ejemplo: 18

sha256Cadena de textoObligatorio

SHA-256 (hex, 64)

Ejemplo: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesNúmero enteroObligatorio

Tamaño en bytes

Ejemplo: 18

statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Ejemplo: "ready"

Campos adicionales: No

delivered_atCadena de textoObligatorio

Fecha y hora de entrega.

format: "date-time"

Ejemplo: "2026-11-03T12:00:00Z"

expected_delivery_versionNúmero enteroObligatorio

Versión de la entrega; 0 para una entrega nueva.

minimum: 0maximum: 0

Ejemplo: 0

expected_sales_limit_versionNúmero entero | nullOpcional

Versión del límite de venta; obligatoria con publish_for_sale=true.

Número entero:minimum: 0maximum: 9223372036854775807

Ejemplo: 0

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 2

location_idCadena de textoObligatorio

Identificador de la ubicación del almacén.

Restricciones

pattern

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

Ejemplo: "location-digital"

publish_for_saleBooleanoOpcional

true aumenta también el límite finito de venta; false lo deja igual.

Valor predeterminado: falseEjemplo: true

statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Restricciones

enum

["planned", "received"]

Ejemplo: "received"

validation_digestCadena de textoObligatorio

Suma de verificación de validación; envíala sin cambios al confirmar.

Restricciones

pattern

"^[0-9a-f]{64}$"

Ejemplo: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idCadena de textoObligatorio

Identificador del almacén.

Restricciones

pattern

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

Ejemplo: "warehouse-main"

Campos adicionales: No

countNúmero enteroObligatorio

Número exacto de unidades del lote.

minimum: 1maximum: 1000

Ejemplo: 2

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum

["code", "file"]

Ejemplo: "code"

Campos adicionales: No

delivery_idCadena de texto | nullObligatorio

ID de la entrega o asignación del pedido.

Ejemplo: null

delivery_statusCadena de texto | nullObligatorio

Estado de entrega: planned / received; null antes de confirmar.

Ejemplo: null

delivery_versionNúmero entero | nullObligatorio

Versión actual de la entrega de almacén.

Ejemplo: null

expected_countNúmero enteroObligatorio

Cantidad esperada; se acepta solo el lote completo.

Ejemplo: 2

expires_atCadena de textoObligatorio

Fecha de caducidad de esta carga o importación.

format: "date-time"

Ejemplo: "2026-11-03T13:00:00Z"

idCadena de textoObligatorio

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

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000001"

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum

["code", "file"]

Ejemplo: "code"

product_idCadena de textoObligatorio

Identificador del producto.

Ejemplo: "example"

statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Ejemplo: "validated"

validated_countNúmero enteroObligatorio

Unidades aceptadas en la última validación correcta.

Ejemplo: 2

validation_digestCadena de texto | nullObligatorio

Suma de verificación de validación; envíala sin cambios al confirmar.

Ejemplo: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionNúmero enteroObligatorio

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

Ejemplo: 2

Campos adicionales: No

expected_delivery_versionNúmero enteroObligatorio

Versión de la entrega; 0 para una entrega nueva.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

expected_sales_limit_versionNúmero entero | nullOpcional

Versión del límite de venta; obligatoria con publish_for_sale=true.

Número entero:minimum: 0maximum: 9223372036854775807

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 3

publish_for_saleBooleanoOpcional

true aumenta también el límite finito de venta; false lo deja igual.

Valor predeterminado: false

Campos adicionales: No

code_columnCadena de texto | nullOpcional

Columna CSV de los códigos; utiliza code.

Cadena de texto:const: "code"

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

formatCadena de texto | nullOpcional

Lista de códigos: txt / csv; usa upload_ids para archivos.

Restricciones · Cadena de texto 1

enum

["txt", "csv"]

Ejemplo: "txt"

source_upload_idCadena de texto | nullOpcional

Subida privada TXT/CSV lista, perteneciente a esta importación.

Cadena de texto:format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000002"

upload_idsLista <Cadena de texto> | nullOpcional

1–100 subidas privadas de archivos listas de esta importación.

Lista:minItems: 1maxItems: 100

Lista / Lista:format: "uuid"

Campos adicionales: No

expected_delivery_versionNúmero enteroObligatorio

Versión de la entrega; 0 para una entrega nueva.

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

expected_order_versionNúmero enteroObligatorio

Versión del orden de asignación, no del pedido del cliente.

minimum: 0maximum: 9223372036854775807

Ejemplo: 1

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 3

reasonCadena de textoObligatorio

Motivo registrado para el cambio.

minLength: 1maxLength: 500

Ejemplo: "Withdraw a revoked license"

Campos adicionales: No

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

email_modeCadena de textoOpcional

disabled: sin correo; order_link: enlace al pedido; code_text: puede incluir códigos.

Restricciones

enum

["disabled", "order_link", "code_text"]

Valor predeterminado: "disabled"Ejemplo: "order_link"

enabledBooleanoObligatorio

Indica si esta opción está habilitada.

Ejemplo: true

expected_versionNúmero enteroObligatorio

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

minimum: 0maximum: 9223372036854775807

Ejemplo: 0

retention_daysNúmero entero | nullOpcional

null: sin caducidad; 1–3650 días desde el primer acceso. Los códigos no se borran automáticamente.

Número entero:minimum: 1maximum: 3650

Ejemplo: null

Campos adicionales: No

availableNúmero enteroObligatorio

Número de unidades libres, no reservadas ni entregadas.

Ejemplo: 1

heldNúmero enteroObligatorio

Unidades reservadas para pedidos, aún no entregadas.

Ejemplo: 0

issuedNúmero enteroObligatorio

Unidades ya entregadas a compras pagadas.

Ejemplo: 1

plannedNúmero enteroObligatorio

Unidades de entregas confirmadas todavía no recibidas.

Ejemplo: 0

retiredNúmero enteroObligatorio

Unidades retiradas conservadas en el historial.

Ejemplo: 0

stagedNúmero enteroObligatorio

Unidades de importaciones incompletas, aún fuera del inventario.

Ejemplo: 0

Campos adicionales: No

configuredBooleanoObligatorio

Indica si se guardó la configuración del inventario.

Ejemplo: true

countsPoolCounts Obligatorio

Cantidad de unidades por estado de inventario.

Ejemplo: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeCadena de textoObligatorio

disabled: sin correo; order_link: enlace al pedido; code_text: puede incluir códigos.

Restricciones

enum

["disabled", "order_link", "code_text"]

Ejemplo: "order_link"

enabledBooleanoObligatorio

Indica si esta opción está habilitada.

Ejemplo: true

order_versionNúmero enteroObligatorio

Versión del orden de asignación del inventario.

Ejemplo: 2

product_idCadena de textoObligatorio

Identificador del producto.

Ejemplo: "example"

retention_daysNúmero entero | nullObligatorio

null: sin caducidad; 1–3650 días desde el primer acceso. Los códigos no se borran automáticamente.

Ejemplo: null

versionNúmero enteroObligatorio

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

Ejemplo: 1

Campos adicionales: No

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

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

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

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

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

content_stateCadena de textoObligatorio

Estado del contenido: present / deleting / deleted.

Ejemplo: "present"

delivery_idCadena de texto | nullObligatorio

ID de la entrega o asignación del pedido.

Ejemplo: "delivery-example"

filenameCadena de texto | nullObligatorio

Archivo

Ejemplo: null

idCadena de textoObligatorio

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

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000003"

issued_atCadena de texto | nullObligatorio

Primera entrega; null antes de ella.

Cadena de texto:format: "date-time"

Ejemplo: null

kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones

enum

["file", "code"]

Ejemplo: "code"

location_idCadena de texto | nullObligatorio

Identificador de la ubicación del almacén.

Ejemplo: "location-digital"

mime_typeCadena de texto | nullObligatorio

Tipo de contenido multimedia.

Ejemplo: null

payload_idCadena de textoObligatorio

ID del contenido; no es una URL pública de descarga.

format: "uuid"

Ejemplo: "00000000-0000-4000-8000-000000000004"

product_idCadena de textoObligatorio

Identificador del producto.

Ejemplo: "example"

size_bytesNúmero entero | nullObligatorio

Tamaño en bytes

Ejemplo: null

sort_orderNúmero enteroObligatorio

Posición en la colección ordenada.

Ejemplo: 1

stateCadena de textoObligatorio

Estado

Ejemplo: "available"

versionNúmero enteroObligatorio

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

Ejemplo: 1

warehouse_idCadena de texto | nullObligatorio

Identificador del almacén.

Ejemplo: "warehouse-main"

Campos adicionales: No

expected_versionNúmero enteroObligatorio

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

minimum: 1

Ejemplo: 1

reasonCadena de textoObligatorio

Motivo registrado para el cambio.

minLength: 1maxLength: 500

Ejemplo: "Withdraw a revoked license"

Campos adicionales: No

expected_order_versionNúmero enteroObligatorio

Versión del orden de asignación, no del pedido del cliente.

minimum: 1

Ejemplo: 1

unit_idsLista <Cadena de texto> Obligatorio

Todas las unidades de la página sin filtros en el orden deseado.

minItems: 2maxItems: 100

Lista:format: "uuid"

Ejemplo: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursorCadena de texto | nullOpcional

Cursor de la página sin filtros; null para la primera.

Cadena de texto:maxLength: 1024

Campos adicionales: No

codeCadena de texto | nullOpcional

El código digital exacto. Conserva las mayúsculas y los espacios internos.

Cadena de texto:minLength: 1maxLength: 512

Ejemplo: "SYNTHETIC-REPLACEMENT"

expected_versionNúmero enteroObligatorio

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

minimum: 1

Ejemplo: 1

reasonCadena de textoObligatorio

Motivo registrado para el cambio.

minLength: 1maxLength: 500

Ejemplo: "Replace an invalid activation code"

upload_idCadena de texto | nullOpcional

Identificador del recurso; consérvalo tal como se devuelve. · upload_id

Cadena de texto:format: "uuid"

Campos adicionales: No

order_versionNúmero enteroObligatorio

Versión del orden de asignación del inventario.

Ejemplo: 2

totalNúmero enteroObligatorio

Importe total.

Ejemplo: 1

unitsLista <UnitData > Obligatorio

Metadatos de unidades; el contenido requiere otra petición autorizada.

Ejemplo: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Campos adicionales: Sí