customer

customer.find

Find customers in store.

get/customer.find.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/customer.find.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

find_valuestring required

Entity search that is specified by some value

find_wherestring

Entity search that is specified by the comma-separated unique fields

find_paramsstring

Entity search that is specified by comma-separated parameters

store_idstring

Store Id

include_guestsboolean

Indicates whether to search among guest customers when looking up a customer.

Response

successful operation

return_codeinteger nullable
return_messagestring nullable
additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.