MXmxmerchant

Get customers

Get a list of customers

get/v3/customer

Request

Query parameters

merchantIdstring required

Merchant Id

limitinteger

Number of records to return

ascendingboolean

Sort ascending or descending

filterstring

Search fields; can search on name, customer number, email, city, state, or zip

spendProfilestring

Search customers by spend profile

sortFieldstring

Field to sort by

lastActivitystring

Filter results to time customer was last active. Values: Lifetime, Month, Week, Yesterday, Today, Last30, Last7, Custom

startDatestring date

Start date for time filter

endDatestring date

End date for time filter

Response

200

recordCountinteger

Example response

{
  "records": [
    {
      "id": 10696183,
      "name": "John Doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@gmail.com",
      "lastActivity": "2017-09-26T15:46:22.563Z",
      "allowPromotions": true,
      "spendProfile": "New",
      "spendProfileIcon": "glyphicon-local-value",
      "customerType": "Person",
      "displayColor": "A1BC3A",
      "activeStatus": true
    }
  ],
  "recordCount": 1
}

Changes

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