Customer Groups
The CustomerGroup Object
Properties
idstringRequiredThe Rutter generated unique ID of the customer group.
platform_idstringnullableThe platform specific ID of the customer group.
namestringnullableRequiredThe name of the customer group.
created_atstringRequiredThe ISO 8601 timestamp that the customer group was created.
updated_atstringRequiredThe ISO 8601 timestamp that the customer group was last updated.
List Customer Groups
Request Parameters
access_tokenstringqueryRequiredThe access token of the connection.
cursorstringqueryThe cursor to use for pagination. Use the value of next_cursor provided in a previous response.
force_fetchenumqueryForce a response even if the underlying connection hasn't finished the initial sync.
limitintegerqueryThe number of entities to return. Defaults to 50. Maximum is 500.
updated_at_maxintegerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_minintegerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connectionobjectRequiredconnection attributescustomer_groupsarrayRequiredcustomer_groups attributesnext_cursorstringnullableRequired- Shopify
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "customer_groups": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "name": "Customers who have purchased more than once",
12 "created_at": "2023-01-02T02:34:56.000Z",
13 "updated_at": "2023-01-02T02:34:56.000Z"
14 }
15 ],
16 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
17}
Fetch a Customer Group
Request Parameters
idstringpathRequiredThe Rutter generated unique ID of the object.
access_tokenstringqueryRequiredThe access token of the connection.
force_fetchenumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connectionobjectRequiredconnection attributescustomer_groupnullableRequiredcustomer_group attributes- Shopify
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "customer_group": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "name": "Customers who have purchased more than once",
11 "created_at": "2023-01-02T02:34:56.000Z",
12 "updated_at": "2023-01-02T02:34:56.000Z"
13 }
14}
Have questions?
Contact support for personalized guidance.