...
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 |
| 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:
| Code Block |
|---|
GET:APIURL/products.xml?apikey=338934897438&producttype=groupActivity |
...
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></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 |
...
| Code Block |
|---|
<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> |