products

List products

Lists products

Request

HTTP GET to /products

Filter

Name	Value	Description	Data type	Default
businessunitids	businessunitids=4,54	Only products for specified business unit/facility	ID-list	Alla
producttype	producttype=groupActivity	Only products of specified product type	Product type
bookablefrominternet	bookablefrominternet=true	Only products available on the Internet. Have setting "Internet" activated.	Boolean
productlabel	productlabel=cafe	Filter using product lable. If the specified label is not found no resultst will be returned.	String
number	number=234	Filter by product number	String
groupid	groupid=2	Filter products by product group.	ID
stockid	stockid=2	If specified the amount in stock for the specified wharehouse location will be included. Valid only for stock items.	ID
includeOnlyUsedAsPackageParts	includeOnlyUsedAsPackageParts=true	Includes products that may only be booked as part of a package deal. Is ignored when listing individual products by ID.	Boolean	false
includeassociatedbusinessunits	includeassociatedbusinessunits=true	Includes information about all businessunits that has the product. NOTE: Default true due to backward compability. Set to false if the information is not used, since the response-size can be very large otherwise.	Boolean	true
language	language=en	If supplied only returns the translations in the specific language for translatable fields (2 letter, ISO 639-1 language code)

Example:

GET:APIURL/products.xml?apikey=338934897438&producttype=groupActivity

Response

Tag	Example	Format	Description
description	<description>Product description</description>	String	Description
descriptiontranslations	See example at bottom		List of available translations with their respectinve language codes
name	<name>Water bottle</name>	String	The name of the product
nametranslations	See example at bottom		List of available translations with their respectinve language codes
number	<number>23</number>	Number	Product number
lastupdate	<lastupdate>2014-11-19 12:42</lastupdate>	Time	When the product was last modified
businessunits	(se businessunitsblock)		A list of the business units/facilites the product is available for.
bookablefrominternet	<bookablefrominternet>true</bookablefrominternet>	Boolean	Activated for internet usage
productlabels	<productlabels>		Product label
productlabel	<productlabel><id>3</id><name>Bottles</name></productlabel>		Product lable
standardprice	<standardprice>		Standard price. If there is not standard price set the price will be 0.
priceincvat	<priceincvat>20000</priceincvat>	Number	Price including VAT expressed in cents/ören
priceexvat	<priceexvat>16000</priceexvat>	Number	Price excluding VAT expressed in cents/ören
cssclass	<cssclass>blue</cssclass>
group	<group><id>3</id><name>Reception</name> <nametranslations> <nametranslation> <language>sv</language> <translation>Conference</translation> </nametranslation> </nametranslations> </group>		Product group
producttype	<producttype>Article</producttype>		Product type
stock	<stock><id>2</id><name>L1</name><balance>3</balance></stock>		Inventory
onlyUseAsPackagePart	<onlyUseAsPackagePart>false</onlyUseAsPackagePart>	Boolean	The product may only be booked as part of a package dealProdukttyper

Name	Description
groupActivity	Product for classes / group activities
subscription	Membership product (subscription)
package	Package deals
article	Article
service	Service
event	Event
stockProduct	Stock article
valueCard	Value card
entry	Entry

Fields that are included int he response if the product is a service

Tag	Example	Format	Description
timeresolution	<timeresolution>00:15</timeresolution>		Increment for suggested times
timeresolutionfromschedulestart	<timeresolutionfromschedulestart>false</timeresolutionfromschedulestart>	Boolean	If the suggested times are to calculated from the beginning of a schedule or from the end of the previous booking.
resourcerequirements	<resourcerequirements>		Lists the resource requirements.
resourcerequirement	<resourcerequirement><id>44</id><type>Lokal</type><resourcerequirement>		Resource requirements

Fields that are included int he response if the product is a value card

Tag	Example	Format	Description
isvaluecardproducttype	<isvaluecardproducttype>true</isvaluecardproducttype>	Boolean	If the value card based on this product is a discount card

Fields that are included in the response if the product is a membership/subscription

Tag	Example	Format	Description
requiresautogiro	<requiresautogiro>true</requiresautogiro>	Boolean	If the membership requires Autogiro
requiresrecurringcardpayment	<requiresrecurringcardpayment>false</requiresrecurringcardpayment>	Boolean	If the membership requires recurring card payments
requiresmembership	<requiresmembership>true</requiresmembership>	Boolean	Requires a specific membership subscription.
givesmembership	<givesmembership>true</givesmembership>	Boolean	Entitles membership
signupfeeproduct	<signupfeeproduct><id>4</id><name>Registration fee</name></signupfeeproduct>		Product for sign-up fee
campaign	<campaign><campaignstart>....</campaign>		Encloses campaign info (if the product is not configured for a campaign the contents are empty.
campaignstart	<campaignstart>2014-10-01</campaignstart>	Date	Date for campaign start
campaignend	<campaignend>2014-12-31</campaignend>	Date	Date for campaign end
campaignprice	<campaignprice>19900</campaignprice>	Integer	The price during the campaign
campaignpriceend	<campaignpriceend>2015-01-31</campaignpriceend>	Date	The date the membership becomes regular priced.
campaignpricemonths	<campaignpricemonths>3</campaignpricemonths>	Integer	The number of months from start until the price of the membership reverts to the standard price.
campaignnewproduct	<campaignnewproduct><id>45</id><name>Monthly training membership</name></campaignnewproduct>		The product that the membership is tranferred to after the contract period expires.
subscriptionlength	<subscriptionlength><unit>MONTH</unit><value>12</value></subscriptionlength>		The subscription length of the product. "unit" can have value "MONTH" or "DAY"

Fields that are included in the response if the product has a price pertaining to a specific business unit/facility.

Tag	Example	Data type	Description
prices	<prices />		List prices for the specific business unit/facility
price	<price>		Business unit/facility price
businessunitid	<businessunitid>134</businessunitid>	ID	Business unit/facility ID
priceincvat	<priceincvat>25000</priceincvat>	Integer	Price including VAT in cents (ören)
priceexvat	<priceexvat>20000</priceexvat>	Integer	Price excluding VAT in cents (ören)

Fields that are included in the response if the product type is stock article and the "stockid" parameter is specified.

Tag	Example	Data type	Description
stock	<stock>		Stock level
id	<id>2</id>	ID	ID of the storage facility
name	<name>Warehouse 13</name>	String	Name of the storage facility
balance	<balance>42</balance>	Integer	Number of units in the specified storage facility
businessunitid	<businessunitid>134</businessunitid>	ID	Business unit/facility ID

Fields that are included in the response if the product type is a package

Tag	Example	Data type	Description
packageparts	<packageparts>		A list of the package parts
packagepart	<packagepart>		Package part
productid	<productid>2</productid>	ID	Product ID
productname	<name>Water bottle</name>	String	Product name
perpackage	<perpackage>true</perpackage>	Boolean	One per each package or one unit for the entire booking *
day	<day>1</day>	Number	The day the package part is booked for (1 = starting day)
relativetime	<relativetime>01:00</relativetime>	Time	Relative start time from the start time of the package. Example: 01:00 would mean one hour after the package started. Have coffee served one hour after the conference starts.**
fixedtime	<fixedtime>14:00</fixedtime>	Time	Fixed time for the package part. See above.**

* If set to true there should be any many units as there are packages, otherwise one for the entire booking. Example: 5 meal deals would entail five hamburgers where as 5 conference packages would still only require 1 conference room.

** Only one of these can be set.

<product>
  <id>3</id>
  <description>Product description</description>
  <descriptiontranslations>
	<descriptiontranslation>
		<language>sv</language>
		<translation>Produktbeskrivning</translation>
	</descriptiontranslation>
  </descriptiontranslations>
  <name>Core 45 min</name>
  <nametranslations/>
  <number>23</number>
  <lastupdate>2013-11-19 12:42</lastupdate>
  <businessunits>
    <businessunit>
      <id>1</id>
      <name>Main Street Gym</name>
      <companyname>ACME Gym Company</companyname>
      <companyid>1</companyid>
    </businessunit>
  </businessunits>
  <bookablefrominternet>true</bookablefrominternet>
  <productlabels>
    <productlabel>
      <id>3</id>
      <name>Core 45 min</name>
    </productlabel>
    <productlabel>
      <id>8</id>
      <name>Mid level</name>
    </productlabel>
  </productlabels>
  <standardprice>
    <priceincvat>12500</priceincvat>
    <priceexvat>10000</priceexvat>
  </standardprice>
  <prices>
    <price>
      <businessunitid>134</businessunitid>
      <priceincvat>25000</priceincvat>
      <priceexvat>20000</priceexvat>
    </price>
  </prices>
  <cssclass>blue</cssclass>
  <group>
    <id>45</id>
    <name>Class</name>
  </group>
  <producttype>service</producttype>
  <timeresolution>00:15</timeresolution>
  <timeresolutionfromschedulestart>false</timeresolutionfromschedulestart>
  <resourcerequirements>
    <resourcerequirement>
      <id>44</id>
      <type>Room</type>
    </resourcerequirement>
    <resourcerequirement>
      <id>45</id>
      <name>Staff</type>
    </resourcerequirement>
  </resourcerequirements>
</product>