Customers

Customers Query

Returns a paginated list of Customer objects, with optional filtering and ordering.

Arguments

Name	Type	Description
after	Cursor	Returns the elements in the list that come after the specified cursor
first	Int	Returns the first n elements from the list
before	Cursor	Returns the elements in the list that come before the specified cursor
last	Int	Returns the last n elements from the list
orderBy	CustomerOrder	Ordering options for customers returned from the connection
where	CustomerWhereInput	Filtering options for customers returned from the connection

Return Type

CustomerConnection! - A connection to a list of Customer objects with pagination information.

Notes

• The data field contains custom attributes as JSON

• Use Data, DataHasKey, DataIn, and DataContains filters for querying JSON data

• See Advanced JSON Field Queries for detailed JSON query examples

Usage Example

query {
  # Search customers by name
  customers(
    where: {
      name_CONTAINS: "Corp"
    },
    orderBy: { direction: ASC, field: NAME }
  ) {
    edges {
      node {
        id
        name
        code
        email
        data
      }
      cursor
    }
    totalCount
  }
}

query {
  # Get customers with recent orders
  customers(
    where: {
      pickingOrders_SOME: {
        createdAt_GTE: "2024-01-01T00:00:00Z"
      }
    },
    first: 20
  ) {
    edges {
      node {
        id
        name
        pickingOrders {
          id
          createdAt
          orderitems {
            quantity
            item {
              sku
            }
          }
        }
      }
    }
  }
}

Common Filters

• name_CONTAINS - Search by customer name

• code - Find by exact customer code

• email - Find by email address

• dataTypeSlug - Filter by customer type

• pickingOrders_SOME - Filter by order criteria

Notes

• Customers are linked to picking orders

• Support custom fields through data/dataType

• Can represent both individuals and organizations

• Use virtual repositories named after customers for shipping