home > support > API > Marketplace API > API: delete_tour
Delete Tour
Deletes a tour from TourCMS.
Notes
For Tour Operator usage only (not accessible by Marketplace Agents).
Tours can only be deleted if they have no future departures or future bookings.
REST info
| Endpoint | /c/tours/delete |
| Formats | XML |
| Example | /c/tours/delete |
| Verb | POST |
Code samples
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
object delete_tour(int $tour, int $channel)
Parameters
- $tour
- Integer ID number of the tour to be deleted.
- $channel
- ID number for the channel this tour belongs to.
Example
// The id of the tour is going to be deleted.
$tour = 1;
// Define the channel ID this tour belongs to.
$channel = 3930;
// Call TourCMS API, deleting an existing tour.
$result = $tourcms->delete_tour($tour, $channel);
if ($result->error == "OK") {
print "TOUR DELETED SUCCESSFULLY";
} else {
print $result->error;
}
TOUR DELETED SUCCESSFULLYLooking for sample code in a different language? TourCMS and community provided API libraries
Querystring parameters
| Parameter | Notes |
|---|---|
| id | Tour ID you want to delete. |
Response fields
| XML Node | Notes |
|---|---|
| request | Confirmation of the request that you sent |
| error | Any error message returned, if there is no error and the tour has been deleted error will just contain the text OK |