Product managing functions are divided into following:
| Integration | HTTP-method | Resource | DTD | Example |
| Get a product list | GET | productlist.nv | Download | |
| Get product details | GET | getproduct.nv | Download | |
| Import product details | POST | product.nv | product.dtd | Download |
| Get a structural product list | GET | webshopproductlist.nv | Download | |
| Get structural product images | GET | webshopproductimages.nv | Download | |
| Get inventory by warehouse | GET | inventorybywarehouse.nv | Download | |
| Import warehouse event | POST | warehouseevent.nv | warehouseevent.dtd | Download |
Resource: productlist.nv
List of products from Netvisor can be retrieved as described below. List contains basic information of each product. Details of each product can be retrieved one by one by using Get product details request.
Querystring parameters:
| Parameter name | Occurs | Description | Example |
| changedsince | 0...1 | Filters result to contain only products having change after given date, date in format YYYY-MM-DD | 2012-01-01 |
| keyword | 0...1 | Filters result to products that include given text / value in product name or product code | 1,2,3,4 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | ProductList | Aggr | 1 | ||
| 2 | Product | Aggr. | 0...n | ||
| 3 | NetvisorKey | Numeric | 1 | Product identifier in Netvisor | 123 |
| 3 | ProductCode | Text | 1 | Code of the product | A54 |
| 3 | Name | Text | 1 | Name of the product | The product |
| 3 | UnitPrice | Numeric | 1 | Unit net price of product, 12 decimal | 1,960000000000 |
| 3 | UnitGrossPrice | Numeric | 1 | Unit gross price of product, 12 decimal | 2,430400000000 |
| 3 | ProductGroupID | Numeric | 1 | Product group ID. Can be empty. | 2 |
| 3 | ProductGroupDescription | Text | 1 | Product group, whole hierarchy. Can be empty. | Books / Science fiction books |
| 3 | Uri | Text | 1 | URI which can be used to retrieve details of the product | /getproduct.nv?id=123 |
Resource: getproduct.nv
Before retrieving product information, a list of products must be requested to pick the identifier of the wanted product. Specific product information of one product can be retrieved with the Netvisor key. Using parameters idlist or codelist, specific product information of max 400 products can be retreived.
Querystring parameters:
| Parameter name | Occurs | Description | Example |
| id | 0...1 | Netvisor key of the wanted product | 123 |
| idlist | 0...1 | Can be used to get the details of several products with given ID. Max. 400 identifiers. | 1,2,3 |
| eancode | 0...1 | EAN-code of the wanted product | 123456789012 |
| code | 0...1 | Product code of the wanted product | 123 |
| codelist | 0...1 | Returns full information of all the wanted products using product code as the identifier | 1,2,product |
| showsubproducts | 0...1 | If 1, returns all the sub products as well | 1 |
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | Product | Aggr | 1 | ||
| 2 | ProductBaseInformation | Aggr. | 0...n | ||
| 3 | NetvisorKey | Numeric | 1 | Netvisor key of the product | |
| 3 | ProductCode | Text | 1 | Product code | CC |
| 3 | ProductGroup | Text | 1 | Product group's name | Books |
| 3 | Name | Text | 1 | Product's name | Code Complete |
| 3 | Description | Text | 1 | Description | Second edition |
| 3 | UnitPrice | Numeric | 1 | Net price of a single unit | 42,5 |
| Attr. | type | Text | 1 | Always net | net |
| 3 | UnitGrossPrice | Numeric | 1 | Gross price of a single unit | 52,7 |
| Attr. | type | Text | 1 | Always gross | gross |
| 3 | Unit | Text | 1 | Unit of measurement | pc |
| 3 | UnitWeight | Numeric | 1 | Weight of a single unit. | 1 |
| 3 | PurchasePrice | Numeric | 1 | Purchase price of a single unit | 25 |
| 3 | TariffHeading | Text | 1 | Tariff heading | Code Complete |
| 3 | ComissionPercentage | Numeric | 1 | Commission | 11 |
| 3 | IsActive | Numeric | 1 | Is product active: 0 = no, 1 = yes | 1 |
| 3 | IsSalesProduct | Numeric | 1 | Is this a sales product: 0 = no, 1 = yes | 0 |
| 3 | countryoforigin | Text | 1 | Country of origin | FI |
| Attr. | type | Text | 1 | Always ISO-3166 | ISO-3166 |
| 2 | ProductBookkeepingDetails | Aggr. | 1 | ||
| 3 | DefaultVatPercent | Numeric | 1 | VAT rate | 22 |
| 3 | DefaultDomesticAccountNumber | Numeric | 1 | Domestic account number by default | |
| 3 | DefaultEuAccountNumber | Numeric | 1 | EU area account number by default | |
| 3 | DefaultOutsideEuAccountNumber | Numeric | 1 | International account number by default | |
| 3 | ProductDimensions | Aggr. | 1 | ||
| 4 | Dimension | Aggr. | 1...n | ||
| 5 | DimensionName | Text | 1 | Name of the dimension | Animals |
| Attr. | Netvisorkey | Numeric | 1 | ||
| 5 | DimensionItem | Text | 1 | Name of the dimension item | Dogs |
| Attr. | Netvisorkey | Numeric | 1 | ||
| 2 | ProductInventoryDetails | Aggr. | 1 | ||
| 3 | InventoryAmount | Numeric | 1 | Amount in storage | 2,00 |
| 3 | InventoryMidPrice | Numeric | 1 | Average price | 5,00 |
| 3 | InventoryValue | Numeric | 1 | Inventory value: amount in storage * average price | 10,0000 |
| 3 | InventoryReservedAmount | Numeric | 1 | Amount reserved | 1,00 |
| 3 | InventoryOrderedAmount | Numeric | 1 | Amount ordered | 0,00 |
| 3 | InventoryAccountNumber | Numeric | 1 | Storage account | 1521 |
| 2 | ProductAdditionalInformation | Aggr. | 1 | ||
| 3 | ProductNetWeight | Numeric | 1 | Net weight | 11,20 |
| Attr. | weightunit | Text | 1 | Unit of net weight: g, kg or t | kg |
| 3 | ProductGrossWeight | Numeric | 1 | Gross weight | 12,60 |
| Attr. | weightunit | Text | 1 | Unit of gross weight: g, kg or t | kg |
| 3 | ProductPackageInformation | Aggr. | 1 | ||
| 4 | PackageWidth | Numeric | 1 | Package width in centimeters | 7,30 |
| Attr. | unit | Text | 1 | Package width unit | cm |
| 4 | PackageHeight | Numeric | 1 | Package height in centimeters | 15,00 |
| Attr. | unit | Text | 1 | Package height unit | cm |
| 4 | PackageLength | Numeric | 1 | Package lenght in centimeters | 36,10 |
| Attr. | unit | Text | 1 | Package lenght unit | cm |
| 3 | PrimaryEanCode | Numeric | 1 | Primary EAN code of the product | 123456789012 |
| 3 | SecondaryEanCode | Numeric | 1 | Secondary EAN code of the product | 555444332221 |
| 2 | SubProductInformation | Aggr. | 1 | ||
| 3 | Parents | Aggr | 1 | Parent products | |
| 4 | Product | Aggr | 0...n | ||
| 5 | Netvisorkey | Numeric | 1 | Netvisor key of the parent product | 748 |
| 5 | Amount | Numeric | 1 | Amount of product | 1 |
| 5 | PurchasePriceChange | Numeric | 1 | Purchase price change | 5,50 |
| 5 | UnitPriceChange | Numeric | 1 | Unit price change | 5,50 |
| 3 | Children | Aggr | 1 | Sub products | |
| 4 | Product | Aggr | 0...n | ||
| 5 | Netvisorkey | Numeric | 1 | Netvisor key of the subproduct | 789 |
| 5 | Amount | Numeric | 1 | Amount of products | 1 |
| 5 | PurchasePriceChange | Numeric | 1 | Purchase price change | 5,50 |
| 5 | UnitPriceChange | Numeric | 1 | Unit price change | 5,50 |
Importing data trough the interface is not supported for extended product management.
Resource: product.nv
Querystring parameters:
| Parameter name | Occurs | Description | Example |
| method | 1 | Add or Edit | Add |
| id | 0-1 | Must be included if Method = Edit, defines the product to update | 123 |
If method has not been set or the product to be updated is not found with the id, an INVALID_DATA -error with further details is returned. The id for the product to be update can be obtained with the Get a Product list resource.
The data to import is sent with the request as an XML with the following structure:
| Level | Element name | Type and length | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | product | Aggr | 1 | ||
| 2 | productbaseinformation | Aggr. | 1 | ||
| 3 | productcode | Text | 0...1 | Product code | CC |
| 3 | productgroup | Text | 1 | Product is added to the group if it exist. If it doesn't, it will be created | Books |
| 3 | name | Text | 1 | Name of the product | Code Complete |
| 3 | description | Text | 0...1 | Description of the product | Second edition |
| 3 | unitprice | Numeric | 1 | Price of a single unit | 42,5 |
| Attr. | type | Text | 1 | net or gross | net |
| 3 | unit | Text | 0...1 | Unit of measurement, existing is used if found, otherwise new one is created | pc |
| 3 | purchaseprice | Numeric | 0...1 | Purchase price of a single unit | 25 |
| 3 | tariffheading | Text | 0...1 | Tariff heading of the unit | Code Complete |
| 3 | comissionpercentage | Numeric | 0...1 | Commission percentage of the unit | 11 |
| 3 | isactive | Numeric | 1 | Is product active: 0 = no, 1 = yes | 1 |
| 3 | issalesproduct | Numeric | 1 | Is this a sales product: 0 = no, 1 = yes | 1 |
| 3 | inventoryenabled | Numeric | 0...1 | Is the product in storage: 0 = no, 1 = yes | 1 |
| 3 | countryoforigin | Text | 0...1 | Country of origin | FI |
| Attr. | type | Text | 0...1 | Always ISO-3166 | ISO-3166 |
| 2 | productbookkeepingdetails | Aggr. | 0...1 | ||
| 3 | defaultvatpercentage | Numeric | 1 | Vat class, if class is not found, an error is returned | 22 |
| 3 | defaultdomesticaccountnumber | Numeric | 0...1 | Default domestic bookkeeping account number | 3000 |
| 3 | defaulteuaccountnumber | Numeric | 0...1 | Default EU bookkeeping account number | 3360 |
| 3 | defaultoutsideeuaccountnumber | Numeric | 0...1 | Default outside EU bookkeeping account number | 3380 |
| 2 | productadditionalinformation | Aggr. | 0...1 | ||
| 3 | productnetweight | Numeric | 0...1 | Net weight | 11,2 |
| 3 | productgrossweight | Numeric | 0...1 | gross weight | 12,6 |
| 3 | productweightunit | Numeric | 0...1 | net and gross weight unit: g, kg, tn | kg |
| 3 | productpackageinformation | Aggr. | 0...1 | ||
| 4 | packagewidth | Numeric | 1 | Package width in centimeters | 7,3 |
| 4 | packageheight | Numeric | 1 | Package height in centimeters | 15,0 |
| 4 | packagelength | Numeric | 1 | Package length in centimeters | 36,1 |
| 3 | dimension | Aggr. | 0...1 | ||
| 4 | dimensionname | Text | 1 | Default dimension header name. Created if needed. | Project |
| 4 | dimensionitem | Text | 1 | Defauld dimension name. Created if needed. | Project 1 |
Resource: webshopproductlist.nv
Used to retrieve a structural list of products. This resource can only be used if extended product management is in use. List contains information of products like name and description in different languages, and information on the variants of the product.
Querystring parameters:
| Parameter name | Occurs | Description | Example |
| limitDeleted | 0...1 | When defined, only active main products are included in result | 1 |
| limitActive | 0...1 | When defined, only active products are included in result | 1 |
| limitPublished | 0...1 | When defined, only published products are included in result | 1 |
| limitSellable | 0...1 | When defined, only sellable products are included in result | 1 |
| limitChangedSince | 0...1 | When defined, only products edited since given day are included in result | 2016-01-28 |
| limitSourceProductNetvisorKey | 0...1 | Limits result by given source product key in Netvisor | 154 |
| limitshownonwebshopproducts | 0...1 | Limits result set by containing only products to show in webshop | 45 |
Response:
| Level | Element Name | Type and length | Occurs | Description | Example |
| 1 | WebShopProductList | Aggr. | 1 | ||
| 2 | WebShopProduct | Aggr. | 0...n | ||
| 3 | NetvisorKey | Numeric | 1 | Product identifier in Netvisor | 145 |
| 3 | Name | Text | 1...3 | Name of the product | The Product |
| Attr. | language | Text | Language of the name: FI, EN or SE | FI | |
| 3 | Description | Text | 1...3 | Description of the product | this is a product |
| Attr. | language | Text | Language of the description: FI, EN or SE | FI | |
| 3 | ProductCode | Text | 1 | Product code | A123 |
| 3 | ProductGroup | Aggr. | 0...n | ||
| 4 | Name | Text | 1...3 | Name of the product group | Group 1 |
| Attr. | language | Text | Language of the product group name: FI, EN or SE | FI | |
| 3 | UnitNetPrice | Numeric | 1 | Price of a single unit | 12,00 |
| 3 | UnitGrossPrice | Numeric | 1 | Gross price of the unit | 14,64 |
| 3 | Unit | Text | 1 | Unit of measurement | pc |
| 3 | UnitWeight | Numeric | 1 | Weight of a single unit | 1,50 |
| 3 | ImageURI | Text | 1 | URI for an image for the product | /webshopproductimages.nv? identifier=165 |
| 3 | URI | Text | 1 | Uri for retrieving full product information | /getproduct.nv?id=165 |
| 3 | InventoryAmount | Numeric | 1 | Amount of unit in inventory | 30,00 |
| 3 | InventoryOrderedAmount | Numeric | 1 | Amount of ordered units | 1,00 |
| 3 | InventoryReservedAmount | Numeric | 1 | Amount of reserved units | 5,00 |
| 3 | IsActive | Numeric | 1 | Is the product active: 0 = no, 1 = yes | 1 |
| IsSalesProduct | Numeric | 1 | Is this a sales product: 0 = no, 1 = yes | 1 | |
| 3 | IsStorageProduct | Numeric | 1 | Is this product in storage: 0 = no, 1 = yes | 1 |
| 3 | DefaultVatPercentage | >Numeric | 1 | VAT rate | 22 |
| 3 | IsPublished | Numeric | 1 | Has the product been published: 0 = no, 1 = yes | 1 |
| 3 | VersionNumber | Numeric | 1 | Version number of the product | |
| 3 | PrimaryEANCode | Numeric | 1 | 978020137962 | |
| 3 | SecondaryEANCode | Numeric | 1 | 978020137963 | |
| 3 | PriceGroups | Aggr. | 0...1 | ||
| 4 | PriceGroup | Aggr. | 1...n | ||
| 5 | Description | Text | 1 | Description of the price group | CA1 |
| 5 | Value | Numeric | 1 | Value of the price group | 1,5 |
| Attr. | type | Text | 1 | Type of value, multiplier or fixed | multiplier |
| 3 | Variants | Aggr. | 1 | ||
| 4 | Variant | Aggr. | 0...n | ||
| 5 | Name | Text | 1...3 | Name of the variant | Shirt, Red |
| Attr. | language | Text | Language of variant name: FI, EN or SE | FI | |
| 5 | Description | Text | 1...3 | Description of variant | A red shirt |
| Attr. | language | Text | Language of variant description: FI, EN or SE | FI | |
| 5 | VariantIdentifier | Text | 1 | Identifier of the product variant in Netvisor | ABC002 |
| 5 | ImageUri | Text | 1 | Uri of the product variant image | /webshopproductimages.nv? identifier=165 |
| 5 | LastchangeDate | Date | 1 | Timestamp when the product variant is modified | 30.1.2014 10:12:06 |
| 5 | UnitNetPrice | Numeric | 1 | Net price of the product variant | 12,00 |
| 5 | UnitGrossPrice | Numeric | 1 | Gross price of the product variant | 14,62 |
| 5 | InventoryAmount | Numeric | 1 | Amount of variants in inventory | 35,00 |
| 5 | InventoryOrderedAmount | Numeric | 1 | Amount of variants ordered | 12,00 |
| 5 | InventoryReservedAmount | Numeric | 1 | Amount of variants ordered | 1,00 |
| 5 | PrimaryEANCode | Numeric | 1 | 978020137962 | |
| 5 | SecondaryEANCode | Numeric | 1 | 978020137963 | |
| 5 | PriceGroups | Aggr. | 0...1 | ||
| 6 | PriceGroup | Aggr. | 1...n | ||
| 7 | Description | Text | 1 | Description of the variant's price group | |
| 7 | Value | Numeric | 1 | Value of the price group | |
| Attr. | type | Text | 1 | Type of value, multiplier | multiplier |
| 5 | VariantProperties | Aggr. | 0...n | ||
| 6 | VariantProperty | Text | 1 | Product attribute | Material |
| 6 | VariantPropertyValue | Text | 1 | Product attribute value | Cotton |
| 3 | CustomTag | Aggr. | 0...n | Product additional information field | |
| 4 | CustomTagName | Text | 1 | Field name | Additional information |
| 4 | CustomTagValue | Text | 1 | Field value | Field 1 |
Resource: webshopproductimages.nv
Will get products first picture. If product has variants, recourse will return all pictures of variant.
Querystring parameters:
| Parameter name | Occurs | Description | Example |
| identifer | 1 | Identifier of product which images to get | 123 |
| NetvisorKeyList | 0...1 | Filter search with several ID's (Netvisor key), separated with comma. Max. 400 identifiers | 1,2,3 |
Response:
| Level | Element Name | Type and length | Occurs | Description | Example |
| 1 | WebShopProductImages | Aggr. | 1 | ||
| 2 | WebShopProductImage | Aggr. | 0...n | ||
| 3 | MimeType | Text | 1 | Image MIME type | image/jpg |
| 3 | Title | Text | 1 | Title of the image | Image |
| 3 | FileName | Text | 1 | File name of the image | image.jpg |
| 3 | DocumentData | Base64 | 1 | Image data in Base64 encoded string |
Resource: inventorybywarehouse.nv
This resource allows retrieving product inventory for each warehouse. If detailed information about a product is needed, they can be retrieved with Get product details.
Querystring parameters:
| Parameter | Occurs | Description | Example |
| productid | 0...1 | Filter search with productid (Netvisor key) | 123 |
| productidlist | 0...1 | Filter search with several product id's (Netvisor key), separated with comma | 123,456,789 |
| inventoryplaceid | 0...1 | Filter with inventory ID | 321 |
| inventoryplacename | 0...1 | Filter with inventory name | warehouse 5 |
| limitvendorid | 0..1 | Filter with vendor's ID | 105 |
| changedsince | 0...1 | Filter to changes since the time given | 1.5.2014 12:00:00 |
| limitunderalertlimit | 0...1 | 1 = return only products under alert limit | 1 |
| productgroupname | 0...1 | Limit search to given product group | example group |
Example query:
https://isvapi.netvisor.fi/InventoryByWarehouse.nv?inventoryplaceid=321&limitunderalertlimit=1
(retrieve products under alert limit from inventory with id 321)
Response:
| Level | Element name | Type and length | Occurs | Description | Example |
| root | Root | ||||
| 1 | InventoryByWarehouse | Aggr. | 1 | ||
| 2 | Product | Aggr. | 0-n | ||
| 3 | NetvisorKey | Numeric | 1 | Product's ID in the database, can be used to retrieve full product information or to link the product to an invoice | 165 |
| 3 | Name | Text | 1 | Product name | Test product |
| 3 | Code | Text | 1 | Product's code | TT |
| 3 | GroupName | Text | 1 | Productgroup | campaign products |
| 3 | ProductUri | Text | 1 | URI for retrieving full product information | /getproduct.nv?id=165 |
| 3 | Warehouse | Aggr. | |||
| 4 | NetvisorKey | Numeric | 1 | Warehouse's ID | 12 |
| 4 | Name | Text | 1 | Warehouse's name | Main warehouse |
| 4 | ReservedAmount | Numeric | 1 | Amount reserved from this warehouse | 10,00 |
| 4 | OrderedAmount | Numeric | 1 | Amount ordered to this warehouse | 15,00 |
| 4 | InventoryAmount | Numeric | 1 | Amount of product in this warehouse | 34,00 |
| 3 | TotalReservedAmount | Numeric | 1 | Amount of reserved from all warehouses | 524,00 |
| 3 | TotalOrderedAmount | Numeric | 1 | Amount ordered from all warehouses | 125,00 |
| 3 | TotalAmount | Numeric | 1 | Amount of product in all warehouses | 647,00 |
Resource: warehouseevent.nv
This resource allows importing a single warehouse event into Netvisor.
The data to import is included in the query as an XML with following structure:
| Level | Element | Type | Occurs | Description | Example |
| Root | root | Aggr. | 1 | ||
| 1 | warehouseevent | Aggr. | 1 | ||
| 2 | description | Text | 0...1 | Description of the event | Test event |
| 2 | reference | Text | 1 | Reference number of the event | 1070 |
| 2 | deliverymethod | Text | 0...1 | Method of delivery, delivery methods are controlled in Netvisor, imported line must match with one in Netvisor | Pick up |
| 2 | distributer | Text | 0...1 | ID or name of the distributor | 110 |
| Attr. | type | Text | 0...1 | Attribute type: - netvisor = NetvisorKey of the distributor - customer = Name of the distributor | netvisor |
| 2 | warehouseeventlines | Aggr. | 1 | ||
| 3 | warehouseeventline | Aggr. | 1...n | ||
| 4 | eventtype | Text | 1 | Type of the warehouse event, warehouse events are controlled in Netvisor, imported line must match with one in Netvisor | Sale |
| Attr. | type | Text | 0...1 | Type of the event, for now, always "customer" | customer |
| 4 | product | Text | 1 | Id of the product, netvisor-key or product code | 32154 |
| Attr. | type | Text | 0...1 | Type of product id, "netvisor" or "customer" | netvisor |
| 4 | inventoryplace | Text | 0...1 | Name of the warehouse, warehouses are controlled in Netvisor, imported line must match with one in Netvisor | Main warehouse |
| 4 | description | Text | 0...1 | Description of the warehouse event line | |
| 4 | quantity | Numeric | 1 | Amount of products | 12 |
| 4 | unitprice | Numeric | 1 | Price of a single unit, always imported as net price | 100,00 |
| 4 | valuedate | Date | 1 | Date of the warehouse event. | 2014-05-13 |
| Attr. | format | Text | 1 | Always ansi | ansi |
| 4 | status | Text | 1 | Status of the warehouse event | open |
Oliko tästä vastauksesta apua? Kyllä Ei
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.