Creating a location
Creates a new location with the given reference value. Location can be used for both Shipment Origins and Destinations for Supply Chain Monitoring.
Note
We recommend including this step for each shipment. When using the IAPI, Controlant checks for duplicates before creating a location.
https://integrations.controlant.com/api/locations/create
There are two ways to create a location:
Item | Description |
|---|---|
| Unique reference to location, created by the customer. You can use this item to reference or look up this location. |
| Customer defined name for this location. If you leave this empty, the value from |
| Description of the location. |
| The WGS latitude coordinates for the location's center-mass. Must adhere to the World Geodetic System 1984 (WGS 84) standard. NoteIf geographic coordinates for locations are not specified or GeoCoding is not enabled or possible then GeoFence capabilities will be unavailable for Shipments and Loggers shipping to and from this location. All attempts to create shipments with GeoFence settings for locations without geo location data will result in an error. |
| The WGS longitude coordinates for the location's center-mass. Must adhere to the World Geodetic System 1984 (WGS 84) standard. NoteIf geographic coordinates for locations are not specified or GeoCoding is not enabled or possible then GeoFence capabilities will be unavailable for Shipments and Loggers shipping to and from this location. All attempts to create shipments with GeoFence settings for locations without geo location data will result in an error. |
| Radius of shipment destination location's center-mass. If shipment is found within this radius of shipment location's center-mass, it is considered at destination location. Optional. NoteIf this value is omitted but geo-coordinates are present or resolved, a default value of 3000 meters (3km, Medium size) will be used. |
Automatic resolution of geographical coordinates based on address data only is an optional added value feature. For more information, see Automatic GeoCoding service.
Item | Description |
|---|---|
| Unique reference to location, created by the customer. You can use this item to reference or look up this location. |
| Customer defined name for this location. If you leave this empty, the value from |
| Description of the location. |
| Phone number of the location, in Leave blank if phone number is not needed. |
| First address line of the postal address. Leave blank if using geographical coordinates. |
| Second address line of the postal address. Leave blank if not needed. |
| Third address line of the postal address. Leave blank if not needed. |
| City of location. |
| Region of location, e.g. county. |
| Postal code / zip code of the location. Note
|
| Country of location. NoteIf you receive unexpected results for the country code specified, verify that you are using a code which includes the countries, dependent territories, and special areas of geographical interest you intend. You can look up code information at List of ISO 3166 country codes. |
| Radius of shipment destination location's center-mass. If shipment is found within this radius of shipment location's center-mass, it is considered at destination location. Optional. NoteIf this value is omitted but geo coordinates are present or resolved then a default value of 3000 meters (3km, Medium size) will be used. |
Example request
{
"reference": "controlant-boston-us",
"name": "Where Everybody Knows Your Name",
"description": "Cheers!",
"phone": "555-4568",
"addressLine1": "84 Beacon Street",
"city": "Boston",
"region": "MA",
"postCode": "66678",
"country": "US"
}Example response
{
"locationReference": "controlant-boston-us",
"success": true,
"responseTime": 0
}