Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.

Catálogo e inventario

Almacenes y ubicaciones

Almacenes, sus ubicaciones y el mapa publicado.

Operaciones

Operación	Método y ruta	Alcance
Listar almacenes	GET `/warehouses`	`warehouses:read`
Consultar un almacén	GET `/warehouses/{id}`	`warehouses:read`
Mapa publicado del almacén	GET `/warehouses/{id}/layout`	`warehouses:read`
Listar ubicaciones	GET `/warehouse-positions`	`warehouses:read`
Consultar una ubicación	GET `/warehouse-positions/{id}`	`warehouses:read`

Rutas de almacenes y ubicaciones

Objeto almacén

id integer obligatorio
whs_code string obligatorio

Código del almacén; así lo nombran documentos, órdenes y olas.
name string obligatorio
site_code string | null
is_virtual boolean
timezone string | null
street string | null
block string | null
city string | null
state string | null
zip_code string | null
country string | null
positions_count integer
positions array de objetos

Solo en el detalle.
22 campos de positions
- id integer obligatorio
- warehouse_id integer obligatorio
- whs_code string | null
- bin_code string obligatorio
- description string | null
- type string | null
  
  Uso de la ubicación (storage, pick_face, reserve, receiving, staging_out, dock…).
- zone_id integer | null
- aisle string | null
- rack string | null
- level string | null
- slot string | null
- pick_sequence integer | null
- is_pickable boolean
- is_blocked boolean
- is_crossdock boolean
- disabled boolean
- capacity_units number | null
- capacity_weight_kg number | null
- capacity_volume_m3 number | null
- warehouse objeto | null
  3 campos de warehouse
  - id integer
  - whs_code string
  - name string
- created_at string (date-time) | null
- updated_at string (date-time) | null
created_at string (date-time) | null
updated_at string (date-time) | null

Objeto almacén

{
    "id": 1,
    "whs_code": "CEDIS-GDL",
    "name": "CEDIS Guadalajara",
    "site_code": "GDL",
    "is_virtual": false,
    "timezone": "America/Mexico_City",
    "street": "Av. Vallarta 1200",
    "block": null,
    "city": "Guadalajara",
    "state": "Jalisco",
    "zip_code": "44100",
    "country": "MX",
    "positions_count": 412,
    "created_at": "2026-09-14T15:00:00.000000Z",
    "updated_at": "2026-09-30T12:00:00.000000Z"
}

Objeto mapa del almacén

El mapa vigente; además de estos campos trae la geometría de pasillos, racks y ubicaciones.

warehouse_code string | null obligatorio
version integer obligatorio
published_at string (date-time) | null

Objeto mapa del almacén

{
    "warehouse_code": "CEDIS-MAPA",
    "version": 1,
    "published_at": "2026-10-06T10:20:11-06:00",
    "width_m": 30,
    "depth_m": 22,
    "grid_m": 0.5,
    "naming_mask": "{Z}-{A:2}-{B:2}-{L}",
    "slots_per_level": 1,
    "depot": {
        "x": 0,
        "y": 0
    },
    "zones": [
        {
            "code": "A",
            "type": "storage",
            "polygon": [
                [
                    0,
                    0
                ],
                [
                    25,
                    0
                ],
                [
                    25,
                    17
                ],
                [
                    0,
                    17
                ]
            ],
            "color": "#3B82F6",
            "temperature_class": null,
            "naming_mask": "{Z}-{A:2}-{B:2}-{L}"
        }
    ],
    "aisles": [
        {
            "number": 1,
            "x1": 4,
            "y1": 0,
            "x2": 4,
            "y2": 14,
            "width_m": 3,
            "one_way": false,
            "kind": "standard",
            "zone": null
        },
        {
            "number": 2,
            "x1": 8,
            "y1": 0,
            "x2": 8,
            "y2": 14,
            "width_m": 3,
            "one_way": false,
            "kind": "standard",
            "zone": null
        }
    ],
    "bays": [
        {
            "side": "L",
            "number": 1,
            "x": 2,
            "y": 1.5,
            "w": 2.7,
            "d": 1,
            "rotation": 90,
            "rack_type": "selective",
            "aisle": 1,
            "aisle_zone": null,
            "levels": [
                {
                    "level_no": 1,
                    "z_from_m": 0,
                    "height_m": 1.5,
                    "max_weight_kg": null,
                    "golden": false
                },
                {
                    "level_no": 2,
                    "z_from_m": 1.5,
                    "height_m": 1.5,
                    "max_weight_kg": null,
                    "golden": true
                }
            ]
        },
        {
            "side": "L",
            "number": 2,
            "x": 2,
            "y": 4.3,
            "w": 2.7,
            "d": 1,
            "rotation": 90,
            "rack_type": "selective",
            "aisle": 1,
            "aisle_zone": null,
            "levels": [
                {
                    "level_no": 1,
                    "z_from_m": 0,
                    "height_m": 1.5,
                    "max_weight_kg": null,
                    "golden": false
                },
                {
                    "level_no": 2,
                    "z_from_m": 1.5,
                    "height_m": 1.5,
                    "max_weight_kg": null,
                    "golden": true
                }
            ]
        }
    ],
    "points": []
}

Objeto ubicación

id integer obligatorio
warehouse_id integer obligatorio
whs_code string | null
bin_code string obligatorio
description string | null
type string | null

Uso de la ubicación (storage, pick_face, reserve, receiving, staging_out, dock…).
zone_id integer | null
aisle string | null
rack string | null
level string | null
slot string | null
pick_sequence integer | null
is_pickable boolean
is_blocked boolean
is_crossdock boolean
disabled boolean
capacity_units number | null
capacity_weight_kg number | null
capacity_volume_m3 number | null
warehouse objeto | null
3 campos de warehouse
- id integer
- whs_code string
- name string
created_at string (date-time) | null
updated_at string (date-time) | null

Objeto ubicación

{
    "id": 210,
    "warehouse_id": 1,
    "whs_code": "CEDIS-GDL",
    "bin_code": "A-01-01-1",
    "description": null,
    "type": "pick_face",
    "zone_id": 1,
    "aisle": "01",
    "rack": "01",
    "level": "1",
    "slot": null,
    "pick_sequence": 1,
    "is_pickable": true,
    "is_blocked": false,
    "is_crossdock": false,
    "disabled": false,
    "capacity_units": null,
    "capacity_weight_kg": null,
    "capacity_volume_m3": null,
    "warehouse": {
        "id": 1,
        "whs_code": "CEDIS-GDL",
        "name": "CEDIS Guadalajara"
    },
    "created_at": "2026-10-06T16:20:11.000000Z",
    "updated_at": "2026-10-06T16:20:11.000000Z"
}