Customers > Customers > customers
Commerce APICustomersCustomerscustomers
customers
GET:customers.json

Description

Get specific customers of a given shop.

This is a typical bulk get endpoint.

Permission bit: "customers.read"

Topic: Customers

Arguments

deleted: Boolean

Include deleted items into result where applicable


ids: [String!]!

List of customer ids. See also: Unique Identifiers

Example: ["cu_EQzGqWoY"]


loose: Boolean

When asking for multiple items, allow returning less than was asked (in case some are missing)


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Result

[Customer!]

Preview (typescript)

Loading module