FM / Api

/home/desid573/public_html/gcdriver/square/docs/Api/

/home/desid573/public_html/gcdriver/square/docs/Api

Name	Size	Mode	Actions
ApplePayApi.md	2338	0644	edit dl rm
CatalogApi.md	25498	0644	edit dl rm
CheckoutApi.md	2313	0644	edit dl rm
CustomersApi.md	16093	0644	edit dl rm
EmployeesApi.md	3823	0644	edit dl rm
InventoryApi.md	16122	0644	edit dl rm
LaborApi.md	25643	0644	edit dl rm
LocationsApi.md	1608	0644	edit dl rm
MobileAuthorizationApi.md	2632	0644	edit dl rm
OAuthApi.md	7820	0644	edit dl rm
OrdersApi.md	12538	0644	edit dl rm
PaymentsApi.md	13570	0644	edit dl rm
RefundsApi.md	7701	0644	edit dl rm
ReportingApi.md	8109	0644	edit dl rm
TransactionsApi.md	18657	0644	edit dl rm
V1EmployeesApi.md	36727	0644	edit dl rm
V1ItemsApi.md	76351	0644	edit dl rm
V1LocationsApi.md	2583	0644	edit dl rm
V1TransactionsApi.md	29937	0644	edit dl rm

Edit: /home/desid573/public_html/gcdriver/square/docs/Api/V1LocationsApi.md (2583B)

# SquareConnect\V1LocationsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**listLocations**](V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | ListLocations
[**retrieveBusiness**](V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | RetrieveBusiness

# **listLocations**
> \SquareConnect\Model\V1Merchant[] listLocations()

ListLocations

Provides details for a business's locations, including their IDs.

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\V1LocationsApi();

try {
    $result = $apiInstance->listLocations();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1LocationsApi->listLocations: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**\SquareConnect\Model\V1Merchant[]**](../Model/V1Merchant.md)

### Authorization

[oauth2](../../README.md#oauth2)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

# **retrieveBusiness**
> \SquareConnect\Model\V1Merchant retrieveBusiness()

RetrieveBusiness

Get a business's information.

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\V1LocationsApi();

try {
    $result = $apiInstance->retrieveBusiness();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling V1LocationsApi->retrieveBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**\SquareConnect\Model\V1Merchant**](../Model/V1Merchant.md)

### Authorization

[oauth2](../../README.md#oauth2)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

# SquareConnect\V1LocationsApi All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**listLocations**](V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | ListLocations [**retrieveBusiness**](V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | RetrieveBusiness # **listLocations** > \SquareConnect\Model\V1Merchant[] listLocations() ListLocations Provides details for a business's locations, including their IDs. ### Example ```php setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new SquareConnect\Api\V1LocationsApi(); try { $result = $apiInstance->listLocations(); print_r($result); } catch (Exception $e) { echo 'Exception when calling V1LocationsApi->listLocations: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\SquareConnect\Model\V1Merchant[]**](../Model/V1Merchant.md) ### Authorization [oauth2](../../README.md#oauth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **retrieveBusiness** > \SquareConnect\Model\V1Merchant retrieveBusiness() RetrieveBusiness Get a business's information. ### Example ```php setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new SquareConnect\Api\V1LocationsApi(); try { $result = $apiInstance->retrieveBusiness(); print_r($result); } catch (Exception $e) { echo 'Exception when calling V1LocationsApi->retrieveBusiness: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters This endpoint does not need any parameter. ### Return type [**\SquareConnect\Model\V1Merchant**](../Model/V1Merchant.md) ### Authorization [oauth2](../../README.md#oauth2) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)