home > support > API > Marketplace API > API: markup scheme information

Show Markup Scheme

Return full information about the specific Markup Scheme set for an account channel.

For Tour Operator use only, agents cannot see markup information.

Caching

If you are calling the API directly from your website (i.e. rather than populating your own database with tour data) we would recommend caching this API for around an hour. This helps you keep within API limits and to keep your site running fast. More on API caching.

REST info

Code

object show_markup_scheme ( int $channel )

// Channel (Operator) 
$channel = 12;

// Query the TourCMS API
$result = $tourcms->show_markup_scheme($channel);

// Go straight to the markup_scheme node
$markup_scheme = $result->markup_scheme;

// Print out the markup_scheme name and markup_scheme note
print $markup_scheme->markup_scheme_name.' : '.$markup_scheme->markup_scheme_note;

Scheme for UK Tours : Fixed 10%

Response fields

Example response

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <request>GET /c/markups/show.xml</request>
   <error>OK</error>
   <markup_scheme>
        <markup_scheme_id>5</markup_scheme_id>
		<markup_scheme_name>Summer Season Markup Scheme</markup_scheme_name>
		<markup_scheme_note>Tours for Summer Season</markup_scheme_note>
		<markup_types>
			<markup_type>
				<markup_type_id>11</markup_type_id>
				<markup_name>10% upper</markup_name>
				<markup_note>Upper</markup_note>
				<pre>0.00</pre>
				<percentage>10.00</percentage>
				<post>0.00</post>
			</markup_type>
			<markup_type>
				<markup_type_id>12</markup_type_id>
				<markup_name>10E discount</markup_name>
				<markup_note>10€ discount</markup_note>
				<pre>0.00</pre>
				<percentage>0.00</percentage>
				<post>-10.00</post>
			</markup_type>
			<markup_type>
				<markup_type_id>13</markup_type_id>
				<markup_name>17.65% (15% Margin)</markup_name>
				<markup_note>17.65% (15% Margin)</markup_note>
				<pre>0.00</pre>
				<percentage>17.65</percentage>
				<post>0.00</post>
			</markup_type>
		</markup_types>
    </markup_scheme>
</response>

More information

• Back to API list