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
id
stringnullableThe Rutter generated unique ID of the customer.
platform_id
stringnullableoptionalThe platform specific ID of the customer.
email
stringnullableThe email of the customer.
first_name
stringnullableThe first name of the customer.
last_name
stringnullableThe last name of the customer.
phone
stringnullableThe phone number of the customer.
created_at
stringnullableThe ISO 8601 timestamp that the customer was created.
updated_at
stringnullableThe ISO 8601 timestamp that the customer was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"email": "eric@rutter.com",
"first_name": "Eric",
"last_name": "Yu",
"phone": "1234567890",
"orders": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Customers
GET /customersRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
email
stringoptionalqueryAn email to filter on.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
phone
stringoptionalqueryA phone number formatted using only numerics to filter on.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributescustomers
arraycustomers
attributesnext_cursor
stringnullable{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "SHOPIFY"
},
"customers": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"email": "eric@rutter.com",
"first_name": "Eric",
"last_name": "Yu",
"phone": "1234567890",
"orders": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Customer
GET /customers/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributescustomer
nullablecustomer
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "SHOPIFY"
},
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"email": "eric@rutter.com",
"first_name": "Eric",
"last_name": "Yu",
"phone": "1234567890",
"orders": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}