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
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

Example:

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

Response

Tag	Example	Format	Description
description	<description>Product description</description>	String	Description
name	<name>Water bottle</name>	String	The name of the product
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></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 int he 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>Inskrivningsavgift 2014</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>	Datum	Date for campaign start
campaignend	<campaignend>2014-12-31</campaignend>	Datum	Date for campaign end
campaignprice	<campaignprice>19900</campaignprice>	Nummer	The price during the campaign
campaignpriceend	<campaignpriceend>2015-01-31</campaignpriceend>	Datum	The date the membership becomes regular priced.
campaignpricemonths	<campaignpricemonths>3</campaignpricemonths>	Nummer	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.

Fält som tillkommer i svaret om produkten har ett anläggningspris

Tag	Exempel	Format	Förklaring
prices	<prices />		Lista anläggningsp riser
price	<price>		Anläggnings pris
businessunitid	<businessunitid>134</businessunitid>	Id	Id på anläggningen
priceincvat	<priceincvat>25000</priceincvat>	Nummer	Pris inklusive moms uttryckt i ören
priceexvat	<priceexvat>20000</priceexvat>	Nummer	Pris exklusive moms uttryckt i ören

Fält som tillkommer i svaret om produkten är av typen lagervara och parametern "stockid" är angiven

Tag	Exempel	Format	Förklaring
stock	<stock>		Lagerbalans
id	<id>2</id>	Id	Lagerställets id
name	<name>Lager 1</name>	Sträng	Lagerställets namn
balance	<balance>42</balance>	Nummer	Antal enheter i det aktuella lagerstället
businessunitid	<businessunitid>134</businessunitid>	Id	Id på anläggningen

Fält som tillkommer i svaret om produkten är av typen paket

Tag	Exempel	Format	Förklaring
packageparts	<packageparts>		Lista av paketdelar
packagepart	<packagepart>		Paketdel
productid	<id>2</id>	Id	Produktens id
productname	<name>Lager 1</name>	Sträng	Produktens namn
perpackage	<perpackage>true</perpackage>	Boolean	En per antal eller en för hela bokningen*
day	<day>1</day>	Nummer	Vilken dag paketdelen infaller på (1 = startdagen)
relativetime	<relativetime>01:00</relativetime>	Tid	Relativ startid utifrån paketets start**
fixedtime	<fixedtime>14:00</fixedtime>	Tid	Fast tid för paketdelen**

* Om true så ska det vara lika många av paketdelen som av paketet annars endast 1 för hela paketet.

** Endast en av dessa är satta.

<product>
  <id>3</id>
  <description>Produktbeskrivning</description>
  <name>Spinn B45</name>
  <number>23</number>
  <lastupdate>2013-11-19 12:42</lastupdate>
  <businessunits>
    <businessunit>
      <id>1</id>
      <name>Anläggningens namn</name>
      <companyname>Bolagsnamn</companyname>
      <companyid>1</companyid>
    </businessunit>
  </businessunits>
  <bookablefrominternet>true</bookablefrominternet>
  <productlabels>
    <productlabel>
      <id>3</id>
      <name>Spinning</name>
    </productlabel>
    <productlabel>
      <id>8</id>
      <name>Medel</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>Gruppträning</name>
  </group>
  <producttype>service</producttype>
  <timeresolution>00:15</timeresolution>
  <timeresolutionfromschedulestart>false</timeresolutionfromschedulestart>
  <resourcerequirements>
    <resourcerequirement>
      <id>44</id>
      <type>Lokal</type>
    </resourcerequirement>
    <resourcerequirement>
      <id>45</id>
      <name>Personal</type>
    </resourcerequirement>
  </resourcerequirements>
</product>