Lista produkter
Listar produkt
...
List products
Lists products
Request
HTTP GET till to /products
Filter
namnName | exempelvärdeValue | förklaring | Värdemängd/DatatypDescription | Data type | Default |
|---|---|---|---|---|---|
businessunitids | businessunitids=4,54Endast produkter på dessa anläggningar | Only products for specified business unit/facility | ID-listalist | Alla | |
producttype | producttype=groupActivity | Endast produkter av denna produkttyp | ProdukttypOnly products of specified product type | Product type |
|
bookablefrominternet | bookablefrominternet=true | Endast produkter markerade som "Bokbar via Internet". Detta betyder även att produkten finns för försäljning på webben (abonnemang, vara, värdekort, tjänst, arrangemang)Only products available on the Internet. Have setting "Internet" activated. | Boolean |
| |
productlabel | productlabel=cafe | Filtrerar på produktetikett, om etiketten inte hittas blir resultatet tomt. | SträngFilter using product lable. If the specified label is not found no resultst will be returned. | String |
|
groupid | groupid=2Filtrerar ut produkter som tillhör angiven produktgrupp | Filter products by product group. | ID |
| |
| stockid | stockid=2Om angivet inkluderas lagerbalansen för angivet lagerställe på produkter av typen lagervara | If specified the amount in stock for the specified wharehouse location will be included. Valid only for stock items. | ID | ||
| includeOnlyUsedAsPackageParts | includeOnlyUsedAsPackageParts=trueInkluderar | produkter som endast är bokbara som del av paket. Ignoreras vid listning av enskild produkt med hjälp av idIncludes products that may only be booked as part of a package deal. Is ignored when listing individual products by ID. | Boolean | false |
ExempelExample:
| Code Block |
|---|
GET:APIURL/products.xml?apikey=338934897438&producttype=groupActivity |
...
Response
Tag | ExempelExample | Format | FörklaringDescription | |
|---|---|---|---|---|
description | <description>Produktbeskrivning<<description>Product description</description> | SträngString | BeskrivningDescription | |
name | <name>Spinn B45<<name>Water bottle</name> | Sträng | Produktens namnString | The name of the product |
| number | <number>23</number> | NummerNumber | ProduktnummerProduct number | |
lastupdate | <lastupdate>2013<lastupdate>2014-11-19 12:42</lastupdate> | Tidpunkt | När produkten sparades senastTime | When the product was last modified |
| businessunits | (se businessunitsblock) | Lista på de anläggningar som har produkten kopplad | A list of the business units/facilites the product is available for. | |
bookablefrominternet | <bookablefrominternet>true</bookablefrominternet> | BooleanBokbar via Internet | Activated for internet usage | |
productlabels | <productlabels> | Etikettlista | Product label | |
productlabel | <productlabel><id>3</id><name>Spinning<id><name>Bottles</name></productlabel> | Produktetikett | Product lable | |
| standardprice | <standardprice> | Ej anläggningsspecifikt standardpris. Om standardpris saknas kommer priserna nedan vara 0 | Standard price. If there is not standard price set the price will be 0. | |
| priceincvat | <priceincvat>20000</priceincvat> | Nummer | Pris inklusive moms uttryckt i Number | Price including VAT expressed in cents/ören |
| priceexvat | <priceexvat>16000</priceexvat> | Nummer | Pris exklusive moms uttryckt i Number | Price excluding VAT expressed in cents/ören |
cssclass | <cssclass>blue</cssclass> |
|
| |
group | <group><id>3</id><name>Gruppträning<id><name>Reception</name></group> | Produktgrupp | Product group | |
producttype | <producttype>service<<producttype>Article</producttype> | Produkttyp | Product type | |
| stock | <stock><id>2</id><name>L1</name><balance>3</balance></stock> | LagerbalansInventory | ||
| onlyUseAsPackagePart | <onlyUseAsPackagePart>false</onlyUseAsPackagePart> | Boolean | Produkten är endast bokbar som del av paket |
Produkttyper
| Namn | Förklaring |
|---|---|
| groupActivity | Gruppaktivitetsprodukt |
| subscription | Abonnemangsprodukt (som abonnemang baseras på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 | PaketproduktPackage deals |
| article | VaraArticle |
| service | TjänstService |
| event | ArrangemangEvent |
| stockProductLagervara | Stock article |
| valueCardVärdekort | Value card |
| entry | Entré |
Fält som tillkommer i svaret om produkten är en tjänst
Tag | Exempel | Format | FörklaringEntry |
|---|
Fields that are included int he response if the product is a service
Tag | Example | Format | Description |
|---|---|---|---|
timeresolution | <timeresolution>00:15</timeresolution> | Upplösning av tidsförslag | Increment for suggested times |
timeresolutionfromschedulestart | <timeresolutionfromschedulestart>false</timeresolutionfromschedulestart> | BooleanOm tidsförslagen ska räknas från början på schemat eller från slutet av tidigare bokning | If the suggested times are to calculated from the beginning of a schedule or from the end of the previous booking. |
resourcerequirements | <resourcerequirements> | Lista med resurskrav när produkten är en tjänst | Lists the resource requirements. |
resourcerequirement | <resourcerequirement><id>44</id><type>Lokal</type><resourcerequirement> |
| Resurskrav |
...
Resource requirements |
Fields that are included int he response if the product is a value card
Tag | ExempelExample | Format | FörklaringDescription |
|---|---|---|---|
isvaluecardproducttype | <isvaluecardproducttype>true</isvaluecardproducttype> | Boolean | Om värdekort baserad på denna produkt blir klippkort |
Fält som tillkommer i svaret om produkten är ett abonnemang
Tag | Exempel | Format | FörklaringIf 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> | BooleanOm abonnemanget kräver autogiro | If the membership requires Autogiro |
| requiresrecurringcardpayment | <requiresrecurringcardpayment>false</requiresrecurringcardpayment> | BooleanOm abonnemanget kräver återkommande kortbetalning | If the membership requires recurring card payments |
| requiresmembership | <requiresmembership>true</requiresmembership> | BooleanKräver medlemskap | Requires a specific membership subscription. |
| givesmembership | <givesmembership>true</givesmembership> | BooleanGer medlemskap | Entitles membership |
| signupfeeproduct | <signupfeeproduct><id>4</id><name>Inskrivningsavgift 2014</name></signupfeeproduct> | Produkt för inskrivningsavgift | Product for sign-up fee |
| campaign | <campaign><campaignstart>....</campaign> | Omsluter kampanjinfo (om produkten inte är en kampanjprodukt är taggen tom) | Encloses campaign info (if the product is not configured for a campaign the contents are empty. |
| campaignstart | <campaignstart>2014-10-01</campaignstart> | DatumDatum för kampanjstart | Date for campaign start |
| campaignend | <campaignend>2014-12-31</campaignend> | DatumDatum för kampanjslut | Date for campaign end |
| campaignprice | <campaignprice>19900</campaignprice> | NummerPris under kampanjlängden | The price during the campaign |
| campaignpriceend | <campaignpriceend>2015-01-31</campaignpriceend> | DatumDatum då abonnemanget övergår från kampanjpris till ordinarie pris | The date the membership becomes regular priced. |
| campaignpricemonths | <campaignpricemonths>3</campaignpricemonths> | NummerAntal månader från start till att abonnemanget övergår till ordinarie pris | The number of months from start until the price of the membership reverts to the standard price. |
| campaignnewproduct | <campaignnewproduct><id>45</id><name>Månadskort ordinarie<id><name>Monthly training membership</name></campaignnewproduct> | Produkt som abonnemanget övergår till efter bindningstidens slut | 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
...