Locations

The Locations endpoint provides restaurant location data. Location contains data about a restaurant's location, and most API endpoints require a locationId path parameter that corresponds to the id field from Location objects.

Overview

Location objects contain comprehensive information about merchant locations including business details, timezone settings, currency and language preferences, and brand associations. This data is essential for integrations to properly scope operations and handle locale-specific requirements.

Key Information

Location IDs are used throughout the Marketplace API to identify specific merchant locations
Timezone data is provided in IANA format for accurate time-based operations
Country, currency, and language codes follow international standards (ISO 3166-1, ISO 4217, ISO 639-1)
Brand references link locations to their POS brand (e.g., SkyTab)

API Endpoints

Retrieve All Locations

Returns details for all business locations accessible to the client.

Method: GET

Endpoint: /marketplace/v2/locations

Authentication: Required - Bearer token or API credentials

Returns a paginated list of all locations the authenticated client can access.

Request

GET

/marketplace/v2/locations

curl -X GET https://conecto-api.shift4payments.com/marketplace/v2/locations \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

{
  "results": [
    {
      "id": 12345,
      "name": "Downtown Restaurant",
      "timeZone": "America/New_York",
      "merchantId": "MERCH-12345",
      "countryCode": "US",
      "currency": "USD",
      "language": "en",
      "brandRef": "skytab"
    }
  ],
  "meta": {}
}

Delete Location Installations

Removes installations for a specific location and requesting app.

Method: DELETE

Endpoint: /marketplace/v2/locations/{locationId}

Authentication: Required - Bearer token or API credentials

Path Parameters:

locationId (integer, required) - Location numeric identifier

This endpoint uninstalls your application from the specified location. Use this when merchants want to remove your integration.

Request

DELETE

/marketplace/v2/locations/{locationId}

curl -X DELETE https://conecto-api.shift4payments.com/marketplace/v2/locations/12345 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

204 No Content

Location Data Fields

The Location object contains the following fields:

Field	Type	Description
`id`	integer	Location numeric identifier (required for most API operations)
`name`	string	Human-readable location name
`timeZone`	string	IANA timezone identifier (e.g., "America/New_York")
`merchantId`	string	Unique merchant identifier
`countryCode`	string	ISO 3166-1 alpha-2 country code (e.g., "US", "CA")
`currency`	string	ISO 4217 currency code (e.g., "USD", "CAD")
`language`	string	ISO 639-1 language code (e.g., "en", "es")
`brandRef`	string	Reference to the location's POS brand

Important Notes

All fields are required in API responses
The locationId is used as a path parameter in most Marketplace API endpoints
Timezone information is critical for scheduling and time-based operations
Use the brandRef to retrieve additional brand information via the Brands API
Currency and language codes help with localization and display formatting