V1LocationsApi.md

V1LocationsApi

All URIs are relative to https://connect.squareup.com

Method	HTTP request	Description
listLocations	GET /v1/me/locations	ListLocations
retrieveBusiness	GET /v1/me	RetrieveBusiness

listLocations

Note: This endpoint is deprecated.

List<V1Merchant> listLocations()

ListLocations

Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. --- - Deprecation date: 2019-11-20 - Retirement date: 2020-11-18 - Migration guide ---

Example

// Import classes:
//import com.squareup.connect.ApiClient;
//import com.squareup.connect.ApiException;
//import com.squareup.connect.Configuration;
//import com.squareup.connect.auth.*;
//import com.squareup.connect.api.V1LocationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

V1LocationsApi apiInstance = new V1LocationsApi();
try {
    List<V1Merchant> result = apiInstance.listLocations();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling V1LocationsApi#listLocations");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<V1Merchant>

Authorization

oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json

retrieveBusiness

Note: This endpoint is deprecated.

V1Merchant retrieveBusiness()

RetrieveBusiness

Get the general information for a business. --- - Deprecation date: 2019-11-20 - Retirement date: 2020-11-18 - Migration guide ---

Example

// Import classes:
//import com.squareup.connect.ApiClient;
//import com.squareup.connect.ApiException;
//import com.squareup.connect.Configuration;
//import com.squareup.connect.auth.*;
//import com.squareup.connect.api.V1LocationsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

V1LocationsApi apiInstance = new V1LocationsApi();
try {
    V1Merchant result = apiInstance.retrieveBusiness();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling V1LocationsApi#retrieveBusiness");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

V1Merchant

Authorization

oauth2

HTTP request headers

• Content-Type: application/json
• Accept: application/json