home > support > API > Marketplace API > API: list_pickups
List Pickup Points
Lists pickup points in TourCMS for an account.
Notes
For Tour Operator usage only (not accessible by Marketplace Agents).
REST info
| Endpoint | /c/pickups/list |
| Formats | XML |
| Example | /c/pickups/list |
| Verb | GET |
Code samples
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
list_pickups($query_string, $channel)
Parameters
- $query_string
- The filters for the pickups (id, page, per_page) Can be empty.
- $channel
- ID number for the channel the pickup points belongs to.
Example
// Define the ID of the pickup point we wish to get.
$query_string = "id=1";
// Define the channel ID the pickup points belongs to.
$channel = 3930;
// Call TourCMS API, getting the list of pickups points.
$result = $tourcms->list_pickups($query_string, $channel);
print $result->error;
OK
Looking for sample code in a different language? TourCMS and community provided API libraries
Try it
Enter your TourCMS API credentials below to call the List Pickups endpoint.
Querystring parameters
PHP examples use the PHP Client Library with the return type set to SimpleXML
Description
list_pickups($query_string, $channel)
Parameters
- $query_string
- The filters for the pickups (id, page, per_page) Can be empty.
- $channel
- ID number for the channel the pickup points belongs to.
Example
// Define the ID of the pickup point we wish to get.
$query_string = "id=1";
// Define the channel ID the pickup points belongs to.
$channel = 3930;
// Call TourCMS API, getting the list of pickups points.
$result = $tourcms->list_pickups($query_string, $channel);
print $result->error;OKLooking for sample code in a different language? TourCMS and community provided API libraries
Try it
Enter your TourCMS API credentials below to call the List Pickups endpoint.
| Parameter | Notes |
|---|---|
| id | Pickup point ID. If set we will return the specified pickup point. |
| per_page | Number of results to return per page. Default is 100. Max is 250. |
| page | Integer for which page number to return. Default is page 1. |
The Channel ID is also passed via the request header, this is required as Tour IDs are unique within a particular channel (supplier) rather than being unique system wide.
Response fields
| 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 | ||||||||||||||||||||||||||||||||
| total_pickup_count | The total number of pickup points in the TourCMS account | ||||||||||||||||||||||||||||||||
| pickups |
Pickups node contains:
|