Almacenes

/v1/warehouse

Administración de almacenes.

GET /v1/warehouse Listar registros ▶

Parám.	Descripción	Defecto
`page`	Número de página	1
`per_page`	Registros por página (máx. 1000)	20
`since`	Inicio del rango de creación (columna `entered`). Solo fecha = desde las 00:00:00	—
`until`	Fin del rango de creación. Solo fecha = hasta las 23:59:59	—
`q`	Búsqueda de texto en los campos indicados en cada recurso: `name` `description` `city`	—
`s` / `o`	Campo de ordenamiento · Sentido: `asc` o `desc`	según recurso
`f`	Filtros exactos en JSON	—

# página 2, 20 por página
curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://sandbox.minimarket.digital/v1/warehouse?page=2&per_page=20"

# creados en un rango de fechas, más recientes primero
curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://sandbox.minimarket.digital/v1/warehouse?since=2026-07-01&until=2026-07-31&s=entered&o=desc"

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "LIST",
    "data": {
        "a1b2c3d4-5e6f-7890-abcd-ef1234567890": {
            "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
            "name": "Almacén Central Lima",
            "description": "Almacén principal de distribución",
            "com_suc_id": "LIM",
            "city": "Lima",
            "province": "Lima",
            "street_typ": "AV.",
            "street": "Los Frutales",
            "number": "350",
            "zip": "15022",
            "latitude": -12.085,
            "longitude": -76.98,
            "responsible_email": "almacen@acme.pe"
        }
    },
    "meta": {
        "page": 1,
        "per_page": 20,
        "count": 1,
        "total": 134
    }
}

GET /v1/warehouse/{id} Obtener un registro ▶

curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://sandbox.minimarket.digital/v1/warehouse/ID"

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "GET",
    "data": {
        "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
        "name": "Almacén Central Lima",
        "description": "Almacén principal de distribución",
        "com_suc_id": "LIM",
        "city": "Lima",
        "province": "Lima",
        "street_typ": "AV.",
        "street": "Los Frutales",
        "number": "350",
        "zip": "15022",
        "latitude": -12.085,
        "longitude": -76.98,
        "responsible_email": "almacen@acme.pe"
    }
}

POST /v1/warehouse Crear un registro ▶

Solo se graban las columnas de la lista blanca de cada recurso (los campos grabables que aparecen en cada endpoint); cualquier otra clave del JSON se ignora en silencio. Cada valor es un texto, un número, un booleano (se guarda como 1 o 0) o null; un arreglo o un objeto responde 400 FIELD_INVALID: campo. Los componentes de la clave primaria que no se envíen toman el valor ---. El id puede enviarse (máximo 45 caracteres alfanuméricos, _, - y .); si se omite, la API genera un UUID.

Requeridos en POST name

Componentes de la clave — si no se envían toman --- com_suc_id cou_id pos_id

Campos grabables

Campo	Etiqueta	Tipo	Obl.
`name`	—	texto	•
`description`	—	texto
`responsible`	—	texto
`responsible_phone`	—	texto
`responsible_email`	—	texto
`geo_id`	—	texto
`state`	—	texto
`province`	—	texto
`city`	—	texto
`zone_typ`	—	texto
`zone`	—	texto
`street_typ`	—	texto
`street`	—	texto
`number_typ`	—	texto
`number`	—	texto
`interior_typ`	—	texto
`interior`	—	texto
`zip`	—	texto
`latitude`	—	número
`longitude`	—	número
`altitude`	—	número
`place_id`	—	texto
`external`	—	booleano
`external_responsible`	—	texto
`external_responsible_phone`	—	texto
`external_responsible_email`	—	texto

Con formato (se sanean al guardar) description

curl -X POST "https://sandbox.minimarket.digital/v1/warehouse" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
         "name": "Almacén Central Lima",
         "description": "Almacén principal de distribución",
         "com_suc_id": "LIM",
         "city": "Lima",
         "province": "Lima",
         "street_typ": "AV.",
         "street": "Los Frutales",
         "number": "350",
         "zip": "15022",
         "latitude": -12.085,
         "longitude": -76.98,
         "responsible_email": "almacen@acme.pe"
     }'

Respuesta

{
    "status": "success",
    "code": "201",
    "message": "ADD",
    "data": {
        "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
        "name": "Almacén Central Lima",
        "description": "Almacén principal de distribución",
        "com_suc_id": "LIM",
        "city": "Lima",
        "province": "Lima",
        "street_typ": "AV.",
        "street": "Los Frutales",
        "number": "350",
        "zip": "15022",
        "latitude": -12.085,
        "longitude": -76.98,
        "responsible_email": "almacen@acme.pe"
    }
}

PATCH /v1/warehouse/{id} Actualizar un registro ▶

Ambos hacen exactamente lo mismo: actualización parcial. Solo se modifican las columnas presentes en el JSON, el resto queda intacto — no hace falta reenviar el registro completo. Se usa PATCH por corrección semántica y PUT por compatibilidad con clientes que no lo soportan. La API graba modified y modified_by automáticamente.

Si el id no existe, ya se eliminó o queda fuera del alcance del permiso, responden 404 NO_DATA; si el JSON no trae ninguna columna válida, 400 NO_VALID_FIELDS.

Los componentes de la clave identifican el registro y no se cambian: enviarlos responde 400 FIELD_READONLY: campo, con todos los que llegaron. En los recursos por idioma, lng_id indica qué traducción se edita y no se escribe.

Campos grabables

Campo	Etiqueta	Tipo
`name`	—	texto
`description`	—	texto
`responsible`	—	texto
`responsible_phone`	—	texto
`responsible_email`	—	texto
`geo_id`	—	texto
`state`	—	texto
`province`	—	texto
`city`	—	texto
`zone_typ`	—	texto
`zone`	—	texto
`street_typ`	—	texto
`street`	—	texto
`number_typ`	—	texto
`number`	—	texto
`interior_typ`	—	texto
`interior`	—	texto
`zip`	—	texto
`latitude`	—	número
`longitude`	—	número
`altitude`	—	número
`place_id`	—	texto
`external`	—	booleano
`external_responsible`	—	texto
`external_responsible_phone`	—	texto
`external_responsible_email`	—	texto

No cambian por PUT/PATCH (400 FIELD_READONLY) com_suc_id cou_id pos_id

curl -X PATCH "https://sandbox.minimarket.digital/v1/warehouse/ID" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
         "description": "Almacén principal de distribución",
         "city": "Lima"
     }'

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "UPDATE",
    "data": {
        "id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
        "description": "Almacén principal de distribución",
        "city": "Lima"
    }
}

PUT /v1/warehouse/{id} Actualizar (compatibilidad) — idéntico a PATCH ▶

Campos grabables

Campo	Etiqueta	Tipo
`name`	—	texto
`description`	—	texto
`responsible`	—	texto
`responsible_phone`	—	texto
`responsible_email`	—	texto
`geo_id`	—	texto
`state`	—	texto
`province`	—	texto
`city`	—	texto
`zone_typ`	—	texto
`zone`	—	texto
`street_typ`	—	texto
`street`	—	texto
`number_typ`	—	texto
`number`	—	texto
`interior_typ`	—	texto
`interior`	—	texto
`zip`	—	texto
`latitude`	—	número
`longitude`	—	número
`altitude`	—	número
`place_id`	—	texto
`external`	—	booleano
`external_responsible`	—	texto
`external_responsible_phone`	—	texto
`external_responsible_email`	—	texto

curl -X PUT "https://sandbox.minimarket.digital/v1/warehouse/ID" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
         "description": "Almacén principal de distribución",
         "city": "Lima"
     }'

DELETE /v1/warehouse/{id} Eliminar un registro — Elimina el registro ▶

curl -X DELETE "https://sandbox.minimarket.digital/v1/warehouse/ID" \
     -H "X-SYNCS-API-TOKEN: TU_TOKEN"

Respuesta

{
    "status": "success",
    "code": "200",
    "message": "DELETED",
    "data": null
}

API REST v1 · 9 módulo(s) · autenticación por token · tenant sandbox.minimarket.digital