POST /apiv2/companyLocations/create
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 |
|---|---|---|---|
internationalCountryId |
Integer | No | |
locationType |
Integer | No |
1 = FromLocation, 2 = ToLocation, 3 = BothFromAndToLocations Possible values:
|
locationId |
Integer | No | |
internationalPostcode |
String | No | |
id |
Integer | No | |
internationalCity |
String | No | |
email |
String | No | |
defaultClosingTime |
Object | No | |
defaultClosingTime.totalDays |
Number | No | |
defaultClosingTime.days |
Integer | No | |
defaultClosingTime.totalSeconds |
Number | No | |
defaultClosingTime.milliseconds |
Integer | No | |
defaultClosingTime.ticks |
Integer | No | |
defaultClosingTime.totalMilliseconds |
Number | No | |
defaultClosingTime.hours |
Integer | No | |
defaultClosingTime.seconds |
Integer | No | |
defaultClosingTime.minutes |
Integer | No | |
defaultClosingTime.totalHours |
Number | No | |
defaultClosingTime.totalMinutes |
Number | No | |
defaultPickupInstructions |
String | No | |
abbreviation |
String | No | |
defaultPickupTime |
Object | No | |
defaultPickupTime.totalDays |
Number | No | |
defaultPickupTime.days |
Integer | No | |
defaultPickupTime.totalSeconds |
Number | No | |
defaultPickupTime.milliseconds |
Integer | No | |
defaultPickupTime.ticks |
Integer | No | |
defaultPickupTime.totalMilliseconds |
Number | No | |
defaultPickupTime.hours |
Integer | No | |
defaultPickupTime.seconds |
Integer | No | |
defaultPickupTime.minutes |
Integer | No | |
defaultPickupTime.totalHours |
Number | No | |
defaultPickupTime.totalMinutes |
Number | No | |
contact |
String | No | |
location |
Object | No | |
location.id |
Integer | No |
Machship's Location Id |
location.locationType |
Integer | No |
0 = Suburb, 1 = PostOfficeBox, 2 = International Possible values:
|
location.description |
String | No | |
location.suburb |
String | No | |
location.postcode |
String | No | |
location.state |
Object | No | |
location.state.id |
Integer | No | |
location.state.name |
String | No | |
location.state.code |
String | No | |
location.country |
Object | No | |
location.country.id |
Integer | No | |
location.country.currencyCode |
String | No | |
location.country.name |
String | No | |
location.country.numeric |
String | No | |
location.country.taxPercentage |
Number | No | |
location.country.displayName |
String | No | |
location.country.code3 |
String | No | |
location.country.code2 |
String | No | |
location.subLocality |
String | No | |
location.timeZone |
String | No |
Timezone for this location |
companyId |
Integer | No | |
isInternational |
Boolean | No | |
internationalProvince |
String | No | |
addressLinesFriendly |
String | No | |
addressLine1 |
String | Yes | |
addressLine2 |
String | No | |
reference2 |
String | No | |
internationalCountry |
Object | No | |
internationalCountry.id |
Integer | No | |
internationalCountry.currencyCode |
String | No | |
internationalCountry.name |
String | No | |
internationalCountry.numeric |
String | No | |
internationalCountry.taxPercentage |
Number | No | |
internationalCountry.displayName |
String | No | |
internationalCountry.code3 |
String | No | |
internationalCountry.code2 |
String | No | |
name |
String | Yes | |
reference1 |
String | No | |
phone |
String | No | |
specialInstructions |
String | 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.