Customer object

Version unstable

Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive email marketing.

Required access

read_customers access scope.

Connections

  • events (EventConnection!)

    A list of events 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:

    • comments
    • created_at
    • subject_type
    • verb

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

    reverse ( Boolean )

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

    sortKey ( EventSortKeys )

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

  • metafields (MetafieldConnection!)

    List of metafields that belong to the resource.

    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.

    namespace ( String )

    The metafield namespace to filter by.

    reverse ( Boolean )

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

  • orders (OrderConnection!)

    A list of the customer's orders.

    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:

    • cart_token
    • channel_id
    • chargeback_status
    • checkout_token
    • created_at
    • credit_card_last4
    • customer_id
    • delivery_method
    • discount_code
    • email
    • financial_status
    • fraud_protection_level
    • fulfillment_location_id
    • fulfillment_status
    • location_id
    • name
    • processed_at
    • reference_location_id
    • return_status
    • risk_level
    • sales_channel
    • source_identifier
    • source_name
    • status
    • tag
    • test
    • updated_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

  • A list of the customer's payment methods.

    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 )