GetSurroundingCustomers
Exports customers near a given location including the driving time and distance required to reach the customer from that location. The location can either be customers or the user's home location.
|
https://my.portatour.net/a/api/GetSurroundingCustomers?parameters
|
| Required URL parameters | |
| format | Export format, can be one of xlsx, xls, ods, csv, simplecsv, or xlsxtable. More information |
|---|---|
| userEmail, employeeNumber | Email address or employee number of the user whose customers to export. Exactly one must be specified. |
| Optional URL parameters | |
| language | Recommended. Language used for the export. More information |
| forCustomerWithExternalID, forCustomerWithPortatourID | External ID and/or Portatour ID of the customer whose surrounding customers should be exported. If neither of the parameters is specified, the user's home location will be used. |
| maxResultRows | If specified, only the first maxResultRows customers will be exported. |
| orderBy | How the customers should be ordered, can be one of time or distance. Default is time. |
| exportFields | If specified, the export will only contain the listed fields, in the specified order. More information |
|
curl -o customers.csv -u admin_username:admin_password
"https://my.portatour.net/a/api/GetSurroundingCustomers?format=csv&language=en-US&userEmail=bob@example.com"
|
Caution: When you process exported data, don't depend on the column order. Use the column header names to access data. The order of the columns might change, e.g if new fields are added. In case your importer doesn’t support accessing field values by field name, use the exportFields parameter to specify the columns and their order.