Customers
Properties
id
stringnullableRequiredThe Rutter generated unique ID of the customer.
platform_id
stringnullableThe platform specific ID of the customer.
email
stringnullableRequiredThe email of the customer.
first_name
stringnullableRequiredThe first name of the customer.
last_name
stringnullableRequiredThe last name of the customer.
phone
stringnullableRequiredThe phone number of the customer.
created_at
stringnullableRequiredThe ISO 8601 timestamp that the customer was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the customer was last updated.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Customers
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
email
stringqueryAn email to filter on.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integerqueryThe limit on the number of entities returned.
phone
stringqueryA phone number formatted using only numerics to filter on.
updated_at_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributescustomers
arrayRequiredcustomers
attributesnext_cursor
stringnullableRequired- Shopify
- Woo Commerce
- Amazon
- Squarespace
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
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectRequiredconnection
attributescustomer
nullableRequiredcustomer
attributes- Shopify
- Woo Commerce
- Amazon
- Squarespace
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.