Customers

Export customers

Exports the customers matching the given filters. The export is generated asynchronously and delivered to the merchant account's email address, so the response only acknowledges that the request is being processed.

get/v2/customers/export-async

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/customers/export-async
  • Auth: API key in header Authorization

Query parameters

searchstring

Search for a customer by name, phone number, or email address.

sortBystring

Field to sort by: customer name, phone number, or email address.

sortType1 | -1

Sorting direction: 1 = ascending, -1 = descending.

startDatestring

Only export customers created after this date. Example: 01-06-2024

endDatestring

Only export customers created before this date. Example: 30-06-2024

Response

Export accepted for processing — an email with the export follows shortly.

messagestring

Changes

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