JSON API » customers » customers/import

Imports customers and their taxes liable from a CSV file.

Input parameters

Requires authentication and the system owner role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
csvStringThe contents of the CSV file.Yes

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.

Data returned

The number of customers created.

Example: With required parameters (csv field omitted for brevity)

http://enswitch.example.com/api/json/codes/import/?auth_username=user;auth_password=password;csv=...

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":123 } }

Change history

VersionChanges
4.0Function added.