v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Search Customers

Lets you fetch customers based on partial or complete keywords passed. You can fetch customers by name, customer identifier, registered store id, registered date, loyalty points, lifetime points, lifetime purchases amount, current tier, transaction amount, and custom field values.

get/customer/search

Query parameters

format'json' | 'xml'

Preferred response format.

qstring required

Query string by which customers need to be fetched. q=({param}:{Operator}:{value})<br> Use Query Grammar.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "customer": {
      "count": "2",
      "start": "0",
      "rows": "10",
      "results": {
        "item": [
          {
            "user_id": "102",
            "org_id": "29",
            "firstname": "Tom",
            "lastname": "Sawyer",
            "mobile": "44700900000",
            "email": "tom.sawyer@example.com",
            "external_id": "None",
            "loyalty_points": "355",
            "lifetime_points": "5400",
            "lifetime_purchases": "10800",
            "current_slab": "CLASSIC",
            "registered_on": "2012-12-25 11:25:32",
            "registered_by": "pe.london.bondstreet",
            "last_trans_value": "1000",
            "attributes": {
              "attribute": {
                "name": "customer_age",
                "value": "26-35"
              }
            }
          }
        ]
      }
    }
  }
}