API

API

PUT /api/v1/shipments

PUT /api/v1/shipments

This endpoint allows you to update a specific shipment with the given ID. The request should be sent via an HTTP PUT method to the specified URL.
Update existing shipments data like update address, notes, assignee etc. Full details are available under the schema. Please refer below to understand the details and description of stop’s each field.

Input parameters:
id

id * integer($int32) (path) Pass the ID of the shipment to update.

Update shipment request body fields : UpdateShipmentRequest{

tripDate

Holds the information about the scheduled date of a shipment. Developers can update the scheduled date of shipment by using this field.

tripDate, string($date-time), nullable: true

pickupStopId

Unique id of the pickup leg of a shipment.

pickupStopId, integer($int32)

pickupStop

ShipmentStopRequest{
contact	Contact{
                name string
                nullable: true
                phone string
                nullable: true
                email string
                nullable: true
	       }
brandId	integer($int32)
nullable: true
name	string
nullable: true
address	string
nullable: true
addressComponents	GeocodingComponents{
					    geocoder string
					    nullable: true
					    type string
					    nullable: true
					    confidenceScore number($double)
					    nullable: true
					    address string
					    nullable: true
                                            location Location {
                                             latitude number($double)
                                             longitude number($double)
                                                             }
                                            line1 string
                                            nullable: true
                                            line2 string
                                            nullable: true
                                            city string
					    nullable: true
                                            province string
					    nullable: true
                                            provinceCode string
					    nullable: true
					    postcode string
					    nullable: true
					    country string
					    nullable: true
					    countryCode	string
					    nullable: true
					}
tripDate string($date-time)
nullable: true
location Location{
         latitude number($double)
         longitude number($double)
                 }
appointmentTime	string
nullable: true
timeWindowStart	string
nullable: true
timeWindowEnd	string
nullable: true
durationMinutes	integer($int32)
notes	string
nullable: true
customerId	integer($int32)
nullable: true
teamRegionId	integer($int32)
nullable: true
driverInstructions	DriverInstructions{
                                           hasAuthorityToLeave boolean
					   nullable: true
                                           mustCheckRecipientId	boolean
					   nullable: true
                                           mustWearHighVisibilityVest boolean
					   nullable: true
                                           isContactlessDelivery boolean
                                           nullable: true
					   doorCode string
                                           nullable: true
                                           instructions	string
                                           nullable: true
                                           leaveAtLocation string
					   nullable: true
                                           }
}

Pickup stop details.

dropStopId

Unique id of the Drop leg of a shipment, integer($int32).

dropStop: Drop stop fields.

ShipmentStopRequest{
contact	Contact{
                name string
                nullable: true
                phone string
                nullable: true
                email string
                nullable: true
	       }
brandId	integer($int32)
nullable: true
name	string
nullable: true
address	string
nullable: true
addressComponents GeocodingComponents{
					    geocoder string
					    nullable: true
					    type string
					    nullable: true
					    confidenceScore number($double)
					    nullable: true
					    address string
					    nullable: true
                                            location Location {
                                             latitude number($double)
                                             longitude number($double)
                                                             }
                                            line1 string
                                            nullable: true
                                            line2 string
                                            nullable: true
                                            city string
					    nullable: true
                                            province string
					    nullable: true
                                            provinceCode string
					    nullable: true
					    postcode string
					    nullable: true
					    country string
					    nullable: true
					    countryCode	string
					    nullable: true
					}
tripDate string($date-time)
nullable: true
location Location{
         latitude number($double)
         longitude number($double)
                 }
appointmentTime	string
nullable: true
timeWindowStart	string
nullable: true
timeWindowEnd	string
nullable: true
durationMinutes	integer($int32)
notes	string
nullable: true
customerId	integer($int32)
nullable: true
teamRegionId	integer($int32)
nullable: true
driverInstructions	DriverInstructions{
                                           hasAuthorityToLeave boolean
					   nullable: true
                                           mustCheckRecipientId	boolean
					   nullable: true
                                           mustWearHighVisibilityVest boolean
					   nullable: true
                                           isContactlessDelivery boolean
                                           nullable: true
					   doorCode string
                                           nullable: true
                                           instructions	string
                                           nullable: true
                                           leaveAtLocation string
					   nullable: true
                                           }
}

Drop stop details.

contact

Holds the information about Contact details of a shipment. Developers can update the contact details for a particular shipment like name, phone and email of the contact person.

namestring nullable: true
phonestring nullable: true
emailstring nullable: true
customFields

These are additional input fields that you can add to gather specific information beyond standard details which are available by default of the shipment’s form. They allow you to tailor the Shipment details form to collect data relevant to your specific needs, such as preferences, comments, or any other information pertinent to the shipment’s purpose. For example a delivery company can set specific pre delivery questions for a driver to confirm before picking up the item. These are the available options for custom field types : Text, Date, Multi line text and Checkbox field.

  customFields{}nullable: true
skills

In Locate2u “skill” refers to a Team member’s or Driver’s ability to perform a task or activity effectively for a given shipment delivery. Developers can set this on a shipment record so that while assigning or offering the shipments the skill on a shipment record will be matched to the Team member’s or Driver’s skills before assigning.

String, nullable: true

assignedToPublicUserId

This is the Public user id of the assigned team member/driver for the shipment. Developers can supply in the ID (assignedToPublicUserId) of the desired Team member to update the assignee of a shipment. For details about team members please visit team member endpoint documentation.

assignedToPublicUserIdstringnullable: true
notes

Notes for the shipment.

load

Load is the amount or weight or volume of parcel that vehicle is going to carry for the particular shipment. Developers can set this using the load field on the shipment.

load{
    “quantity”: ,        “volume”: ,        “weight”: ,        “length”:,        “width”: ,        “height”: 
}
customerId

Unique id of the customer records specific to your Locate2u account. Developers can use this to directly set the Stop for a particular customer. For details about customers please also see Customers endpoint documentation.

customerIdinteger($int32)nullable: true
brandId

An integer field for supplying a brandId to be associated with a Shipment. You can get the details of all Brands associated with your Locate2u account by calling api/v1/brands. For more information on Brands end point refer to Brands end point link.

brandIdinteger($int32)nullable: true
runNumber

A number representing the run to which this shipment belongs to. Usually customers with a large number of deliveries batch multiple shipments and stops into a single run which then can be assigned to particular drivers for smoother delivery. Developers can use runNumber to set it on a stop record which then binds the stop to a particular run for a given trip.

runNumberinteger($int32)nullable: true
teamRegionId

Team regions are defined geographical areas or a territory assigned to a team of delivery personnel. Each member under a team region is responsible for handling deliveries and work orders within their designated region . This is mostly used around organizations to optimize deliveries and streamline logistics and services, and improve efficiency in the overall process. Developers can use teamRegionId to assign a particular team region to a shipment and rest all team region based functionality will be handled by the system.
For more details on Team region please see team region id endpoint documentation.

teamRegionIdinteger($int32)nullable: true
contents

ShipmentContents
{
 isAlcohol boolean
 nullable: true
 isTobacco boolean
 nullable: true
 isPrescriptionMedication boolean
 nullable: true
 isDangerousGoods boolean
 nullable: true
 isMeat boolean
 nullable: true
 isPork boolean
 nullable: true
 isBeef boolean
 nullable: true
 isFragile boolean
 nullable: true
 isFlowers boolean
 nullable: true
 isCake boolean
 nullable: true
 isFood boolean
 nullable: true
 isLiquid boolean
 nullable: true
 isNotRotatable	boolean
 nullable: true
 isGlass boolean
 nullable: true
 isBaked boolean
 nullable: true
 mustBeUpright boolean
 nullable: true
}

Object containing fields to define the type of the shipment content of a delivery. For example a Delivery company would like to specify if it is a package containing Alcohol or prescription Medication or a dangerous goods.

Example request:

The request body should be in raw format and should include the following parameters:

{
  "tripDate": "2024-03-11",
  "pickupStopId": 158969,
  "pickupStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Pickup Stop",
    "address": "Level 4, Suite 4.11, 55 Miller St, Pyrmont NSW 2009, Australia",
    "tripDate": "2024-03-11",
    "location": {
      "latitude": -33.8706672,
      "longitude": 151.192487
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "dropStopId": 158970,
  "dropStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Drop Stop",
    "address": "1 William St, Darlinghurst NSW 2010, Australia",
    "tripDate": "2024-03-11",
    "location": {
      "latitude": -33.8743446,
      "longitude": 151.2131667
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "contact": {
    "name": "Matthew Robinson",
    "phone": "0123456789",
    "email": "matt.robinson@email.com"
  },
  "customFields": "{ custom1 : 'value', custom2: 'value', custom3: 'value'}",
  "skills": "skills1, skills2, skills3",
  "assignedToPublicUserId": "ee59-b174-4698-ac55-81d9d",
  "notes": "Please call before you deliver",
  "load": {
    "quantity": 0,
    "volume": 0,
    "weight": 0,
    "length": 0,
    "width": 0,
    "height": 0
  },
  "customerId": 0,
  "brandId": null,
  "runNumber": 0,
  "teamRegionId": 0,
  "contents": null
}

Sample code

C#
Java
NodeJS
PHP
Python
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://api.locate2u.com/api/v1/shipments/174495");
request.Headers.Add("Authorization", "Bearer yourBearerTokenHere");
var content = new StringContent("{\r\n  \"tripDate\": \"2024-02-07\",\r\n  \"pickupStopId\": 158969,\r\n  \"pickupStop\": {\r\n    \"contact\": {\r\n      \"name\": \"Matthew Robinson\",\r\n      \"phone\": \"0123456789\",\r\n      \"email\": \"matt.robinson@email.com\"\r\n    },\r\n    \"brandId\": null,\r\n    \"name\": \"Locate2u Pickup Stop\",\r\n    \"address\": \"Level 4, Suite 4.11, 55 Miller St, Pyrmont NSW 2009, Australia\",\r\n    \"tripDate\": \"2024-02-07\",\r\n    \"location\": {\r\n      \"latitude\": -33.8706672,\r\n      \"longitude\": 151.192487\r\n    },\r\n    \"appointmentTime\": \"12:00\",\r\n    \"timeWindowStart\": null,\r\n    \"timeWindowEnd\": null,\r\n    \"durationMinutes\": 10,\r\n    \"notes\": \"Please call before you deliver\",\r\n    \"customerId\": 0,\r\n    \"teamRegionId\": 0,\r\n    \"driverInstructions\": null,\r\n    \"lines\": null\r\n  },\r\n  \"dropStopId\": 158970,\r\n  \"dropStop\": {\r\n    \"contact\": {\r\n      \"name\": \"Matthew Robinson\",\r\n      \"phone\": \"0123456789\",\r\n      \"email\": \"matt.robinson@email.com\"\r\n    },\r\n    \"brandId\": null,\r\n    \"name\": \"Locate2u Drop Stop\",\r\n    \"address\": \"1 William St, Darlinghurst NSW 2010, Australia\",\r\n    \"tripDate\": \"2024-02-07\",\r\n    \"location\": {\r\n      \"latitude\": -33.8743446,\r\n      \"longitude\": 151.2131667\r\n    },\r\n    \"appointmentTime\": \"12:00\",\r\n    \"timeWindowStart\": null,\r\n    \"timeWindowEnd\": null,\r\n    \"durationMinutes\": 10,\r\n    \"notes\": \"Please call before you deliver\",\r\n    \"customerId\": 0,\r\n    \"teamRegionId\": 0,\r\n    \"driverInstructions\": null,\r\n    \"lines\": null\r\n  },\r\n  \"contact\": {\r\n    \"name\": \"Matthew Robinson\",\r\n    \"phone\": \"0123456789\",\r\n    \"email\": \"matt.robinson@email.com\"\r\n  },\r\n  \"customFields\": \"{ custom1 : 'value', custom2: 'value', custom3: 'value'}\",\r\n  \"skills\": \"skills1, skills2, skills3\",\r\n  \"assignedToPublicUserId\": \"ee59-b174-4698-ac55-81d9d\",\r\n  \"notes\": \"Please call before you deliver\",\r\n  \"load\": {\r\n    \"quantity\": 0,\r\n    \"volume\": 0,\r\n    \"weight\": 0,\r\n    \"length\": 0,\r\n    \"width\": 0,\r\n    \"height\": 0\r\n  },\r\n  \"customerId\": 0,\r\n  \"brandId\": null,\r\n  \"runNumber\": 0,\r\n  \"teamRegionId\": 0,\r\n  \"contents\": null\r\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n  \"tripDate\": \"2024-02-07\",\r\n  \"pickupStopId\": 158969,\r\n  \"pickupStop\": {\r\n    \"contact\": {\r\n      \"name\": \"Matthew Robinson\",\r\n      \"phone\": \"0123456789\",\r\n      \"email\": \"matt.robinson@email.com\"\r\n    },\r\n    \"brandId\": null,\r\n    \"name\": \"Locate2u Pickup Stop\",\r\n    \"address\": \"Level 4, Suite 4.11, 55 Miller St, Pyrmont NSW 2009, Australia\",\r\n    \"tripDate\": \"2024-02-07\",\r\n    \"location\": {\r\n      \"latitude\": -33.8706672,\r\n      \"longitude\": 151.192487\r\n    },\r\n    \"appointmentTime\": \"12:00\",\r\n    \"timeWindowStart\": null,\r\n    \"timeWindowEnd\": null,\r\n    \"durationMinutes\": 10,\r\n    \"notes\": \"Please call before you deliver\",\r\n    \"customerId\": 0,\r\n    \"teamRegionId\": 0,\r\n    \"driverInstructions\": null,\r\n    \"lines\": null\r\n  },\r\n  \"dropStopId\": 158970,\r\n  \"dropStop\": {\r\n    \"contact\": {\r\n      \"name\": \"Matthew Robinson\",\r\n      \"phone\": \"0123456789\",\r\n      \"email\": \"matt.robinson@email.com\"\r\n    },\r\n    \"brandId\": null,\r\n    \"name\": \"Locate2u Drop Stop\",\r\n    \"address\": \"1 William St, Darlinghurst NSW 2010, Australia\",\r\n    \"tripDate\": \"2024-02-07\",\r\n    \"location\": {\r\n      \"latitude\": -33.8743446,\r\n      \"longitude\": 151.2131667\r\n    },\r\n    \"appointmentTime\": \"12:00\",\r\n    \"timeWindowStart\": null,\r\n    \"timeWindowEnd\": null,\r\n    \"durationMinutes\": 10,\r\n    \"notes\": \"Please call before you deliver\",\r\n    \"customerId\": 0,\r\n    \"teamRegionId\": 0,\r\n    \"driverInstructions\": null,\r\n    \"lines\": null\r\n  },\r\n  \"contact\": {\r\n    \"name\": \"Matthew Robinson\",\r\n    \"phone\": \"0123456789\",\r\n    \"email\": \"matt.robinson@email.com\"\r\n  },\r\n  \"customFields\": \"{ custom1 : 'value', custom2: 'value', custom3: 'value'}\",\r\n  \"skills\": \"skills1, skills2, skills3\",\r\n  \"assignedToPublicUserId\": \"ee59-b174-4698-ac55-81d9d\",\r\n  \"notes\": \"Please call before you deliver\",\r\n  \"load\": {\r\n    \"quantity\": 0,\r\n    \"volume\": 0,\r\n    \"weight\": 0,\r\n    \"length\": 0,\r\n    \"width\": 0,\r\n    \"height\": 0\r\n  },\r\n  \"customerId\": 0,\r\n  \"brandId\": null,\r\n  \"runNumber\": 0,\r\n  \"teamRegionId\": 0,\r\n  \"contents\": null\r\n}");
Request request = new Request.Builder()
  .url("https://api.locate2u.com/api/v1/shipments/174495")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer yourBearerTokenHere")
  .build();
Response response = client.newCall(request).execute();
var https = require('follow-redirects').https;
var fs = require('fs');


var options = {
  'method': 'PUT',
  'hostname': 'api.locate2u.com',
  'path': '/api/v1/shipments/174495',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer yourBearerTokenHere'
  },
  'maxRedirects': 20
};


var req = https.request(options, function (res) {
  var chunks = [];


  res.on("data", function (chunk) {
    chunks.push(chunk);
  });


  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });


  res.on("error", function (error) {
    console.error(error);
  });
});


var postData = JSON.stringify({
  "tripDate": "2024-02-07",
  "pickupStopId": 158969,
  "pickupStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Pickup Stop",
    "address": "Level 4, Suite 4.11, 55 Miller St, Pyrmont NSW 2009, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8706672,
      "longitude": 151.192487
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "dropStopId": 158970,
  "dropStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Drop Stop",
    "address": "1 William St, Darlinghurst NSW 2010, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8743446,
      "longitude": 151.2131667
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "contact": {
    "name": "Matthew Robinson",
    "phone": "0123456789",
    "email": "matt.robinson@email.com"
  },
  "customFields": "{ custom1 : 'value', custom2: 'value', custom3: 'value'}",
  "skills": "skills1, skills2, skills3",
  "assignedToPublicUserId": "ee59-b174-4698-ac55-81d9d",
  "notes": "Please call before you deliver",
  "load": {
    "quantity": 0,
    "volume": 0,
    "weight": 0,
    "length": 0,
    "width": 0,
    "height": 0
  },
  "customerId": 0,
  "brandId": null,
  "runNumber": 0,
  "teamRegionId": 0,
  "contents": null
});


req.write(postData);


req.end();
 'https://api.locate2u.com/api/v1/shipments/174495',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
  "tripDate": "2024-02-07",
  "pickupStopId": 158969,
  "pickupStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Pickup Stop",
    "address": "Level 4, Suite 4.11, 55 Miller St, Pyrmont NSW 2009, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8706672,
      "longitude": 151.192487
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "dropStopId": 158970,
  "dropStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Drop Stop",
    "address": "1 William St, Darlinghurst NSW 2010, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8743446,
      "longitude": 151.2131667
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "contact": {
    "name": "Matthew Robinson",
    "phone": "0123456789",
    "email": "matt.robinson@email.com"
  },
  "customFields": "{ custom1 : \'value\', custom2: \'value\', custom3: \'value\'}",
  "skills": "skills1, skills2, skills3",
  "assignedToPublicUserId": "ee59-b174-4698-ac55-81d9d",
  "notes": "Please call before you deliver",
  "load": {
    "quantity": 0,
    "volume": 0,
    "weight": 0,
    "length": 0,
    "width": 0,
    "height": 0
  },
  "customerId": 0,
  "brandId": null,
  "runNumber": 0,
  "teamRegionId": 0,
  "contents": null
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer yourBearerTokenHere'
  ),
));


$response = curl_exec($curl);


curl_close($curl);
echo $response;
import requests
import json


url = "https://api.locate2u.com/api/v1/shipments/174495"


payload = json.dumps({
  "tripDate": "2024-02-07",
  "pickupStopId": 158969,
  "pickupStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": None,
    "name": "Locate2u Pickup Stop",
    "address": "Level 4, Suite 4.11, 55 Miller St, Pyrmont NSW 2009, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8706672,
      "longitude": 151.192487
    },
    "appointmentTime": "12:00",
    "timeWindowStart": None,
    "timeWindowEnd": None,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": None,
    "lines": None
  },
  "dropStopId": 158970,
  "dropStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": None,
    "name": "Locate2u Drop Stop",
    "address": "1 William St, Darlinghurst NSW 2010, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8743446,
      "longitude": 151.2131667
    },
    "appointmentTime": "12:00",
    "timeWindowStart": None,
    "timeWindowEnd": None,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": None,
    "lines": None
  },
  "contact": {
    "name": "Matthew Robinson",
    "phone": "0123456789",
    "email": "matt.robinson@email.com"
  },
  "customFields": "{ custom1 : 'value', custom2: 'value', custom3: 'value'}",
  "skills": "skills1, skills2, skills3",
  "assignedToPublicUserId": "ee59-b174-4698-ac55-81d9d",
  "notes": "Please call before you deliver",
  "load": {
    "quantity": 0,
    "volume": 0,
    "weight": 0,
    "length": 0,
    "width": 0,
    "height": 0
  },
  "customerId": 0,
  "brandId": None,
  "runNumber": 0,
  "teamRegionId": 0,
  "contents": None
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer yourBearerTokenHere'
}


response = requests.request("PUT", url, headers=headers, data=payload)


print(response.text)

Response

Example response: For a successful 200 
{
  "tripDate": "2024-02-07",
  "pickupStopId": 158969,
  "pickupStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Pickup Stop",
    "address": "Level 4, Suite 4.11, 55 Miller St, Pyrmont NSW 2009, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8706672,
      "longitude": 151.192487
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "dropStopId": 158970,
  "dropStop": {
    "contact": {
      "name": "Matthew Robinson",
      "phone": "0123456789",
      "email": "matt.robinson@email.com"
    },
    "brandId": null,
    "name": "Locate2u Drop Stop",
    "address": "1 William St, Darlinghurst NSW 2010, Australia",
    "tripDate": "2024-02-07",
    "location": {
      "latitude": -33.8743446,
      "longitude": 151.2131667
    },
    "appointmentTime": "12:00",
    "timeWindowStart": null,
    "timeWindowEnd": null,
    "durationMinutes": 10,
    "notes": "Please call before you deliver",
    "customerId": 0,
    "teamRegionId": 0,
    "driverInstructions": null,
    "lines": null
  },
  "contact": {
    "name": "Matthew Robinson",
    "phone": "0123456789",
    "email": "matt.robinson@email.com"
  },
  "customFields": "{ custom1 : 'value', custom2: 'value', custom3: 'value'}",
  "skills": "skills1, skills2, skills3",
  "assignedToPublicUserId": "ee59-b174-4698-ac55-81d9d",
  "notes": "Please call before you deliver",
  "load": {
    "quantity": 0,
    "volume": 0,
    "weight": 0,
    "length": 0,
    "width": 0,
    "height": 0
  },
  "customerId": 0,
  "brandId": null,
  "runNumber": 0,
  "teamRegionId": 0,
  "contents": null
}