Attribuly API Docs
  • Introduction
  • Authentication
  • Endpoint
    • Google Looker Studio
  • API Reference
    • Event summary
    • Order: first and last touchpoint
    • Order: total conversion journey
    • The number of visitors who visited the landing page and then completed the event.
  • Common data structures
    • Customer
    • Order
    • Product
    • Event
      • Page viewed
      • Cart viewed
      • Product viewed
      • Collection viewed
      • Search submitted
      • Product added to cart
      • Product removed to cart
      • Lead form
      • Checkout started
      • Checkout address info submitted
      • Checkout contact info submitted
      • Checkout shipping info submitted
      • Payment info submitted
      • Checkout completed
Powered by GitBook
On this page

Was this helpful?

  1. Common data structures

Customer

{
  "id": "Required, unique identifier, numeric type",
  "email": "Required, customer email address",
  "created_at": "Required, customer creation time, ISO 8601 format",
  "updated_at": "Required, customer information update time, ISO 8601 format",
  "first_name": "Required, customer first name",
  "last_name": "Required, customer last name",
  "orders_count": "Required, number of customer orders, numeric type",
  "state": "Required, customer status (e.g., disabled)",
  "total_spent": "Required, total customer spending amount, string type",
  "last_order_id": "Optional, customer's last order ID, null if none",
  "note": "Optional, customer notes, null if none",
  "verified_email": "Required, whether email is verified, boolean type",
  "multipass_identifier": "Optional, Multipass identifier, null if none",
  "tax_exempt": "Optional, whether tax exempt, boolean type",
  "tags": "Required, customer tags, empty string if none",
  "last_order_name": "Optional, customer's last order name, null if none",
  "currency": "Required, customer's currency code",
  "phone": "Optional, customer phone number, null if none",
  "addresses": [
    {
      "id": "Required, address unique identifier, numeric type",
      "customer_id": "Required, associated customer ID, numeric type",
      "first_name": "Required, first name in address",
      "last_name": "Required, last name in address",
      "company": "Optional, company name, null if none",
      "address1": "Required, address line 1",
      "address2": "Optional, address line 2, null if none",
      "city": "Required, city name",
      "province": "Required, province name",
      "country": "Required, country name",
      "zip": "Required, postal code",
      "phone": "Optional, phone number, null if none",
      "name": "Required, full address name",
      "province_code": "Required, province code",
      "country_code": "Required, country code",
      "country_name": "Required, country name",
      "default": "Required, whether default address, boolean type"
    }
  ],
  "tax_exemptions": "Optional, tax exemption information, empty array if none",
  "email_marketing_consent": {
    "state": "Optional, email marketing subscription status (e.g., not_subscribed)",
    "opt_in_level": "Optional, subscription level (e.g., single_opt_in)",
    "consent_updated_at": "Optional, subscription update time, null if none"
  },
  "sms_marketing_consent": "Optional, SMS marketing subscription information, null if none",
  "admin_graphql_api_id": "Optional, unique identifier in GraphQL API",
  "default_address": {
    "id": "Required, default address unique identifier, numeric type",
    "customer_id": "Required, associated customer ID, numeric type",
    "first_name": "Required, first name in default address",
    "last_name": "Required, last name in default address",
    "company": "Optional, company name, null if none",
    "address1": "Required, default address line 1",
    "address2": "Optional, default address line 2, null if none",
    "city": "Required, default address city name",
    "province": "Required, default address province name",
    "country": "Required, default address country name",
    "zip": "Required, default address postal code",
    "phone": "Optional, default address phone number, null if none",
    "name": "Required, default address full name",
    "province_code": "Required, default address province code",
    "country_code": "Required, default address country code",
    "country_name": "Required, default address country name",
    "default": "Required, whether default address, boolean type"
  }
}
{
    "id": 8190737842432,
    "email": "AdanaKalona@example.com",
    "created_at": "2025-04-24T00:34:53-07:00",
    "updated_at": "2025-04-24T00:34:55-07:00",
    "first_name": "Adana",
    "last_name": "Kalona",
    "orders_count": 0,
    "state": "disabled",
    "total_spent": "0.00",
    "last_order_id": null,
    "note": null,
    "verified_email": true,
    "multipass_identifier": null,
    "tax_exempt": false,
    "tags": "",
    "last_order_name": null,
    "currency": "USD",
    "phone": null,
    "addresses": [
        {
            "id": 9481735307520,
            "customer_id": 8190737842432,
            "first_name": "Adana",
            "last_name": "Kalona",
            "company": null,
            "address1": "2095 East 1300 South",
            "address2": null,
            "city": "Salt Lake City",
            "province": "Utah",
            "country": "United States",
            "zip": "84108",
            "phone": null,
            "name": "Adana Kalona",
            "province_code": "UT",
            "country_code": "US",
            "country_name": "United States",
            "default": true
        }
    ],
    "tax_exemptions": [],
    "email_marketing_consent": {
        "state": "not_subscribed",
        "opt_in_level": "single_opt_in",
        "consent_updated_at": null
    },
    "sms_marketing_consent": null,
    "admin_graphql_api_id": "gid://shopify/Customer/8190737842432",
    "default_address": {
        "id": 9481735307520,
        "customer_id": 8190737842432,
        "first_name": "Adana",
        "last_name": "Kalona",
        "company": null,
        "address1": "2095 East 1300 South",
        "address2": null,
        "city": "Salt Lake City",
        "province": "Utah",
        "country": "United States",
        "zip": "84108",
        "phone": null,
        "name": "Adana Kalona",
        "province_code": "UT",
        "country_code": "US",
        "country_name": "United States",
        "default": true
    }
}
PreviousCommon data structuresNextOrder

Last updated 7 days ago

Was this helpful?