POST /apiv2/locations/returnLocations
Returns all locations that exactly match the supplied suburb and postcode combination. Multiple locations can be providedServers
- /
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.includeLocationAliases |
Boolean | No |
Load each location's alias spellings onto the result. Off by default so API response payloads keep serialising locationAliases as null; opt in only for internal matching (eg auto-consolidation) that needs to recognise alias-spelling input. JsonIgnore keeps this internal flag out of the public API contract entirely: it must not appear in serialised payloads (request or response) nor be settable by external callers. |
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.