list-locations-response.md

List Locations Response

Defines the fields that are included in the response body of a request to the ListLocations endpoint.

One of errors or locations is present in a given response (never both).

Structure

List Locations Response

Fields

Name	Type	Tags	Description
errors	List of Error	Optional	Any errors that occurred during the request.
locations	List of Location	Optional	The business locations.

Example (as JSON)

{
  "locations": [
    {
      "address": {
        "address_line_1": "123 Main St",
        "administrative_district_level_1": "CA",
        "country": "US",
        "locality": "San Francisco",
        "postal_code": "94114"
      },
      "business_name": "Pumbaa's business name",
      "capabilities": [
        "CREDIT_CARD_PROCESSING"
      ],
      "country": "US",
      "created_at": "2016-09-19T17:33:12Z",
      "currency": "USD",
      "id": "18YC4JDH91E1H",
      "language_code": "en-US",
      "merchant_id": "3MYCJG5GVYQ8Q",
      "name": "your location name",
      "phone_number": "+1 650-354-7217",
      "status": "ACTIVE",
      "timezone": "America/Los_Angeles"
    }
  ]
}