v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Locations

RetrieveLocation

Retrieves details of a location. You can specify "main" as the location ID to retrieve details of the main location.

get/v2/locations/{location_id}

Path parameters

location_idstring required

The ID of the location to retrieve. If you specify the string "main", then the endpoint returns the main location.

Response

Success

Example response

{
  "location": {
    "address": {
      "address_line_1": "123 Main St",
      "administrative_district_level_1": "CA",
      "country": "US",
      "locality": "San Francisco",
      "postal_code": "94114"
    },
    "business_name": "Jet Fuel Coffee",
    "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": "Jet Fuel Coffee - Grant Park",
    "phone_number": "+1 650-354-7217",
    "status": "ACTIVE",
    "timezone": "America/Los_Angeles"
  }
}