Customers

The Customer Object

A Rutter Customer represents a consumer that has interacted with or purchased products from the merchant's store. Every order is linked to Orders made by the customer.

For customers from an accounting platform, see Customers.

Properties

idstringnullable

The Rutter generated unique ID of the customer.

platform_idstringnullableOptional

The platform specific ID of the customer.

emailstringnullable

The email of the customer.

first_namestringnullable

The first name of the customer.

last_namestringnullable

The last name of the customer.

phonestringnullable

The phone number of the customer.

ordersarray

An array of Rutter IDs of Orders linked to the customer.

Show orders attributes

created_atstringnullable

The ISO 8601 timestamp that the customer was created.

updated_atstringnullable

The ISO 8601 timestamp that the customer was last updated.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/customers

GET

/customers/:id

List Customers

GEThttps://production.rutterapi.com/versioned/customers

Request Parameters

access_tokenstringquery

The access token of the connection.

cursorstringqueryOptional

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

emailstringqueryOptional

An email to filter on.

force_fetchenumqueryOptional

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

One oftrue or false.

limitintegerqueryOptional

The number of entities to return. Defaults to 50. Maximum is 500.

phonestringqueryOptional

A phone number formatted using only numerics to filter on.

updated_at_maxintegerqueryOptional

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

updated_at_minintegerqueryOptional

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

Response Body

connectionobject

Show connection attributes

customersarray

Show customers attributes

next_cursorstringnullable

Support by integration

Shopify
Woo Commerce
Amazon
Squarespace

Example Response Body

JSON

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "orgId": "00000000-0000-0000-0000-000000000000",
5    "platform": "SHOPIFY"
6  },
7  "customers": [
8    {
9      "id": "00000000-0000-0000-0000-000000000000",
10      "platform_id": "12345678",
11      "email": "eric@rutter.com",
12      "first_name": "Eric",
13      "last_name": "Yu",
14      "phone": "1234567890",
15      "orders": [
16        {
17          "id": "00000000-0000-0000-0000-000000000000"
18        }
19      ],
20      "created_at": "2023-01-02T02:34:56.000Z",
21      "updated_at": "2023-01-02T02:34:56.000Z",
22      "platform_data": {
23        "id": 123,
24        "data": "Varies by platform"
25      }
26    }
27  ],
28  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
29}

Fetch a Customer

GEThttps://production.rutterapi.com/versioned/customers/:id

Request Parameters

idstringpath

The Rutter generated unique ID of the object.

access_tokenstringquery

The access token of the connection.

force_fetchenumqueryOptional

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

One oftrue or false.

Response Body

connectionobject

Show connection attributes

customernullable

Show customer attributes

Support by integration

Shopify
Woo Commerce
Amazon
Squarespace

Example Response Body

JSON

1{
2  "connection": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "orgId": "00000000-0000-0000-0000-000000000000",
5    "platform": "SHOPIFY"
6  },
7  "customer": {
8    "id": "00000000-0000-0000-0000-000000000000",
9    "platform_id": "12345678",
10    "email": "eric@rutter.com",
11    "first_name": "Eric",
12    "last_name": "Yu",
13    "phone": "1234567890",
14    "orders": [
15      {
16        "id": "00000000-0000-0000-0000-000000000000"
17      }
18    ],
19    "created_at": "2023-01-02T02:34:56.000Z",
20    "updated_at": "2023-01-02T02:34:56.000Z",
21    "platform_data": {
22      "id": 123,
23      "data": "Varies by platform"
24    }
25  }
26}

Have questions?

Contact support for personalized guidance.

Contact support