Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetCustomerSearchQuery

Hierarchy

Index

Properties

Optional fields

fields?: string

A comma-separated list of fields to include in the response

Optional limit

limit?: number

The maximum number of results to show (default: 50, maximum: 250)

Optional order

order?: string

Set the field and direction by which to order results (default: last_order_date DESC)

query

query: string

Text to search for the the shop's customer data.

Supported queries: accepts_marketing,activation_date,address1,address2,city,company,country,customer_date,customer_first_name,customer_id,customer_last_name,customer_tag,email,email_marketing_state,first_name,first_order_date,id,last_abandoned_order_date,last_name,multipass_identifier,orders_count,order_date,phone,province,shop_id,state,tag,total_spent,updated_at,verified_email,product_subscriber_status

Generated using TypeDoc