POST:search/customers.json

Description

Perform a customer search query getting metadata back.

Permission bit: "customers.search"

Topic: Search

Query Parameters

limit: Int

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

Example: ?limit=5

offset: Int

Skip N entries (pagination). See also: Pagination

Example: ?offset=5

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

sort_by: SearchCustomersSortBy

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

Example: ?sort_by=created_at

sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

Example: ?sort_desc=true

Request Body

Array of SearchOption

Copy
[
  {
    "boolean": true,
    "context": "",
    "name": "total_price",
    "nil": true,
    "now": true,
    "number": 3.1415,
    "op": "and",
    "parent_index": 5,
    "text": "",
    "zero": true
  }
]

Response Body

CustomerSearchResult

Response Body Type

Loading module