home > support > API > Marketplace API > tours_pickup_routes_pickup_add
Add a pickup to a pickup route of a tour.
For Tour Operator usage only (not accessible by Marketplace Agents).
Endpoint | /api/tours/pickup/routes/pickup_add |
Formats | XML |
Example | /api/tours/pickup/routes/pickup_add.xml |
Verb | POST |
PHP examples use the PHP Client Library with the return type set to SimpleXML
tours_pickup_routes_add_pickup($data, $channel)
// Create a new SimpleXMLElement to hold the pickup details
$data = new SimpleXMLElement('<pickup/>');
$data->addChild('tour_id', 70);
$data->addChild('route_id', 2);
$data->addChild('pickup_id', 3);
$data->addChild('time', '08:45');
// Define the channel ID the pickup route belongs to.
$channel = 3930;
// Call TourCMS API to add a pickup to a pickup route.
$result = $tourcms->tours_pickup_routes_add_pickup($data, $channel);
// Check the result, will be "OK" if a route was updated
switch ($result->error) {
case "OK":
// Print a success message
print "Thanks, the pickup has been added to route.";
break;
case "NOTOK":
// Some other problem (could check error to see what)
print $result->error_message;
break;
}
Thanks, the pickup has been added to route.
Looking for sample code in a different language? TourCMS and community provided API libraries
Enter your TourCMS API credentials below to call the Add Pickup to Tour Pickup Route endpoint.
Take care, submitting this form will modify live data!
There are no querystring parameters.
The following fields can be posted as XML when calling the API, all fields are required fields.
Any fields not present in the XML will not be updated, to clear a field you will need to add it to the XML but leave it's contents blank.
XML Node | Notes | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
pickup |
The root XML element, can contain any of the following child nodes.
|
The Channel ID is also passed via the request header, this is required as Tour IDs are unique within a particular channel (supplier) rather than being unique system wide.
XML Node | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request | Confirmation of the request that you sent | ||||||||||||
error | Error status OK/NOTOK | ||||||||||||
error_message | Any error message returned. Will only be returned if error is NOTOK | ||||||||||||
tour_id | Tour ID | ||||||||||||
channel_id | Channel ID | ||||||||||||
pickup_route |
Each pickup route node contains the following child nodes.
|