sites.md

Sites

$sitesApi = $client->getSitesApi();

Class Name

SitesApi

List Sites

Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the created_at date.

Note: Square Online APIs are publicly available as part of an early access program. For more information, see Early access program for Square Online APIs.

function listSites(): ApiResponse

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type ListSitesResponse.

Example Usage

$apiResponse = $sitesApi->listSites();

if ($apiResponse->isSuccess()) {
    $listSitesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());