home > support > API > Marketplace API > API: update_pickup

Update Pickup Point

Updates an existing pickup point based on pickup_id.


Notes

For Tour Operator usage only (not accessible by Marketplace Agents).

REST info

Endpoint/c/pickups/update
FormatsXML
Example/c/pickups/update
VerbPOST

Code samples

PHP examples use the PHP Client Library with the return type set to SimpleXML


Description

object update_pickup(SimpleXmlElement $pickup_data, int $channel)


Parameters

$pickup_data
SimpleXmlElement containing the pickup point data.
$channel
ID number for the channel this pickup point belongs to.


Example


// Create the simplexml object to contain the pickup data.
$pickup_data = new SimpleXMLElement('<pickup/>');
// The id of the pickup point to update.
$pickup_data->pickup_id = 1;
$pickup_data->pickup_name = "pickup_name";
$pickup_data->description = "description";
$pickup_data->address1 = "new address1";
$pickup_data->address2 = "new address2";
$pickup_data->postcode = "new postcode";
$pickup_data->lat = 123;
$pickup_data->long = 321;
$pickup_data->staff_only = 1;
$pickup_data->rank = 0;
$pickup_data->viator_name = "viator pickup name";

// Define the channel ID this pickup point belongs to.
$channel = 3930;

// Call TourCMS API, updating an existing pickup point.
$result = $tourcms->update_pickup($pickup_data, $channel);
if ($result->error == "OK") {
  print "UPDATED PICKUP ID: " . $result->pickup->pickup_id;
} else {
  print $result->error;
}
    
UPDATED PICKUP ID: 1

Looking for sample code in a different language? TourCMS and community provided API libraries

Querystring parameters

There are no querystring parameters.

Post fields

The following fields can be posted as XML when calling the API method. The pickup_id is the only required field.

POST fields
XML NODENotes
pickup_point

Pickup point node contains:

XML NodeNotes
pickup_id The pickup point to update. This is a mandatory field.
pickup_name The name of the pickup point.
description Any extra information for the client, e.g. "Meet in the reception lounge"
address1 First line of the address
address2 Second line of the address
postcode Postcode
lat Latitude - geographic coordinate
long Longitude - geographic coordinate
staff_only 1/0
0 - All - Can be added by customers, travel agents and staff (Default)
1 - Staff only - Can ONLY be added to a booking by staff only (not customers / travel agents)
rank Numeric - Can be used as an additional ordering value for hotel pickup reports
viator_name If you configure the hotel name EXACTLY as configured in Viator, TourCMS will map Viator bookings to the correct pickup point

Response fields

Response fields
XML NodeNotes
request Confirmation of the request that you sent
error Any error message returned, if there is no error this will just contain the text OK
pickup
XML NodeNotes
pickup_id Pickup ID for the updated pickup point.

More information