Applies to: Merchants API
Learn about the Merchants API and how to retrieve information about a Square seller account that's integrated with your application.
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
When a Square seller connects to your application with OAuth
Some API tasks, such as managing orderslocation_id
. Use the Locations API
Note
- The application developer account and seller account are separate Square accounts. Developers cannot perform any actions, such as taking payments, on behalf of sellers before the seller has granted the application developer permissions through OAuth. For more information, see OAuth API
OAuth API . - The
id
of a particular merchant is only accessible through the Merchants API. It's not visible on the Square Dashboard or Developer Console.
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
Retrieve merchant
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 RetrieveMerchantme
in place of the merchant ID.
Retrieve merchant
You can also retrieve the associated merchant using the ListMerchants
List merchants
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" } ] }