home > support > API > Marketplace API > API: delete_pickup

Delete Pickup Point

Deletes a pickup point from TourCMS.


Notes

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

Pickup points can only be deleted if they are not connected to a tour or booking.

REST info

Endpoint/c/pickups/delete
FormatsXML
Example/c/pickups/delete
VerbPOST

Code samples

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


Description

object delete_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 to delete.
$pickup_data = new SimpleXMLElement('<pickup/>');
// The id of the pickup point is going to be deleted.
$pickup_data->pickup_id = 1;
// Define the channel ID this pickup point belongs to
$channel = 3930;

// Call TourCMS API, deleting an existing pickup point.
$result = $tourcms->delete_pickup($pickup_data, $channel);
if ($result->error == "OK") {
  print "PICKUP POINT DELETED SUCCESSFULLY";
} else {
  print $result->error;
}
PICKUP POINT DELETED SUCCESSFULLY

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 delete. This is a mandatory field.

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

More information