The Customer object

A customer represents a customer of your company.

Customer properties

int32

ID of the customer.

array
ISO 8601 datetime

When the customer was created.

object

Object containing custom data associated with the customer that will be shown in the helpdesk along with integration data. You can use this field to store any structured information (key-value data) about the customer that you want your agents to see in the helpdesk when they interact with the customer.

email

Primary email address of the customer.

string

ID of the customer in a foreign system (Stripe, Aircall, etc...). This field is not used by Gorgias, feel free to set it as you wish.

string

First name of the customer.

object

Data coming from integrations (Shopify, Recharge, HTTP, etc...) associated with the customer. Keys of the object are integration IDs, values are raw data collected from the integrations.

string

The customer's preferred language (format: ISO_639-1).

string

Last name of the customer.

string

Full name of the customer.

string

A note associated with the customer.

string

The customer's preferred timezone (format: IANA timezone name).

ISO 8601 datetime

When the customer was last updated.

Customer example object

{
  "id": 3924,
  "created_datetime": "2019-04-13T03:27:56.973873",
  "data": {
    "city": "San Francisco"
  },
  "email": "[email protected]",
  "external_id": "customer-84203241",
  "firstname": "John",
  "integrations": {
    "6": {
      "orders": [
        {
          "id": 772803526679,
          "total_tax": "0.02",
          "created_at": "2018-12-04T03:29:37-08:00",
          "line_items": [
            {
              "id": 1760305053719,
              "sku": "0987654321",
              "name": "Acidulous candy",
              "grams": 10,
              "price": "0.10",
              "title": "Acidulous candy",
              "taxable": true,
              "quantity": 1,
              "price_set": {
                "shop_money": {
                  "amount": "0.10",
                  "currency_code": "USD"
                },
                "presentment_money": {
                  "amount": "0.10",
                  "currency_code": "USD"
                }
              },
              "tax_lines": [
                {
                  "rate": 0.2,
                  "price": "0.02",
                  "title": "TVA",
                  "price_set": {
                    "shop_money": {
                      "amount": "0.02",
                      "currency_code": "USD"
                    },
                    "presentment_money": {
                      "amount": "0.02",
                      "currency_code": "USD"
                    }
                  }
                }
              ],
              "product_id": 8345093387,
              "variant_id": 28442938955,
              "total_discount": "0.00",
              "requires_shipping": true,
              "fulfillment_status": null,
              "total_discount_set": {
                "shop_money": {
                  "amount": "0.00",
                  "currency_code": "USD"
                },
                "presentment_money": {
                  "amount": "0.00",
                  "currency_code": "USD"
                }
              },
              "fulfillment_service": "manual",
              "fulfillable_quantity": 1
            }
          ],
          "contact_email": "mar\[email protected]",
          "billing_address": {
            "zip": "94103",
            "city": "SAN FRANCISCO",
            "name": "Marie Curie",
            "country": "United States",
            "address1": "52 Washburn Street",
            "address2": "",
            "province": "California",
            "last_name": "Curie",
            "first_name": "Marie",
            "country_code": "US",
            "province_code": "CA"
          }
        }
      ],
      "customer": {
        "id": 667928133655,
        "note": "",
        "tags": "",
        "email": "mar\[email protected]",
        "first_name": "Marie",
        "last_name": "Curie",
        "orders_count": 1,
        "default_address": {
          "id": 707106144279,
          "zip": "94103",
          "city": "SAN FRANCISCO",
          "name": "Marie Curie",
          "country": "United States",
          "default": true,
          "address1": "52 Washburn Street",
          "address2": "",
          "province": "California",
          "last_name": "Curie",
          "first_name": "Marie",
          "customer_id": 667928133655,
          "country_code": "US",
          "country_name": "United States",
          "province_code": "CA"
        }
      },
      "__integration_type__": "shopify"
    }
  },
  "language": "fr",
  "lastname": "Smith",
  "name": "John Smith",
  "note": "Our best customer.",
  "timezone": "UTC",
  "updated_datetime": "2019-09-25T06:18:22.839271"
}