Through this API you can get location for a brand in an agency.

Request

Name Method Description
/v1/getlocations GET This end-point will retrieve location list for a brand or an agency from the Online Review Manager system.

Request Parameters

Name Data Type Required/Optional Description
api_key string required This is the unique key given to you when the Agency was created.
brand_id integer required/optional This is the unique identifier of a Brand in our system. It was automatically created when you created the Brand. If you have created the identical client_location_id for another location under your agency then this parameter becomes "required".
client_brand_id string required/optional This is the unique identifier of a Brand in your system.
location_id string optional This is the unique identifier of a Location in our system. It was automatically created when you created the Location. If you leave this field blank you will get a list of all Locations
client_location_id string optional This is the unique identifier of a Location in your system. If you leave this field blank you will get a list of all locations

Sample Request

GET : https://api.online-review-manager.com/v1/getlocations

Response Data

This section outlines the standard response values from a location api

Sample Response

{
  "status": "success",
  "message": {
    "locations": [
      {
        "location_id": "SAU1483660123",
        "location_name": "Location Name ",
        "store_phone": "(012) 345-6789",
        "address": "1830 Park Ave.",
        "city": "El Cajon",
        "state": "CA",
        "zip": "92020",
        "first_name": "David",
        "last_name": "Paak",
        "title": "Owner",
        "email": "email@example.com",
        "phone": "(012) 345-6789",
        "location_url": "example.com",
        "client_location_id": "",
        "locationStatus": "enable",
        "response_signature": {
            "negative_rate": "",
            "positive_rate": ""
        },
        "escalate_email": [],
        "location_note": "",
        "googleQA_note": "",
        "store_id": "Unique Store ID"
      },
      {
        "location_id": "SAU1565415375",
        "location_name": "Location Name",
        "store_phone": "(012) 345-6789",
        "address": "2555 Loma Ave.",
        "city": "S. El Monte",
        "state": "CA",
        "zip": "91733",
        "first_name": "John",
        "last_name": "Doe",
        "title": "Manager",
        "email": "email@example.com",
        "phone": "(012) 345-6789",
        "location_url": "example.com",
        "client_location_id": "",
        "locationStatus": "enable",
        "response_signature": {
            "negative_rate": "",
            "positive_rate": ""
        },
        "escalate_email": [],
        "location_note": "",
        "googleQA_note": "",
        "store_id": "Unique Store ID"
      }
    ]
  }
}