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

idstringnullableRequired

The Rutter generated unique ID of the customer.

platform_idstringnullable

The platform specific ID of the customer.

emailstringnullableRequired

The email of the customer.

first_namestringnullableRequired

The first name of the customer.

last_namestringnullableRequired

The last name of the customer.

phonestringnullableRequired

The phone number of the customer.

ordersarrayRequired

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

Show orders attributes
created_atstringnullableRequired

The ISO 8601 timestamp that the customer was created.

updated_atstringnullableRequired

The ISO 8601 timestamp that the customer was last updated.

platform_dataobject

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.

    cursorstringquery

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

    emailstringquery

    An email to filter on.

    force_fetchenumquery

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

    One oftrue or false.
    limitintegerquery

    The limit on the number of entities returned.

    phonestringquery

    A phone number formatted using only numerics to filter on.

    updated_at_maxintegerquery

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

    updated_at_minintegerquery

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

Response Body

    connectionobjectRequired
    Show connection attributes
    customersarrayRequired
    Show customers attributes
    next_cursorstringnullableRequired
Support by integration
  • Amazon
    Amazon
  • Big Commerce
    Big Commerce
  • Chargebee
    Chargebee
  • Chargify
    Chargify
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

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumquery

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

    One oftrue or false.

Response Body

    connectionobjectRequired
    Show connection attributes
    customernullableRequired
    Show customer attributes
Support by integration
  • Amazon
    Amazon
  • Big Commerce
    Big Commerce
  • Chargify
    Chargify
  • Magento
    Magento
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