GET /branches
Devuelve las sucursales de la inmobiliaria dueña del token, cada una con su branchId.
Una inmobiliaria puede tener varias, y cada una es una entidad de Mapaprop con su propio id. Ese id lo asignamos nosotros cuando la sucursal se crea: no se deduce ni se construye desde tu sistema, se lee de acá.
No la identifiques por nombre. Dos sucursales pueden llamarse parecido, el nombre se edita desde la webapp sin avisarte, y "Centro" no es "Casa Central". Es el mismo motivo por el que las zonas se mapean por id y no por texto.
| Información del recurso | |
|---|---|
| Autenticación | Requerida (Token de API, Bearer) |
| Scope | property-api-read |
| HTTP Method | GET |
| Response | JSON |
| Version | 1 |
La llamada
GET https://property-api.mapaprop.com/property-v1/branches
Authorization: Bearer {access_token}
No lleva parámetros: el cliente sale del token.
La respuesta
{
"branches": [
{
"branchId": 8468,
"main": true,
"name": "Rodrigo Prop Test",
"address": "Av Barce Lona 123",
"zip": "123443",
"phone1": "011 666 7114",
"email": "rodrigo.asensio@mapaprop.com",
"zone0": 1,
"zone0Description": "Argentina",
"zone1": 2,
"zone1Description": "Buenos Aires",
"zone2": 137,
"zone2Description": "Adolfo Alsina",
"zone3": 1137,
"zone3Description": "Adelina Grande"
}
]
}
| Objeto | Campo | Tipo | Descripción |
|---|---|---|---|
| Response | branches | Array | Las sucursales de la cuenta. Nunca viene vacío: toda cuenta tiene al menos la principal |
| Branch | branchId | number | El id que tenés que usar. Es el que relaciona la sucursal con una propiedad |
main | boolean | true en la sucursal principal. Hay exactamente una | |
name | string | El nombre, para que un humano elija en tu pantalla. No es una clave | |
address | string | La dirección de la sucursal | |
zip | string | El código postal | |
phone1 · email | string | El contacto de la sucursal | |
zone0 … zone3 | number | Su ubicación, en las zonas de Mapaprop | |
zone0Description … zone3Description | string | Las mismas zonas en texto, para mostrar. Para mapear usá los ids |
Cuándo llamarla
Una vez por cliente, cuando lo das de alta — igual que el catálogo de zonas: guardás el
branchId contra la sucursal de tu sistema y queda mapeado.
Volvé a llamarla si la inmobiliaria te avisa que abrió una sucursal nueva.
ℹ️ Hoy el objeto de la propiedad no lleva la sucursal:
branchIdes un campo nuestro y se ignora si lo mandás. La sucursal que viaja hoy es la de la ficha del cliente, con sus datos de contacto para los portales. Este endpoint existe para que tengas el mapeo hecho.
Errores
| Código | Qué pasó | Qué hacer |
|---|---|---|
400 | El token no corresponde a una cuenta de Mapaprop (rule: customer_not_declared) | Las sucursales son de una cuenta. Si tus clientes no tienen cuenta de Mapaprop, escribinos: todavía no hay forma de resolver sus sucursales por este camino |
401 | Falta el token o no es válido | Revisá el header Authorization |
403 | El token no tiene el scope property-api-read | Es un permiso de tu token: escribinos |
503 | No pudimos leerlas en este momento | Es transitorio y del lado nuestro: reintentá |
Relacionado
- Dar de alta un cliente — el momento en que esto se lee
- Zonas — el otro catálogo que se mapea una vez
- El objeto de la propiedad — qué campos pone Mapaprop y cuáles se ignoran