API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

Customer object

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope.

Connections

  • A list of addresses for the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • orders (OrderConnection!)

    The orders associated with the customer.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • processed_at

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( OrderSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

Fields

  • acceptsMarketing (Boolean!)

    Indicates whether the customer has consented to be sent marketing material via email.

  • createdAt (DateTime!)

    The date and time when the customer was created.

  • defaultAddress (MailingAddress)

    The customer’s default address.

  • displayName (String!)

    The customer’s name, email or phone number.

  • email (String)

    The customer’s email address.

  • firstName (String)

    The customer’s first name.

  • id (ID!)

    A unique identifier for the customer.

  • lastIncompleteCheckout (Checkout)

    The customer's most recently updated, incomplete checkout.

  • lastName (String)

    The customer’s last name.

  • phone (String)

    The customer’s phone number.

  • tags ([String!]!)

    A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

    Required access

    unauthenticated_read_customer_tags access scope.

  • updatedAt (DateTime!)

    The date and time when the customer information was updated.

Types that return Customer

Mutations for Customer