The CustomerGroup object

Properties

idstringnullable

The Rutter generated unique ID of the customer group.

platform_idstringnullableoptional

The platform specific ID of the customer group.

namestringnullable

The name of the customer group.

created_atstring

The ISO 8601 timestamp that the customer group was created.

updated_atstring

The ISO 8601 timestamp that the customer group was last updated.

Example CustomerGroup Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "name": "Customers who have purchased more than once",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Customer Groups

GET /customer_groups
Supported for: Shopify

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    connectionobject
    Show connection attributes
    customer_groupsarray
    Show customer_groups attributes
    next_cursorstringnullable
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "customer_groups": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "name": "Customers who have purchased more than once",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Customer Group

GET /customer_groups/:id
Supported for: Shopify

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    customer_groupnullable
    Show customer_group attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "customer_group": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "name": "Customers who have purchased more than once",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}