User API

User API is an API to get/update user details from your current team.

Here are the resources you will need to set up your Postman environment :

• Postman customer API URL : https://www.getpostman.com/collections/ccbeaee9b29db3e559f0
• Guide on how to import Postman URL here
• Guide on how to generate Locate2u client id and client secret here
• Guide on how to add client id and client secret variable to Postman environment here

Below are the list of Locate2u Customer API and it’s functionality :

Details	URL
Get all customers detail	GET https://api.locate2u.com/api/v1/customers
Create a customer	POST https://api.locate2u.com/api/v1/customers
Get a customer by id	GET https://api.locate2u.com/api/v1/customers/{id}
Edit a customer by id	PUT https://api.locate2u.com/api/v1/customers/{id}
Delete a customer by id	DELETE https://api.locate2u.com/api/v1/customers/{id}

Get User Detail

GET https://api.locate2u.com/api/v1/users/me

{
   "publicUserId":"a5de38ec-9448-410a-a287-0c724ba88dd3",
   "firstName":"Delivery Company XYZ #13",
   "lastName":"Api User",
   "company":"Delivery Company XYZ",
   "email":"9508c5c5-8231-4568-bb40-254aa6b85670@locate2u.com",
   "phone":null,
   "vehicleType":null,
   "timeZone":"AUS Eastern Standard Time",
   "countryCode":"AU",
   "bio":null,
   "industry":"Delivery",
   "websiteUrl":null,
   "role":"API User",
   "regionCode":"AU",
   "alwaysCollectLocationData":false,
   "gpsDataCollectionRule":"Default",
   "routingEngineAffinityId":"1",
   "ioTHubConnectionString":"HostName=locate2u-iot-hub.azure-devices.net;DeviceId=a5de38ec-9448-410a-a287-0c724ba88dd3;SharedAccessKey=3pQTOchbLtgxsaFaG1//YQqdYrcuJttCFjiCWYrJtJ8=;",
   "lastModifiedDate":null,
   "photoUrl":"https://locate2u.blob.core.windows.net/user-images/",
   "logoUrl":null,
   "status":"At work",
   "lang":null,
   "teamRegionId":null
}

Update User Detail

PUT https://api.locate2u.com/api/v1/users

{
   "firstName":"Adam",
   "lastName":"Smith",
   "company":"Smith Holding Pty",
   "email":"smith@gmail.com",
   "phone":"+123123123",
   "vehicleType":"",
   "timeZone":"AUS Eastern Standard Time",
   "bio":"",
   "industry":"Delivery",
   "websiteUrl":"",
   "lang":""
}

Get User Settings

PUT https://api.locate2u.com/api/v1/users/me/settings

{
   "startLocation":{
      "latitude":-33.8706672,
      "longitude":151.192487
   },
   "startAddress":"55 Miller Lane, Pyrmont, New South Wales, 2009, Australia",
   "endLocation":null,
   "endAddress":null,
   "routingPreference":"FASTEST",
   "defaultTripStartTime":"08:00",
   "defaultTripEndTime":null,
   "startFromCurrentLocation":false,
   "selfAllocationAllowed":true,
   "stopCustomFieldDefinitions":[
      {
         "name":"additionalinformation",
         "label":"Additional Information",
         "type":"Text"
      },
      {
         "name":"chillboxes",
         "label":"Chill Boxes",
         "type":"Text"
      },
      {
         "name":"frozenboxes",
         "label":"Frozen Boxes",
         "type":"Text"
      },
      {
         "name":"ordernumber",
         "label":"Order Number",
         "type":"Text"
      }
   ],
   "shipmentCustomFieldDefinitions":[
      {
         "name":"dogtype",
         "label":"Dog Type",
         "type":"Text"
      }
   ],
   "proofOfDeliveryConfiguration":[
      {
         "type":"Signature",
         "standardStops":"Optional",
         "shipmentPickupStops":"Never",
         "shipmentDropStops":"Never"
      },
      {
         "type":"Photos",
         "standardStops":"Always",
         "shipmentPickupStops":"Never",
         "shipmentDropStops":"Never"
      },
      {
         "type":"Barcodes",
         "standardStops":"Optional",
         "shipmentPickupStops":"Never",
         "shipmentDropStops":"Never"
      },
      {
         "type":"Notes",
         "standardStops":"Optional",
         "shipmentPickupStops":"Never",
         "shipmentDropStops":"Never"
      }
   ],
   "vehicleCapacityUnitsConfiguration":[
      {
         "type":"weight",
         "label":"Weight",
         "unit":"Kilograms",
         "symbol":"kg",
         "defaultLoad":10.0,
         "defaultMaxCapacity":5000.0
      }
   ],
   "vehicleCapacity":{
      "weight":5000.0
   }
}

Update User Settings

PUT https://api.locate2u.com/api/v1/users/me/settings

Updates the Status of Current User

PUT https://api.locate2u.com/api/v1/users/me/status

Updates the Photo of Current User

POST https://api.locate2u.com/api/v1/users/me/photo

Updates the Team Logo

POST https://api.locate2u.com/api/v1/users/me/logo