customer_groups_api = client.customer_groups
CustomerGroupsApi
- List Customer Groups
- Create Customer Group
- Delete Customer Group
- Retrieve Customer Group
- Update Customer Group
Retrieves the list of customer groups of a business.
def list_customer_groups(self,
cursor=None,
limit=None)
Parameter | Type | Tags | Description |
---|---|---|---|
cursor |
str |
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. |
This method returns a ApiResponse
instance. The body
property of this instance returns the response data which is of type List Customer Groups Response
.
result = customer_groups_api.list_customer_groups()
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
Creates a new customer group for a business.
The request must include the name
value of the group.
def create_customer_group(self,
body)
Parameter | Type | Tags | Description |
---|---|---|---|
body |
Create Customer Group Request |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
This method returns a ApiResponse
instance. The body
property of this instance returns the response data which is of type Create Customer Group Response
.
body = {
'group': {
'name': 'Loyal Customers'
}
}
result = customer_groups_api.create_customer_group(body)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
Deletes a customer group as identified by the group_id
value.
def delete_customer_group(self,
group_id)
Parameter | Type | Tags | Description |
---|---|---|---|
group_id |
str |
Template, Required | The ID of the customer group to delete. |
This method returns a ApiResponse
instance. The body
property of this instance returns the response data which is of type Delete Customer Group Response
.
group_id = 'group_id0'
result = customer_groups_api.delete_customer_group(group_id)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
Retrieves a specific customer group as identified by the group_id
value.
def retrieve_customer_group(self,
group_id)
Parameter | Type | Tags | Description |
---|---|---|---|
group_id |
str |
Template, Required | The ID of the customer group to retrieve. |
This method returns a ApiResponse
instance. The body
property of this instance returns the response data which is of type Retrieve Customer Group Response
.
group_id = 'group_id0'
result = customer_groups_api.retrieve_customer_group(group_id)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)
Updates a customer group as identified by the group_id
value.
def update_customer_group(self,
group_id,
body)
Parameter | Type | Tags | Description |
---|---|---|---|
group_id |
str |
Template, Required | The ID of the customer group to update. |
body |
Update Customer Group Request |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
This method returns a ApiResponse
instance. The body
property of this instance returns the response data which is of type Update Customer Group Response
.
group_id = 'group_id0'
body = {
'group': {
'name': 'Loyal Customers'
}
}
result = customer_groups_api.update_customer_group(
group_id,
body
)
if result.is_success():
print(result.body)
elif result.is_error():
print(result.errors)