Contents

LocationResponse

The response object returned by the Get a Location endpoint.

Declaration

object LocationResponse

Properties

NameTypeDescription
resultLocation

The retrieved Location object. Omitted from the response entirely if no location was found (see the 404 case above), rather than being present as null. Read-only.

errorError

Error details if the request failed. Absent on success. See Error. Read-only.

Discussion

The LocationResponse object is the top-level envelope returned by Get a Location. On success, result contains a single Location object representing a physical brand location sourced from Apple Maps. On failure (for example, 404 Not Found), the response contains only the error object. The response omits the result key entirely rather than setting it to null.

Example

{
  "result": {
    "id": "7205759403792794",
    "name": "AwayFinder - Downtown SF",
    "brandId": "9151314442816847872",
    "status": "OPEN",
    "countryOrRegion": "US",
    "categories": [
      "travel",
      "tourism"
    ],
    "address": {
      "subThoroughfare": "123",
      "thoroughfare": "Market Street",
      "locality": "San Francisco",
      "adminArea": "California",
      "postalCode": "94105",
      "countryOrRegion": "US",
      "fullThoroughfare": "123 Market Street",
      "fullAddress": "123 Market Street, San Francisco, California 94105, US"
    },
    "displayPoint": {
      "latitude": "37.7749",
      "longitude": "-122.4194"
    },
    "creationTime": "2025-01-15T10:00:00.000",
    "modificationTime": "2026-03-20T14:45:00.000",
    "eligibility": {
      "status": "ELIGIBLE"
    }
  }
}

See Also