Skip to content

Latest commit

 

History

History
218 lines (147 loc) · 6.01 KB

customer-groups.md

File metadata and controls

218 lines (147 loc) · 6.01 KB

Customer Groups

$customerGroupsApi = $client->getCustomerGroupsApi();

Class Name

CustomerGroupsApi

Methods

List Customer Groups

Retrieves the list of customer groups of a business.

function listCustomerGroups(?string $cursor = null, ?int $limit = null): ApiResponse

Parameters

Parameter Type Tags Description
cursor ?string Query, Optional A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for your original query.

For more information, see Pagination.
limit ?int Query, Optional The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the limit is less than 1 or greater than 50, Square returns a 400 VALUE_TOO_LOW or 400 VALUE_TOO_HIGH error. The default value is 50.

For more information, see Pagination.

Response Type

ListCustomerGroupsResponse

Example Usage

$apiResponse = $customerGroupsApi->listCustomerGroups();

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Create Customer Group

Creates a new customer group for a business.

The request must include the name value of the group.

function createCustomerGroup(CreateCustomerGroupRequest $body): ApiResponse

Parameters

Parameter Type Tags Description
body CreateCustomerGroupRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

CreateCustomerGroupResponse

Example Usage

$body_group_name = 'Loyal Customers';
$body_group = new Models\CustomerGroup(
    $body_group_name
);
$body = new Models\CreateCustomerGroupRequest(
    $body_group
);

$apiResponse = $customerGroupsApi->createCustomerGroup($body);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Delete Customer Group

Deletes a customer group as identified by the group_id value.

function deleteCustomerGroup(string $groupId): ApiResponse

Parameters

Parameter Type Tags Description
groupId string Template, Required The ID of the customer group to delete.

Response Type

DeleteCustomerGroupResponse

Example Usage

$groupId = 'group_id0';

$apiResponse = $customerGroupsApi->deleteCustomerGroup($groupId);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Retrieve Customer Group

Retrieves a specific customer group as identified by the group_id value.

function retrieveCustomerGroup(string $groupId): ApiResponse

Parameters

Parameter Type Tags Description
groupId string Template, Required The ID of the customer group to retrieve.

Response Type

RetrieveCustomerGroupResponse

Example Usage

$groupId = 'group_id0';

$apiResponse = $customerGroupsApi->retrieveCustomerGroup($groupId);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

Update Customer Group

Updates a customer group as identified by the group_id value.

function updateCustomerGroup(string $groupId, UpdateCustomerGroupRequest $body): ApiResponse

Parameters

Parameter Type Tags Description
groupId string Template, Required The ID of the customer group to update.
body UpdateCustomerGroupRequest Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

UpdateCustomerGroupResponse

Example Usage

$groupId = 'group_id0';
$body_group_name = 'Loyal Customers';
$body_group = new Models\CustomerGroup(
    $body_group_name
);
$body = new Models\UpdateCustomerGroupRequest(
    $body_group
);

$apiResponse = $customerGroupsApi->updateCustomerGroup($groupId, $body);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();