PRODUCTION

This service will return the list of branch locations of the customer.

Resource information
AuthenticationRequired
HTTP MethodGET
ResponseJSON
Version1

Resource URL

https://mapaprop.app/api/action/express-v1/branches

Sample code

GET /api/action/express-v1/branches HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer ya29.1.AADtN_UxybTdjLw9jX6lg_branSjjgc3wTtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw

Response

A JSON document with the list of branch locations of the customer

ObjectFieldTypeRequiredDescription
ResponsebranchesArray of BranchyesThe list of Branch objects
BranchnamestringyesThe name of the branch
addressstringyesThe address of the branch
zone0DescriptionstringyesThe country where the branch is located
zone1DescriptionstringyesThe state / province the branch is located
zone2DescriptionstringyesThe county the branch is located / neighborhood in some cases
zone3DescriptionstringnoThe city the branch is located
zipstringyesThe zip code of the branch
phone1stringyesA phone number of the branch
phone2stringnoAn alternative phone number for the branch
phone3stringnoAn alternative phone number for the branch
emailstringyesThe email of the branch

Sample response

{
    "branches": [
        {
            "zone0Description": "Argentina",
            "zone1Description": "Capital Federal",
            "zone2Description": "Recoleta",
            "address": "Jonte 3939",
            "zip": "1425",
            "branchId": "1798",
            "main": true,
            "phone1": "+54 11 2344-9239",
            "name": "Sucursal Principal",
            "email": "info@customer.com"
        },
        {
            "zone0Description": "Argentina",
            "zone1Description": "Capital Federal",
            "zone2Description": "Palermo",
            "address": "Av Santa Fe 393",
            "zip": "1425",
            "branchId": "2703",
            "main": false,
            "phone1": "+54 11 2323 3343",
            "name": "Sucursal 2",
            "email": "info2@customer.com"
        },
        {
            "zone0Description": "Argentina",
            "zone1Description": "Buenos Aires",
            "zone2Description": "San Miguel",
            "zone2Description": "Bella Vista",
            "address": "Sourdeaux 393",
            "zip": "1445",
            "branchId": "2703",
            "main": false,
            "phone1": "+54 11 6666 3343",
            "name": "Sucursal 3",
            "email": "info3@customer.com"
        }
    ]
}