POST:suggest/customers.json
Commerce APIPOST:suggest/customers.json

POST:suggest/customers.json

Description

Perform a customer suggest query.

This endpoint is useful for customer autocompletion UI widgets and is optimized to work in situations alike.

Permission bit: "customers.search"

Topic: Search

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

Query

{
  "query": "fancy shoes"
}

Response Body

CustomerExpandableItems

Response Body Type

Loading module