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_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

emailstringqueryOptional

An email to filter on.

phonestringqueryOptional

A phone number formatted using only numerics to filter on.

updated_at_maxintegerqueryOptional

Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_minintegerqueryOptional

Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

customersarray

Show customers attributes

next_cursorstringnullable

connectionobject

Show connection attributes

Support by integration

Shopify
WooCommerce
Amazon
Squarespace

Example Response Body

JSON

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

Fetch a Customer

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

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

customernullable

Show customer attributes

connectionobject

Show connection attributes

Support by integration

Shopify
WooCommerce
Amazon
Squarespace

Example Response Body

JSON

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

Have questions?

Contact support for personalized guidance.

Contact support