GET api/product/{id}

The products API returns the details of a single product.

Resource URL

Tests: https://sandbox.weplann.com/api/product/{id}
Production: https://developer.weplann.com/api/product/{id}

Request Parameters

Name Description Type Additional Information Mandatory
id The product details to return unique identifier Yes

Response Information

Name Description Type Additional Information
Id unique identifier
ProductTypeCode The type of product. (scheduled, timeless, dateless) string
CityCode City to which this product is assigned. string
ImmediateBooking Indicates if product has events available for sale. boolean
HasAvailability Indicates if order is placed whether the product is immediately booked with supplier. boolean
LeadPurchaseDay Number of days required to book with supplier. integer
CancelPurchaseHour Number of hours before an event that the event can be cancelled. integer
MinPrice container of price type
 + CurrencyCode The base currency for this product. string
 + Value The minimum future amount of this product. decimal
MinUsdPrice The price of the item in USD Note: this field is calculated based on the current exchange rate.
 + CurrencyCode The base currency for this item. string
 + Value The minimum future amount of this item. decimal
Location container of location
 + Venue The theater or name of the event location. string
 + Address The address of the venue or event location. string
 + Latitude The latitude of the event location. decimal
 + Longitude The longitude of the event location. decimal Latitude and Longitude can be used to map the location
Items The collection of items associated with this product
 + Id The id of the item. unique identifier
 + Name The name of the item. string
 + PartNumber The part number associated with this item. decimal
 + MinPrice container of price type
 + + CurrencyCode The base currency for this item. string
 + + Value The minimum future amount of this item. decimal
 + MinUsdPrice The price of the item in USD Note: this field is calculated based on the current exchange rate.
 + + CurrencyCode The base currency for this item. string
 + + Value The minimum future amount of this item. decimal
 + Published Indicates if this item is currently available for sale. boolean
 + TicketRules The collection of ticket rules
 + + Code The unique code for this ticket. string
 + + MinQuantity The minimum quantity for sale. integer If a value of 1 or more is present it is required ticket
 + + MaxQuantity The maximum quantity that can be sold. integer
 + + DefaultQuantity The initial display quantity. integer
 + + IncrementQuantity The increment quantity. integer if MinimumQuantity is 1 and increment quantity is 2 then 1,3,5,7 etc are valid choices.
QuestionConfiguration Container of question rules.
 + AllPassengerNames Indicates if every passenger name is required. boolean
 + AllPassengerWeights Indicates if passenger weights are required. boolean
 + Hotel Indicates if hotel is required. boolean
 + AirportFlight Indicates if airport flight is required. boolean

Example Request

GET https://developer.weplann.com/api/product/e7bdcdc3-5c63-4e2a-b0cc-2efa08ce58b2 

Example Result (XML)

<Product xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Id="4a243e11-620f-497d-814d-fb27f0e53009" xmlns="http://www.weplann.com">
	<ProductTypeCode>scheduled</ProductTypeCode>
	<Name>NY - City Tours - Mini-Washington (2 days)</Name>
	<CityCode>LGA</CityCode>
	<ImmediateBooking>true</ImmediateBooking>
	<HasAvailability>true</HasAvailability>
	<LeadPurchaseDay>12</LeadPurchaseDay>
	<CancelPurchaseHour>0</CancelPurchaseHour>
	<MinPrice CurrencyCode="USD">
		<Value>269.0000</Value>
	</MinPrice>
	<MinUsdPrice CurrencyCode="USD">
		<Value>269.0000</Value>
	</MinUsdPrice>
	<Location>
		<Venue>Hotel Pennsylvania</Venue>
		<Address>401 7th Ave, New York, NY 10001
</Address>
		<Latitude>40.749932</Latitude>
		<Longitude>-73.990992</Longitude>
	</Location>
	<Items>
		<Item Id="2d286274-b0c5-4788-9e68-7246ef6e4fcc">
			<Name>Single room - Mini-Washington</Name>
			<PartNumber>NYCMINIWAS-S - Mini-Washington </PartNumber>
			<MinPrice CurrencyCode="USD">
				<Value>435.0000</Value>
			</MinPrice>
			<MinUsdPrice CurrencyCode="USD">
				<Value>435.0000</Value>
			</MinUsdPrice>
			<Published>true</Published>
			<TicketRules>
				<TicketRule Code="adult">
					<MinQuantity>1</MinQuantity>
					<MaxQuantity>1</MaxQuantity>
					<DefaultQuantity>1</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
				<TicketRule Code="child">
					<MinQuantity>0</MinQuantity>
					<MaxQuantity>1</MaxQuantity>
					<DefaultQuantity>0</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
			</TicketRules>
		</Item>
		<Item Id="cacd453b-0d62-4cde-aa63-e09c88dd3e8b">
			<Name>Double room - Mini-Washington</Name>
			<PartNumber>NYCMINIWAS-D - Mini-Washington</PartNumber>
			<MinPrice CurrencyCode="USD">
				<Value>309.0000</Value>
			</MinPrice>
			<MinUsdPrice CurrencyCode="USD">
				<Value>309.0000</Value>
			</MinUsdPrice>
			<Published>true</Published>
			<TicketRules>
				<TicketRule Code="adult">
					<MinQuantity>2</MinQuantity>
					<MaxQuantity>2</MaxQuantity>
					<DefaultQuantity>2</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
				<TicketRule Code="child">
					<MinQuantity>0</MinQuantity>
					<MaxQuantity>2</MaxQuantity>
					<DefaultQuantity>0</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
			</TicketRules>
		</Item>
		<Item Id="b73d2cb9-d39c-4fdc-aa2d-c845410a3075">
			<Name>Triple room - Mini-Washington</Name>
			<PartNumber>NYCMINIWAS-T - Mini-Washington</PartNumber>
			<MinPrice CurrencyCode="USD">
				<Value>285.0000</Value>
			</MinPrice>
			<MinUsdPrice CurrencyCode="USD">
				<Value>285.0000</Value>
			</MinUsdPrice>
			<Published>true</Published>
			<TicketRules>
				<TicketRule Code="adult">
					<MinQuantity>3</MinQuantity>
					<MaxQuantity>3</MaxQuantity>
					<DefaultQuantity>3</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
				<TicketRule Code="child">
					<MinQuantity>0</MinQuantity>
					<MaxQuantity>1</MaxQuantity>
					<DefaultQuantity>0</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
			</TicketRules>
		</Item>
		<Item Id="336f9616-10cd-4b66-a986-c798008441d5">
			<Name>Quad room - Mini-Washington</Name>
			<PartNumber>NYCMINIWAS-Q - Mini-Washington</PartNumber>
			<MinPrice CurrencyCode="USD">
				<Value>269.0000</Value>
			</MinPrice>
			<MinUsdPrice CurrencyCode="USD">
				<Value>269.0000</Value>
			</MinUsdPrice>
			<Published>true</Published>
			<TicketRules>
				<TicketRule Code="adult">
					<MinQuantity>4</MinQuantity>
					<MaxQuantity>4</MaxQuantity>
					<DefaultQuantity>4</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
				<TicketRule Code="child">
					<MinQuantity>0</MinQuantity>
					<MaxQuantity>0</MaxQuantity>
					<DefaultQuantity>0</DefaultQuantity>
					<IncrementQuantity>1</IncrementQuantity>
				</TicketRule>
			</TicketRules>
		</Item>
	</Items>
	<QuestionConfiguration>
		<AllPassengerNames>true</AllPassengerNames>
		<AllPassengerWeights>false</AllPassengerWeights>
		<Hotel>false</Hotel>
		<AirportFlight>false</AirportFlight>
	</QuestionConfiguration>
	<UpdatedOn>2016-05-25T17:12:43.29Z</UpdatedOn>
</Product>

Example Result (JSON)

{
	"leadPurchaseDay" : 12,
	"cancelPurchaseHour" : 0,
	"description" : null,
	"minPrice" : {
		"currencyCode" : "USD",
		"value" : 269.0000
	},
	"minUsdPrice" : {
		"currencyCode" : "USD",
		"value" : 269.0000
	},
	"location" : {
		"venue" : "Hotel Pennsylvania",
		"address" : "401 7th Ave, New York, NY 10001\r\n",
		"latitude" : 40.749932,
		"longitude" : -73.990992
	},
	"items" : [
		{
			"id" : "2d286274-b0c5-4788-9e68-7246ef6e4fcc",
			"name" : "Single room - Mini-Washington",
			"description" : null,
			"partNumber" : "NYCMINIWAS-S - Mini-Washington ",
			"minPrice" : {
				"currencyCode" : "USD",
				"value" : 435.0000
			},
			"minUsdPrice" : {
				"currencyCode" : "USD",
				"value" : 435.0000
			},
			"published" : true,
			"ticketRules" : [
				{
					"code" : "adult",
					"minQuantity" : 1,
					"maxQuantity" : 1,
					"defaultQuantity" : 1,
					"incrementQuantity" : 1
				},
				{
					"code" : "child",
					"minQuantity" : 0,
					"maxQuantity" : 1,
					"defaultQuantity" : 0,
					"incrementQuantity" : 1
				}
			]
		},
		{
			"id" : "cacd453b-0d62-4cde-aa63-e09c88dd3e8b",
			"name" : "Double room - Mini-Washington",
			"description" : null,
			"partNumber" : "NYCMINIWAS-D - Mini-Washington",
			"minPrice" : {
				"currencyCode" : "USD",
				"value" : 309.0000
			},
			"minUsdPrice" : {
				"currencyCode" : "USD",
				"value" : 309.0000
			},
			"published" : true,
			"ticketRules" : [
				{
					"code" : "adult",
					"minQuantity" : 2,
					"maxQuantity" : 2,
					"defaultQuantity" : 2,
					"incrementQuantity" : 1
				},
				{
					"code" : "child",
					"minQuantity" : 0,
					"maxQuantity" : 2,
					"defaultQuantity" : 0,
					"incrementQuantity" : 1
				}
			]
		},
		{
			"id" : "b73d2cb9-d39c-4fdc-aa2d-c845410a3075",
			"name" : "Triple room - Mini-Washington",
			"description" : null,
			"partNumber" : "NYCMINIWAS-T - Mini-Washington",
			"minPrice" : {
				"currencyCode" : "USD",
				"value" : 285.0000
			},
			"minUsdPrice" : {
				"currencyCode" : "USD",
				"value" : 285.0000
			},
			"published" : true,
			"ticketRules" : [
				{
					"code" : "adult",
					"minQuantity" : 3,
					"maxQuantity" : 3,
					"defaultQuantity" : 3,
					"incrementQuantity" : 1
				},
				{
					"code" : "child",
					"minQuantity" : 0,
					"maxQuantity" : 1,
					"defaultQuantity" : 0,
					"incrementQuantity" : 1
				}
			]
		},
		{
			"id" : "336f9616-10cd-4b66-a986-c798008441d5",
			"name" : "Quad room - Mini-Washington",
			"description" : null,
			"partNumber" : "NYCMINIWAS-Q - Mini-Washington",
			"minPrice" : {
				"currencyCode" : "USD",
				"value" : 269.0000
			},
			"minUsdPrice" : {
				"currencyCode" : "USD",
				"value" : 269.0000
			},
			"published" : true,
			"ticketRules" : [
				{
					"code" : "adult",
					"minQuantity" : 4,
					"maxQuantity" : 4,
					"defaultQuantity" : 4,
					"incrementQuantity" : 1
				},
				{
					"code" : "child",
					"minQuantity" : 0,
					"maxQuantity" : 0,
					"defaultQuantity" : 0,
					"incrementQuantity" : 1
				}
			]
		}
	],
	"questionConfiguration" : {
		"allPassengerNames" : true,
		"allPassengerWeights" : false,
		"hotel" : false,
		"airportFlight" : false
	},
	"updatedOn" : "2016-05-25T17:12:43.29Z",
	"id" : "4a243e11-620f-497d-814d-fb27f0e53009",
	"productTypeCode" : "scheduled",
	"name" : "NY - City Tours - Mini-Washington (2 days)",
	"cityCode" : "LGA",
	"immediateBooking" : true,
	"hasAvailability" : true
}