Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/public_html/admin1/vendor/square/square/doc/apis/ |
Upload File : |
# Customer Segments
```php
$customerSegmentsApi = $client->getCustomerSegmentsApi();
```
## Class Name
`CustomerSegmentsApi`
## Methods
* [List Customer Segments](/doc/apis/customer-segments.md#list-customer-segments)
* [Retrieve Customer Segment](/doc/apis/customer-segments.md#retrieve-customer-segment)
# List Customer Segments
Retrieves the list of customer segments of a business.
```php
function listCustomerSegments(?string $cursor = null, ?int $limit = null): ApiResponse
```
## Parameters
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `cursor` | `?string` | Query, Optional | A pagination cursor returned by previous calls to `ListCustomerSegments`.<br>This cursor is used to retrieve the next set of query results.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/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.<br>The limit is ignored if it is less than 1 or greater than 50. The default value is 50.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). |
## Response Type
[`ListCustomerSegmentsResponse`](/doc/models/list-customer-segments-response.md)
## Example Usage
```php
$cursor = 'cursor6';
$limit = 172;
$apiResponse = $customerSegmentsApi->listCustomerSegments($cursor, $limit);
if ($apiResponse->isSuccess()) {
$listCustomerSegmentsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
```
# Retrieve Customer Segment
Retrieves a specific customer segment as identified by the `segment_id` value.
```php
function retrieveCustomerSegment(string $segmentId): ApiResponse
```
## Parameters
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `segmentId` | `string` | Template, Required | The Square-issued ID of the customer segment. |
## Response Type
[`RetrieveCustomerSegmentResponse`](/doc/models/retrieve-customer-segment-response.md)
## Example Usage
```php
$segmentId = 'segment_id4';
$apiResponse = $customerSegmentsApi->retrieveCustomerSegment($segmentId);
if ($apiResponse->isSuccess()) {
$retrieveCustomerSegmentResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
```