home > support > API > Marketplace API > API: delete_pickup
Deletes a pickup point from TourCMS.
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.
Endpoint | /c/pickups/delete |
Formats | XML |
Example | /c/pickups/delete |
Verb | POST |
PHP examples use the PHP Client Library with the return type set to SimpleXML
object delete_pickup(SimpleXmlElement $pickup_data, int $channel)
// 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
There are no querystring parameters.
The following fields can be posted as XML when calling the API method. The pickup_id is the only required field.
XML NODE | Notes | ||||
---|---|---|---|---|---|
pickup_point |
Pickup point node contains:
|
XML Node | Notes |
---|---|
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 |