Esquemas de datos: Entregas de mercancía

Esquemas de datos: Entregas de mercancía. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Obtener — Entregas de mercancía — Respuesta

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

dataDeliveryDetailData Obligatorio: Ejemplo de respuesta · DeliveryDetailData.

Ejemplo: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Listar — Entregas de mercancía — Respuesta

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

dataLista <DeliveryData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_DeliveryData__.

Ejemplo: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Crear — Entregas de mercancía — Cuerpo de la solicitud

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

delivered_atCadena de textoObligatorio

Fecha y hora de entrega.

format: "date-time"

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

increases_stockBooleanoOpcional

Indica si la recepción de la entrega aumenta las existencias.

Valor predeterminado: true

location_idCadena de textoObligatorio

Identificador de la ubicación del almacén.

Restricciones

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

Ejemplo: "example"

notesCadena de textoOpcional

Notas adicionales.

maxLength: 2000

Valor predeterminado: ""

quantityNúmero enteroObligatorio

Número de unidades.

minimum: 1maximum: 2147483647

Ejemplo: 1

reasonCadena de textoOpcional

Motivo registrado para el cambio.

maxLength: 500

Valor predeterminado: ""

statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Restricciones

enum: ["planned", "received"]

Ejemplo: "planned"

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

Listar — Entregas de mercancía — Respuesta

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

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

deleted_atCadena de texto nullObligatorio

Momento de eliminación, si existe.

Cadena de texto:format: "date-time"

Ejemplo: null

delivered_atCadena de textoObligatorio

Fecha y hora de entrega.

format: "date-time"

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

idCadena de textoObligatorio

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

Ejemplo: "example"

increases_stockBooleanoObligatorio

Indica si la recepción de la entrega aumenta las existencias.

Ejemplo: true

location_idCadena de textoObligatorio

Identificador de la ubicación del almacén.

Ejemplo: "example"

quantityNúmero enteroObligatorio

Número de unidades.

Ejemplo: 1

received_atCadena de texto nullObligatorio

Fecha y hora de recepción de la entrega.

Cadena de texto:format: "date-time"

Ejemplo: null

record_statusCadena de textoObligatorio

Estado almacenado del registro.

Restricciones

enum: ["active", "deleted"]

Ejemplo: "active"

statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Restricciones

enum: ["planned", "received"]

Ejemplo: "planned"

stock_applied_atCadena de texto nullObligatorio

Fecha y hora en que se aplicó el cambio de existencias de la entrega.

Cadena de texto:format: "date-time"

Ejemplo: null

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"

updated_atCadena de texto nullObligatorio

Momento de la última actualización.

Cadena de texto: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 — Entregas de mercancía — Respuesta

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

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

deleted_atCadena de texto nullObligatorio

Momento de eliminación, si existe.

Cadena de texto:format: "date-time"

Ejemplo: null

delivered_atCadena de textoObligatorio

Fecha y hora de entrega.

format: "date-time"

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

idCadena de textoObligatorio

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

Ejemplo: "example"

increases_stockBooleanoObligatorio

Indica si la recepción de la entrega aumenta las existencias.

Ejemplo: true

location_idCadena de textoObligatorio

Identificador de la ubicación del almacén.

Ejemplo: "example"

notesCadena de texto nullObligatorio

Notas adicionales.

Ejemplo: "example"

quantityNúmero enteroObligatorio

Número de unidades.

Ejemplo: 1

received_atCadena de texto nullObligatorio

Fecha y hora de recepción de la entrega.

Cadena de texto:format: "date-time"

Ejemplo: null

record_statusCadena de textoObligatorio

Estado almacenado del registro.

Restricciones

enum: ["active", "deleted"]

Ejemplo: "active"

statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Restricciones

enum: ["planned", "received"]

Ejemplo: "planned"

stock_applied_atCadena de texto nullObligatorio

Fecha y hora en que se aplicó el cambio de existencias de la entrega.

Cadena de texto:format: "date-time"

Ejemplo: null

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"

updated_atCadena de texto nullObligatorio

Momento de la última actualización.

Cadena de texto: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