Commerce

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.

Show platform_data attributes
Example Customer Object
{
  "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 /versioned/customers
Supported for: AmazonBig CommerceChargebeeChargifyCloverMagentoMercado LibrePrestashopShopeeShopifySquareSquarespaceStripeWoo Commerce

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

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

    emailstringoptionalquery

    An email to filter on.

    force_fetchenumoptionalquery

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

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    phonestringoptionalquery

    A phone number formatted using only numerics to filter on.

    updated_at_maxintegeroptionalquery

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

    updated_at_minintegeroptionalquery

    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
Example Response Body
{
  "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 /versioned/customers/:id
Supported for: AmazonBig CommerceChargifyMagentoMercado LibrePrestashopShopifySquareSquarespaceWoo Commerce

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    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
Example Response Body
{
  "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"
    }
  }
}
Previous
Products