Esquemas de datos: Almacenes y ubicaciones

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

Esquemas de datos

Listar · Ubicaciones — Almacenes y ubicaciones — Respuesta

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

dataLista <LocationData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_LocationData__.

Ejemplo: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"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

Listar — Almacenes y ubicaciones — Respuesta

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

dataLista <WarehouseData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_WarehouseData__.

Ejemplo: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
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 — Almacenes y ubicaciones — Respuesta

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

dataWarehouseData Obligatorio: Ejemplo de respuesta · WarehouseData.

Ejemplo: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio: Metadatos de la respuesta.

Ejemplo: {"request_id":"example"}

Campos adicionales: No

Listar · Ubicaciones — Almacenes y ubicaciones — Respuesta

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

codeCadena de textoObligatorio

Código estable legible por programas.

Ejemplo: "example"

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

idCadena de textoObligatorio

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

Ejemplo: "example"

is_leafBooleanoObligatorio

Indica si la categoría no tiene subcategorías.

Ejemplo: true

location_typeCadena de textoObligatorio

Tipo de ubicación del almacén.

Restricciones

enum: ["zone", "rack", "shelf", "bin"]

Ejemplo: "zone"

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"

parent_idCadena de texto nullObligatorio

Identificador de la categoría superior.

Ejemplo: null

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

Ubicaciones del almacén

LocationQuantity · Esquema · Esquemas de datos: Almacenes y ubicaciones

location_idCadena de textoObligatorio

Identificador de la ubicación del almacén.

Restricciones

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

Ejemplo: "example"

on_handNúmero enteroObligatorio

Cantidad física en existencias.

minimum: 0maximum: 2147483647

Ejemplo: 1

Campos adicionales: No

Obtener — Almacenes y ubicaciones — Respuesta

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

activeBooleanoObligatorio: Indica si el recurso está activo.

Ejemplo: true
address_lineCadena de texto nullObligatorio: Línea de dirección.

Ejemplo: "example"
cityCadena de texto nullObligatorio: Ciudad o localidad.

Ejemplo: "example"
codeCadena de textoObligatorio: Código estable legible por programas.

Ejemplo: "example"
country_codeCadena de textoObligatorio: Código del país.

Ejemplo: "PL"
created_atCadena de textoObligatorio: Momento de creación.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
customer_visibleBooleanoObligatorio: Indica si el estado es visible para el cliente.

Ejemplo: false
idCadena de textoObligatorio: Identificador del recurso; consérvalo tal como se devuelve. (WarehouseData).

Ejemplo: "example"
nameCadena de textoObligatorio: Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
postal_codeCadena de texto nullObligatorio: Código postal.

Ejemplo: "example"
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

Campos adicionales: No