Merchants API Overview

The Merchants API groups individual seller locations into larger organizations, allowing them to operate as a single entity. Each merchant represents one organization or business that sells with Square and all team members of that business can coordinate on behalf of the merchant.

When a Square seller connects to your application with OAuth or a personal access token, your application receives an access token that is scoped to that merchant group. Use the Merchants API to retrieve core information about the organization connecting to your application, such as the language preferences, business name, country, and account status.

Some API tasks, such as managing orders or taking payments, are associated with a specific seller location using a location_id. Use the Locations API to access information about these locations.

In the Square data model, the access token (OAuth or PAT) used to connect your application to a Square seller is associated with a single merchant. Use this merchant's ID in the request URL for the RetrieveMerchant endpoint to access information about the merchant.

curl https://connect.squareupsandbox.com/v2/merchants/DM7VKY8Q63GNP \
  -H 'Square-Version: 2023-05-17' \
  -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \
  -H 'Content-Type: application/json'

The following is an example response:

{
  "merchant": 
    {
      "id": "DM7VKY8Q63GNP",
      "business_name": "Apple a Day",
      "country": "US",
      "language_code": "en-US",
      "currency": "USD",
      "status": "ACTIVE",
      "main_location_id": "7WQ0KXC8ZSD90",
      "created_at": "2021-09-20T14:29:08.025Z"
    }
}

Alternatively, you can request the specific merchant associated with your account's access tokens by calling RetrieveMerchant using me in place of the merchant ID.

curl https://connect.squareupsandbox.com/v2/merchants/me \
  -H 'Square-Version: 2023-05-17' \
  -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \
  -H 'Content-Type: application/json'

You can also retrieve the associated merchant using the ListMerchants endpoint.

curl https://connect.squareupsandbox.com/v2/merchants \
  -H 'Square-Version: 2023-05-17' \
  -H 'Authorization: Bearer {{ACCESS-TOKEN}}' \
  -H 'Content-Type: application/json'

Note that the response is in the form of a list, but contains only one merchant: the one associated with your application based on the given access token.

{
  "merchant": [
    {
      "id": "DM7VKY8Q63GNP",
      "business_name": "Apple a Day",
      "country": "US",
      "language_code": "en-US",
      "currency": "USD",
      "status": "ACTIVE",
      "main_location_id": "7WQ0KXC8ZSD90",
      "created_at": "2021-09-20T14:29:08.025Z"
    }
  ]
}