GET:customers.json
Commerce APIGET:customers.json

GET:customers.json

Description

Get specific customers of a given shop.

This is a typical bulk get endpoint.

Permission bit: "customers.read"

Topic: Customers

Query Parameters

deleted: Boolean

Include deleted items into result where applicable

Example: ?deleted=true


ids: Comma-separated array of String, required

List of customer ids. See also: Unique Identifiers

Example: ?ids=cu_EQzGqWoY,cu_EQzGqWoY


loose: Boolean

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

Example: ?loose=true


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Response Body

Array of Customer

Response Body Type

Loading module