Description

Get all customers of a given shop.

See also: Pagination.

Permission bit: "customers.read"

Topic: Customers

Arguments

created_at_max: String

Filter output by creation date, upper boundary

Timestamp (RFC 3339)

created_at_min: String

Filter output by creation date, lower boundary

Timestamp (RFC 3339)

customer_group_id: String

Show only customers from a certain customer group

deleted: Boolean

Include deleted items into result where applicable

last_key: String

Key of the last item from previous page. See also: Pagination

limit: Int

Return up to N entries (pagination). See also: Pagination

offset: Int

Skip N entries (pagination). See also: Pagination

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

sort_by: CustomersPageSortBy

Whether to sort output in some specific way. See also: Pagination

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

type: CustomerCategory

Filter customers output by a customer type

updated_at_max: String

Filter output by last update date, upper boundary

Timestamp (RFC 3339)

updated_at_min: String

Filter output by last update date, lower boundary

Timestamp (RFC 3339)

Result

CustomerPage

Preview (typescript)

Loading module