Resurssit - Tuotteet ja varasto
Tuotteiden käsittelyn toiminnot jakautuvat seuraaviin toimintoihin:
| Integraatio | HTTP-metodi | Resurssi | DTD |
| Tuotelistan nouto | GET | productlist.nv | |
| Tuotetietojen nouto | GET | getproduct.nv | |
| Tuotetietojen tuonti | POST | product.nv | product.dtd |
| Rakenteellisen tuotelistan nouto | GET | webshopproductlist.nv | |
| Rakenteellisten tuotteiden tuotekuvien nouto | GET | webshopproductimages.nv | |
| Tuotesaldojen nouto varastoittain | GET | inventorybywarehouse.nv | |
| Varastotapahtuman tuonti | POST | warehouseevent.nv | warehouseevent.dtd |
Resurssi: productlist.nv
Tuotelista sisältää tuotteiden perustietoja. Tarkemmat tuotetiedot voidaan tämän jälkeen noutaa käyttäen toimintoa Tuotetietojen nouto.
Kutsussa käytettävät parametrit:
| Parametri | Ilmentymiä | Esimerkki | Kuvaus |
| changedsince | 0...1 | 2014-09-13 | Suodattaa tuotteet, joissa muutoksia annetun päivämäärän jälkeen. Päivämäärä muodossa YYYY-MM-DD |
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Esimerkki | Kuvaus |
| Root | root | Aggregaatti | 1 | ||
| 1 | ProductList | Aggregaatti | 1 | ||
| 2 | Product | Aggregaatti | 0...n | ||
| 3 | NetvisorKey | Numeerinen | 1 | 165 | Tuotteen tunnus Netvisorissa |
| 3 | ProductCode | Merkkijono | 1 | TT | Tuotekoodi |
| 3 | Name | Merkkijono | 1 | Testituote | Tuotenimike |
| 3 | UnitPrice | Numeerinen | 1 | 1,96 | Tuotteen yksikköhinta nettona |
| 3 | Uri | Merkkijono | 1 | http://koulutus.netvisor.fi/getproduct.nv?id=165 | URI, josta voi hakea Tuotteen täydelliset tiedot |
Resurssi: getproduct.nv
Ennen tuotetietojen noutoa on noudettava tuotelista, josta poimitaan tuotteen tunniste (NetvisorKey). Tunnisteen avulla tarkemmat tiedot voidaan noutaa. Vain yhden tuotteen tiedot voidaan noutaa kerrallaan.
Kutsussa käytettävät parametrit:
| Parametri | Ilmentymiä | Esimerkki | Kuvaus |
| id | 1 | 123 | Halutun tuotteen Netvisor-avain. |
| NetvisorKeyList | 0...1 | 1,2,3 | Palauttaa yhdessä pyynnössä täydet tiedot kaikista halutuista tuotteista, max. 500 ID:tä |
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Esimerkki | Kuvaus |
| Root | root | Aggregaatti | 1 | ||
| 1 | Product | Aggregaatti | 1 | ||
| 2 | ProductBaseInformation | Aggregaatti | 0...n | ||
| 3 | NetvisorKey | Numeerinen | 1 | Tuotteen Netvisor-avain | |
| 3 | ProductCode | Merkkijono | 1 | CC | Tuotekoodi |
| 3 | ProductGroup | Merkkijono | 1 | Kirjat | Tuoteryhmän nimi |
| 3 | Name | Merkkijono | 1 | Code Complete | Tuotteen nimi |
| 3 | Description | Merkkijono | 1 | Toinen painos | Kuvaus |
| 3 | UnitPrice | Numeerinen | 1 | 42,5 | Tuotteen yksikköhinta |
| Attribuutti | type | Merkkijono | 1 | net | Aina net (veroton). |
| 3 | Unit | Merkkijono | 1 | kpl | Tuotteen yksikkö |
| 3 | UnitWeight | Numeerinen | 1 | 1 | Tuotteen yksikköpaino |
| 3 | PurchasePrice | Numeerinen | 1 | 25 | Ostohinta |
| 3 | TariffHeading | Merkkijono | 1 | Code Complete | Tullinimike |
| 3 | ComissionPercentage | Numeerinen | 1 | 11 | Provisio |
| 3 | IsActive | Numeerinen | 1 | 1 | Onko tuote aktiivinen, 0=ei / 1=kyllä |
| 3 | IsSalesProduct | Numeerinen | 1 | 0 | Onko tuote myyntituote, 0=ei / 1=kyllä |
| 2 | ProductBookKeepingDetails | Aggregaatti | 1 | ||
| 3 | DefaultVatPercent | Numeerinen | 1 | 22 | Alv-kanta |
| 3 | DefaultDomesticAccountNumber | Numeerinen | 1 | Kotimainen oletustilinumero | |
| 3 | DefaultEuAccountNumber | Numeerinen | 1 | EU:n alueen oletustilinumero | |
| 3 | DefaultOutsideEUAccountnumber | Numeerinen | 1 | Kansainvälinen oletustilinumero | |
| 2 | ProductInventoryDetails | Aggregaatti | 1 | ||
| 3 | InventoryAmount | Numeerinen | 1 | 2,00 | Varastossa olevien tuotteiden määrä |
| 3 | InventoryMidPrice | Numeerinen | 1 | 5,00 | Tuotteen keskihinta Keskihinta |
| 3 | InventoryValue | Numeerinen | 1 | 10,0000 | Varastonarvo: varastossa x keskihinta |
| 3 | InventoryReservedAmount | Numeerinen | 1 | 1,00 | Varattujen tuotteiden määrä |
| 3 | InvetoryOrderedAmount | Numeerinen | 1 | 0,00 | Tilattujen tuotteiden määrä |
Resurssi: product.nv
Tietojen tuonti rajapinnan yli ei ole tuettu laajennetun tuotehallinnan kanssa.
Kutsussa käytettävät parametrit (QueryString):
| Parametri | Ilmentymiä | Esimerkki | Kuvaus |
| method | 1 | Add | Add tai Edit |
| id | 0..1 | 123 | Jos method on Edit, tarvitaan muokattavan tuotteen id |
Mikäli metodia ei ole annettu tai päivitettävää tuotetta ei löydy järjestelmästä, palautetaan INVALID_DATA –virhe selitteineen. Päivitettävän tuotteen id:n saa tietoon kysymällä ensin tuotelistaa.
Tuotavat tiedot lähetetään kutsun mukana oheisen kuvauksen mukaisena xml:nä (POST-data):
| Taso | Elementti | Muoto | Ilmentymiä | Esimerkki | Kuvaus |
| Root | root | Aggregaatti | 1 | ||
| 1 | product | Aggregaatti | 1 | ||
| 2 | productbaseinformation | Aggregaatti | 1 | ||
| 3 | productcode | Merkkijono | 0...1 | CC | Tuotekoodi |
| 3 | productgroup | Merkkijono | 1 | Kirjat | Tuoteryhmän nimi, tuote lisätään ryhmään mikäli tuoteryhmä löytyy järjestelmästä. Jos ei löydy, se perustetaan |
| 3 | name | Merkkijono | 1 | Code Complete | Tuotteen nimi |
| 3 | description | Merkkijono | 0...1 | Toinen painos | Kuvaus |
| 3 | unitprice | Numeerinen | 1 | 42,5 | Tuotteen yksikköhinta |
| Attribuutti | type | Merkkijono | 1 | net | Kertoo onko annettu hinta verollinen (gross) vai veroton (net). |
| 3 | unit | Merkkijono | 0...1 | kpl | Tuotteen yksikkö, jos annettua yksikkö ei löydy järjestelmästä se perustetaan. Jos löytyy, käytetään olemassa olevaa |
| 3 | unitweight | Numeerinen | 0...1 | 1 | Tuotteen yksikköpaino |
| 3 | purchaseprice | Numeerinen | 0...1 | 25 | Ostohinta |
| 3 | tariffheading | Merkkijono | 0...1 | Code complete | Tullinimike |
| 3 | comissionpercentage | Numeerinen | 0...1 | 11 | Provisioprosentti |
| 3 | isactive | Numeerinen | 1 | 1 | Onko tuote aktiivinen, 0 = ei-aktiivinen / 1 = aktiivinen |
| 3 | issalesproduct | Numeerinen | 1 | 0 | Onko tuote myyntituote, 0 = ei / 1 = kyllä |
| 3 | inventoryenabled | Numeerinen | 0...1 | 1 | Onko tuote varastossa, 0 = ei / 1 = kyllä |
| 2 | productbookkeepingdetails | Aggregaatti | 0...1 | ||
| 3 | defaultvatpercentage | Numeerinen | 1 | 22 | Alv-kanta, jos annettua verokantaa ei löydy järjestelmästä palautetaan virhe |
Rakenteelisen tuotelistan nouto
Resurssi: webshopproductlist.nv
Tässä on kuvattu kuinka verkkokaupan tuotelista voidaan noutaa ja tätä voi käyttää ainoastaan ne kenellä on käytössä laajennettu tuotehallinta. Listaus sisältää tietoja tuotteesta kuten nimen ja kuvauksen eri kielillä sekä tietoa tuotteen varianteista.
Kutsussa käytettävät parametrit:
| Parametri | Ilmentymiä | Esimerkki | Kuvaus |
| limitDeleted | 0...1 | 1 | Kun määritelty, vain aktiiviset päätuotteet sisältyvät tulokseen |
| limitActive | 0...1 | 1 | Kun määritelty, vain aktiiviset variantit sisältyvät tulokseen |
| limitPublished | 0...1 | 1 | Kun määritelty, vain julkaistut tuotteet sisältyvät tulokseen |
| limitSellable | 0...1 | 1 | Kun määritelty, vain myytävissä olevat tuotteet sisältyvät tulokseen |
| limitChangedSince | 0...1 | 2016-01-28 | Suodattaa tuotteet, joissa muutoksia annetun päivämäärän jälkeen Päivämäärä muodossa YYYY-MM-DD |
| limitSourceProductNetvisorKey | 0...1 | 154 | Tuotteen Netvisor ID:llä rajataan tulosten määrää |
| limitshownonwebshopproducts | 0...1 | 45 | Käytetään määriteltäessä noutamaan vain verkkokauppatuotteet |
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Esimerkki | Kuvaus |
| Root | Root | Aggr, | 1 | ||
| 1 | WebShopProductList | Aggr. | 1 | ||
| 2 | WebShopProduct | Aggr. | 0...n | ||
| 3 | NetvisorKey | Numeerinen | 1 | 145 | Tuotetunnus Netvisorissa |
| 3 | Name | Merkkijono | 1...3 | Tuote | Tuotteen nimi |
| Attr. | language | Merkkijono | FI | Nimen kieli: FI, EN or SE | |
| 3 | Description | Merkkijono | 1...3 | Tämä on tuote | Tuotteen kuvaus |
| Attr. | language | Merkkijono | FI | Kuvauksen kieli: FI, EN or SE | |
| 3 | ProductCode | Merkkijono | 1 | A123 | Tuotekoodi |
| 3 | ProductGroup | Aggregaatti | 0...n | ||
| 4 | Name | Merkkijono | 1...3 | Ryhmä 1 | Tuoteryhmän nimi |
| Attr. | language | Merkkijono | FI | Tuoteryhmän nimen kieli: FI, EN or SE | |
| 3 | UnitNetPrice | Numeerinen | 1 | 12,00 | Tuotteen yksikköhinta |
| 3 | UnitGrossPrice | Numeerinen | 1 | 14,64 | Tuotteen verollinen hinta |
| 3 | Unit | Merkkijono | 1 | kpl | Tuotteen mittayksikkö |
| 3 | UnitWeight | Numeerinen | 1 | 1,50 | Tuotteen paino |
| 3 | ImageURI | Teksti | 1 |
http://integrationdemo.netvisor.fi |
URI tuotteen kuvalle |
| 3 | URI | Teksti | 1 | http://koulutus.netvisor.fi/getproduct.nv?id=165 | URI tuotteen tiedoille |
| 3 | InventoryAmount | Numeerinen | 1 | 30,00 | Tuotteiden määrä varastossa |
| 3 | InventoryOrderedAmount | Numeerinen | 1 | 1,00 | Tilattujen tuotteiden määrä |
| 3 | InventoryReservedAmount | Numeerinen | 1 | 3,00 | Varattujen tuotteiden määrä |
| 3 | IsActive | Numeerinen | 1 | 1 | Onko tuote aktiivinen: 0 = ei / 1 = kyllä |
| IsSalesProduct | Numeerinen | 1 | 1 | Onko tuote myynnissä: 0 = ei / 1 = kyllä | |
| 3 | IsStorageProduct | Numeerinen | 1 | 1 | Onko tuote varastossa: 0 = ei / 1 = kyllä |
| 3 | DefaultVatPercentage | Numeerinen | 1 | 22 | ALV-luokka |
| 3 | IsPublished | Numeerinen | 1 | 1 | Onko tuote julkaistu: 0 = ei / 1 = kyllä |
| 3 | VersionNumber | Numeerinen | 1 | Tuotteen versionumero | |
| 3 | Variants | Aggr. | 1 | ||
| 4 | Variant | Aggr. | 0...n | ||
| 5 | Name | Text | 1...3 | Paita, punainen | Variantin nimi |
| Attr. | language | Text | FI | FI, EN or SE | |
| 5 | Description | Text | 1...3 | Punainen paita | Variantin kuvaus |
| Attr. | language | Text | FI | FI, EN or SE | |
| 5 | VariantIdentifier | Teksti | 1 | ABC002 | Variantin Netvisor tunniste |
| 5 | ImageUri | Teksti | 1 |
http://integrationdemo.netvisor.fi/webshopproductimages.nv? |
Uri variantin kuvalle |
| 5 | LastchangeDate | Päivämäärä | 1 | 30.1.2014 10:12:06 | Edellisen muutoksen aikaleima |
| 5 | UnitNetPrice | Numeerinen | 1 | 1,00 | Variantin veroton hinta |
| 5 | UnitGrossPrice | Numeerinen | 1 | 1,22 | Variantin verollinen hinta |
| 5 | InventoryAmount | Numeerinen | 1 | 12,00 | Variantin määrä varastossa |
| 5 | InventoryOrderedAmount | Numeerinen | 1 | 12,00 | Varastosta tilattu määrä |
| 5 | InventoryReservedAmount | Numeerinen | 1 | 12,00 | Varastosta varattu määrä |
| 5 | PriceGroups | Aggregaatti | 0...1 | ||
| 6 | PriceGroup | Aggregaatti | 1...n | ||
| 7 | Description | Teksti | 1 | Variantin hintaryhmän kuvaus | |
| 7 | Value | Numeerinen | 1 | Hintaryhmän arvo | |
| 7 | type | Teksti | 1 | Arvon tyyppi multiplier tai fixed | |
| 3 | PriceGroups | Aggregaatti | 0...1 | ||
| 4 | PriceGroup | Aggregaatti | 1...n | ||
| 5 | Description | Merkkijono | 1 | Hintaryhmän kuvaus | |
| 5 | Value | Numeerinen | 1 | Hintaryhmän arvo | |
| Attribuutti | type | Merkkijono | 1 | Arvon tyyppi, joko multiplier tai fixed |
Rakenteellisten tuotteiden tuotekuvien nouto
Resurssi: webshopproductimages.nv
Hakee tuotteen kuvan. Jos tuotteella on variantteja, resurssi palauttaa niiden kaikkien kuvat.
Kutsussa käytettävät parametrit:
| Parametri | Ilmentymiä | Esimerkki | Kuvaus |
| identifier | 1 | 123 | Tuoteen Netvisor-avain jonka kuvat halutaan hakea |
| NetvisorKeyList | 0...1 | 1,2,3 | Palauttaa yhdessä pyynnössä täydet tiedot kaikista halutuista tuotteista, max. 500 ID:tä |
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Kuvaus | Esimerkki |
| Root | root | Aggregaatti | 1 | ||
| 1 | WebShopProductImages | Aggregaatti | 1 | ||
| 2 | WebShopProductImage | Aggregaatti | 0...n | ||
| 3 | MimeType | Merkkijono | 1 | Kuvan MIME-tyyppi | image/jpg |
| 3 | Title | Merkkijono | 1 | Kuvan otsikko | Image |
| 3 | FileName | Merkkijono | 1 | Kuvan alkuperäinen tiedostonimi | image.jpg |
| 3 | DocumentData | Merkkijono(base64) | 1 | Kuvan data Base64-enkoodattuna |
Tuotesaldojen nouto varastoittain
Resurssi: inventorybywarehouse.nv
InventoryByWarehouse.nv-resurssin avulla voidaan noutaa Netvisorin rajapinnan kautta tuotteiden saldot varastokohtaisesti. Mikäli tarvitaan tarkempia tietoja tuotteista, ne voidaan noutaa käyttäen toimintoa Tuotetietojen nouto.
Netvisorin varastonhallintaan liittyviä ohjeita löydät täältä.
Pyynnössä käytettävät parametrit, joilla voidaan rajata tulosjoukkoa. Parametri välitetään QueryStringissä.
| Parametrin nimi | Ilmentymiä | Esimerkki | Kuvaus |
| productid | 0...1 | 123 | Rajaus tietyllä tuote-id:llä (NetvisorKey) |
| productidlist | 0...1 | 123,456,235 | Rajaus annetuilla tuote-id:illä (NetvisorKey), erottimena pilkku |
| inventoryplaceid | 0...1 | 321 | Rajaus annetulla varasto-id:llä |
| inventoryplacename | 0...1 | varasto5 | Rajaus annetulla varaston nimellä |
| limitvendorid | 0...1 | 105 | Rajaus annetulla toimittaja-id:llä |
| changedsince | 0...1 | 1.5.2014 12:00:00 | Rajaus annetun ajankohdan jälkeen tapahtuneiden muutosten mukaan |
| limitunderalertlimit | 0...1 | 1 | 1 = palautetaan vain hälytysrajan alittaneet tuotteet |
| productgroupname | 0...1 | esimerkkituotteet | Rajaus tuoteryhmällä |
Esimerkki pyynnöstä: http://integrationdemo.netvisor.fi/InventoryByWarehouse.nv?inventoryplaceid=321&limitunderalertlimit=1 (noudetaan kaikki hälytysrajan alittaneet tuotteet varastosta, jonka id on 321).
Vastaus:
| Taso | Elementti | Muoto | Ilmentymiä | Esimerkki | Kuvaus |
| Root | root | 1 | |||
| 1 | InventoryByWarehouse | 1 | |||
| 2 | Product | 0...n | |||
| 3 | NetvisorKey | Numeerinen | 1 | 165 | Tuotteen tietokannan id Netvisorissa. Voidaan käyttää myöhemmin esimerkiksi tuotteen kaikkien tietojen hakuun tai tuotteen linkittämiseen laskulle |
| 3 | Name | Merkkijono | 1 | Testituote | Tuotenimike |
| 3 | Code | Merkkijono | 1 | TT | Tuotekoodi |
| 3 | GroupName | Merkkijono | 1 | Kampanjatuotteet | Tuotteen tuoteryhmä tekstinä |
| 3 | ProductUri | Merkkijono | 1 | http://koulutus.netvisor.fi/getproduct.nv?id=165 | URI, josta voi hakea rajapinnan läpi tuotteen täydelliset tiedot |
| 3 | Warehouse | Aggregaatti | |||
| 4 | NetvisorKey | Numeerinen | 1 | 12 | Varaston tietokantaid Netvisorissa |
| 4 | Name | Merkkijono | 1 | Päävarasto | Varaston nimi |
| 4 | ReservedAmount | Numeerinen | 1 | 10,00 | Varattu kyseisestä varastosta |
| 4 | OrderedAmount | Numeerinen | 1 | 15,00 | Tilattu kyseisestä varastosta |
| 4 | InventoryAmount | Numeerinen | 1 | 34,00 | Tuotteen avoin varastosaldo kyseisessä varastossa |
| 3 | TotalReservedAmount | Numeerinen | 1 | 524,00 | Tuotteen varattu-saldo mukaan lukien kaikki varastot |
| 3 | TotalOrderedAmount | Numeerinen | 1 | 125,00 | Tuotteen tilattu-saldo mukaan lukien kaikki varastot |
| 3 | TotalAmount | Numeerinen | 1 | 647,00 | Tuotteen varastossa-saldo mukaan lukien kaikki varastot |
Resurssi: warehouseevent.nv
WarehouseEvent.nv-resurssin avulla voidaan tuoda Netvisoriin yksittäinen varastotapahtuma.
Netvisorin varastonhallintaan liittyviä ohjeita löydät täältä.
Tuotavat tiedot lähetetään kutsun mukana oheisen kuvauksen mukaisena xml:nä (POST-data):
| Taso | Elementti | Ilmentymiä | Muoto | Kuvaus | Esimerkki |
| Root | root | 1 | |||
| 1 | warehouseevent | 1 | |||
| 2 | description | 0...1 | Merkkijono | Varastotapahtuman kuvausteksti | Testitapahtuma |
| 2 | reference | 1 | Merkkijono | Varastotapahtuman viite | 1070 |
| 2 | deliverymethod | 0...1 | Merkkijono | Toimitustapa, toimitustapoja hallitaan Netvisorissa, tuotavan rivin täytyy täsmätä Netvisorissa olevan toimitustavan kanssa | Noudetaan |
| 2 | distributer | 0...1 | Merkkijono | Toimittajan tunniste | 110 |
| Attribuutti | type | 0...1 | Merkkijono | Toimittajan tunnisteen tyyppi, netvisor tai customer | netvisor |
| 2 | warehouseeventlines | 1 | |||
| 3 | warehouseeventline | 1...n | |||
| 4 | eventtype | 1 | Merkkijono | Varastotapahtuman tyyppi, tyyppejä hallitaan Netvisorissa, tuotavan rivin täytyy täsmätä Netvisorissa olevan tyypin kanssa | Myynti |
| Attribuutti | type | 0...1 | Merkkijono | Tapahtuman tyypitys, toistaiseksi aina customer | customer |
| 4 | product | 1 | Merkkijono | Tuotteen tunniste,Netvisor avain tai tuotekoodi | 32154 |
| Attribuutti | type | 0...1 | Merkkijono | Tunnisteen tyyppi, netvisor tai customer | netvisor |
| 4 | inventoryplace | 0...1 | Merkkijono | Varaston nimi, varastoja hallitaan Netvisorissa, tuotavan rivin täytyy täsmätä Netvisotissa olevan varaston kanssa | Päävarasto |
| 4 | description | 0...1 | Merkkijono | Varastotapahtumarivin kuvaus | Testitapahtuman ensimmäinen rivi |
| 4 | quantity | 1 | Numeerinen | Tuotteiden kappalemäärä | 12 |
| 4 | unitprice | 1 | Numeerinen | Tuotteen yksikköhinta verottomana | 100,00 |
| 4 | valuedate | 1 | Päivämäärä | Varastotapahtuman päiväys | 2014-05-13 |
| Attribuutti | format | 1 | Merkkijono | Päiväyksen tyyppi, aina ansi | ansi |
| 4 | status | 1 | Merkkijono | Varastotapahtuman tila | open |