TourCMS, a leading online booking and channel management solution is operated by Palisis.

Contact Info

Palisis AG
Florastrasse 18A
8610 Uster
+41 44 533 40 40

Follow Us

home > support > API > Marketplace API > API: create_pickup

Create new Pickup Point

Creates a new pickup point.


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

REST info


Code samples

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


object create_pickup(SimpleXmlElement $pickup_data, int $channel)


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


// Create the simplexml object to contain the pickup data.
$pickup_data = new SimpleXMLElement('<pickup/>');
$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";
$pickup_data->supplier_pickup_code = "supplier pickup code";

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

// Call TourCMS API, creating the new pickup point.
$result = $tourcms->create_pickup($pickup_data, $channel);
if ($result->error == "OK") {
  print "NEW PICKUP ID: " . $result->pickup->pickup_id;
} else {
  print $result->error;

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_name is the only required field.

POST fields

Pickup point node contains:

XML NodeNotes
pickup_name The name of the pickup point. This is a mandatory field.
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
supplier_pickup_code Allows subsystem mapping of pickups

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
XML NodeNotes
pickup_id Pickup ID for the new pickup point created.

More information