CUSTOMERS

Get a list of customers in CSV format

Gives information for every customer of a merchant by default.

get/v3/merchants/{mId}/customers.csv

Path parameters

mIdstring required

Merchant Id

filterstring

Filter fields: [customerSince, firstName, lastName, emailAddress, phoneNumber, marketingAllowed, fullName, id, deletedTime]

expandstring

Expandable fields: [addresses, emailAddresses, phoneNumbers, cards, metadata]

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

idstring

Unique identifier.

firstNamestring

First/given name of the customer. Note: Length of first name cannot be more than 64 characters.

lastNamestring

Last name/surname of the customer. Note: Length of last name cannot be more than 64 characters.

marketingAllowedboolean

Indicates if the customer allows receiving of marketing communication.

customerSinceinteger

Date of start of customer association with the merchant.

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