Reten Docs
Comercios

Direcciones de Comercio

Gestionar direcciones de un comercio.

POST /api/commerces/:cId/addresses

Agrega una nueva direccion a un comercio.

Auth: Requerida — permiso MANAGE_COMMERCES

Cuerpo de la Solicitud

CampoTipoRequeridoDescripcion
sourcestringSiOrigen de la direccion: RETEN o INTEGRATION
address_aliasstringNoNombre descriptivo de la direccion
is_primarybooleanNoEstablecer como direccion principal
country_codestringNoCodigo de pais (ej. CL, MX)
regionstringNoRegion o estado
communestringNoComuna o municipio
citystringNoCiudad
streetstringNoNombre de la calle
street_numberstringNoNumero de calle
unitstringNoDepartamento, oficina o unidad
formatted_addressstringNoDireccion formateada completa
latitudenumberNoCoordenada de latitud
longitudenumberNoCoordenada de longitud

Ejemplo

curl -X POST https://api.reten.ai/api/commerces/<cId>/addresses \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "RETEN",
    "address_alias": "Oficina Principal",
    "street": "Av. Providencia",
    "street_number": "1234",
    "commune": "Providencia",
    "city": "Santiago",
    "region": "Metropolitana",
    "country_code": "CL",
    "latitude": -33.4500,
    "longitude": -70.6700,
    "is_primary": true
  }'
const commerceId = "<cId>";
const response = await fetch(`https://api.reten.ai/api/commerces/${commerceId}/addresses`, {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    source: "RETEN",
    address_alias: "Oficina Principal",
    street: "Av. Providencia",
    street_number: "1234",
    commune: "Providencia",
    city: "Santiago",
    region: "Metropolitana",
    country_code: "CL",
    latitude: -33.4500,
    longitude: -70.6700,
    is_primary: true,
  }),
});
const address = await response.json();
import requests

commerce_id = "<cId>"
response = requests.post(
    f"https://api.reten.ai/api/commerces/{commerce_id}/addresses",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
    json={
        "source": "RETEN",
        "address_alias": "Oficina Principal",
        "street": "Av. Providencia",
        "street_number": "1234",
        "commune": "Providencia",
        "city": "Santiago",
        "region": "Metropolitana",
        "country_code": "CL",
        "latitude": -33.4500,
        "longitude": -70.6700,
        "is_primary": True,
    },
)
address = response.json()

Respuesta 201 Created

Devuelve el objeto de direccion creado.


PATCH /api/commerces/:cId/addresses/:aId

Actualiza una direccion existente.

Auth: Requerida — permiso MANAGE_COMMERCES

Cuerpo de la Solicitud

CampoTipoRequeridoDescripcion
address_aliasstringNoNombre descriptivo de la direccion
country_codestringNoCodigo de pais
regionstringNoRegion o estado
communestringNoComuna o municipio
citystringNoCiudad
streetstringNoNombre de la calle
street_numberstringNoNumero de calle
unitstringNoDepartamento, oficina o unidad
formatted_addressstringNoDireccion formateada completa
latitudenumberNoCoordenada de latitud
longitudenumberNoCoordenada de longitud
is_activebooleanNoSi la direccion esta activa

POST /api/commerces/:cId/addresses/:aId/set-primary

Establece una direccion como la direccion principal del comercio. Desestablece automaticamente la direccion principal anterior.

Respuesta 200 OK

Devuelve la direccion actualizada.

Notas

  • Solo puede haber una direccion principal por comercio (entre las direcciones activas)
  • Establecer una nueva direccion principal desestablece automaticamente la anterior