POST /apiv2/locations/returnLocations
Servers
- /
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
rawLocations[] |
Array | No | |
rawLocations[].suburb |
String | No | |
rawLocations[].postcode |
String | No | |
locationSearchOptions |
Object | No | |
locationSearchOptions.countries[] |
Array | No | |
locationSearchOptions.companyId |
Integer | No | |
locationSearchOptions.includePostOfficeBoxes |
Boolean | No | |
locationSearchOptions.isFromLocation |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.