Skip to content

Resource

Customers

The customer object

Attributes

  • idinteger
    Example: 32
  • shopify_customer_idstring
    Example: gid://shopify/Customer/9001
  • namestring
    Example: Zoe Quinn
  • first_namestring
    Example: Zoe
  • last_namestring
    Example: Quinn
  • emailstring
    Example: zoe@example.com
  • phonestring, nullable
  • tax_numberstring
    Example: DE123
  • eori_numberstring, nullable
  • tagsarray of strings
  • edited_in_appboolean
    Example: false
  • default_addressobject
    Show 16 child attributesHide child attributes
    • idinteger
      Example: 587
    • kindstring
      Example: default_address
    • namestring, nullable
    • first_namestring, nullable
    • last_namestring, nullable
    • companystring
      Example: Quinn GmbH
    • address1string
      Example: 1 Main St
    • address2string, nullable
    • citystring
      Example: Berlin
    • provincestring, nullable
    • zipstring
      Example: 10115
    • countrystring
      Example: Germany
    • country_codestring
      Example: DE
    • phonestring, nullable
    • tax_numberstring, nullable
    • eori_numberstring, nullable
  • created_atstring
    Example: 2026-11-10T08:50:31Z
  • updated_atstring
    Example: 2026-11-10T08:50:31Z
  • notestring, nullable
  • addressesarray of objects
    Show 16 child attributesHide child attributes
    • idinteger
      Example: 587
    • kindstring
      Example: default_address
    • namestring, nullable
    • first_namestring, nullable
    • last_namestring, nullable
    • companystring
      Example: Quinn GmbH
    • address1string
      Example: 1 Main St
    • address2string, nullable
    • citystring
      Example: Berlin
    • provincestring, nullable
    • zipstring
      Example: 10115
    • countrystring
      Example: Germany
    • country_codestring
      Example: DE
    • phonestring, nullable
    • tax_numberstring, nullable
    • eori_numberstring, nullable
  • documentsobject
    Show 2 child attributesHide child attributes
    • countinteger
      Example: 1
    • recentarray of objects
      Show 7 child attributesHide child attributes
      • idinteger
        Example: 980191020
      • typestring
        Example: invoice
      • numberstring
        Example: INV-9
      • shopify_order_idstring
        Example: gid://shopify/Order/1
      • created_atstring
        Example: 2026-11-10T08:50:31Z
      • sent_atstring
        Example: 2026-01-02T00:00:00Z
      • paid_atstring, nullable
The customer object
{
  "id": 32,
  "shopify_customer_id": "gid://shopify/Customer/9001",
  "name": "Zoe Quinn",
  "first_name": "Zoe",
  "last_name": "Quinn",
  "email": "zoe@example.com",
  "phone": null,
  "tax_number": "DE123",
  "eori_number": null,
  "tags": [
    "vip",
    "wholesale"
  ],
  "edited_in_app": false,
  "default_address": {
    "id": 587,
    "kind": "default_address",
    "name": null,
    "first_name": null,
    "last_name": null,
    "company": "Quinn GmbH",
    "address1": "1 Main St",
    "address2": null,
    "city": "Berlin",
    "province": null,
    "zip": "10115",
    "country": "Germany",
    "country_code": "DE",
    "phone": null,
    "tax_number": null,
    "eori_number": null
  },
  "created_at": "2026-11-10T08:50:31Z",
  "updated_at": "2026-11-10T08:50:31Z",
  "note": null,
  "addresses": [
    {
      "id": 587,
      "kind": "default_address",
      "name": null,
      "first_name": null,
      "last_name": null,
      "company": "Quinn GmbH",
      "address1": "1 Main St",
      "address2": null,
      "city": "Berlin",
      "province": null,
      "zip": "10115",
      "country": "Germany",
      "country_code": "DE",
      "phone": null,
      "tax_number": null,
      "eori_number": null
    }
  ],
  "documents": {
    "count": 1,
    "recent": [
      {
        "id": 980191020,
        "type": "invoice",
        "number": "INV-9",
        "shopify_order_id": "gid://shopify/Order/1",
        "created_at": "2026-11-10T08:50:31Z",
        "sent_at": "2026-01-02T00:00:00Z",
        "paid_at": null
      }
    ]
  }
}