Product managing functions are divided into following:
Integration | HTTP-method | Resource | DTD | Example | |
Get product list | GET | productlist.nv | Download | ||
Get product details | GET | getproduct.nv | Download | ||
Get product groups | GET | getproductgroups.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 | ||
Get inventory places | GET | getinventoryplaces.nv | Download | ||
Import warehouse event | POST | warehouseevent.nv | warehouseevent.dtd | Download | |
Get warehouse report | GET | warehousereport.nv | Download | ||
Get product attachments | GET | getproductattachment.nv | Download | ||
Get product images | GET | getproductimage.nv | Download | ||
Get extended product list | GET | extendedproductlist.nv | Download |
Get product list
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 changed after given time, time in format yyyy-MM-ddTHH:mm:ss | 2012-01-01T 12:00:00 |
keyword | 0...1 | Filters result to products that include given text / value in product name or product code. | 1,2,3,4 |
You can use one or many parameters simultaneously in our request. | |||
published | 0...1 | Value 1 if published products are wanted in the response and 0 if not. | 1 |
unpublished | 0...1 | Value 1 if unpublished products are wanted in the response and 0 if not. | 1 |
deleted | 0...1 | Value 1 if deleproducts are wanted in the response and 0 if not. If the parameter is not given, deleted products are returned. If given, also published or unpublished should be given. | 0 |
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 | String | 1 | Code of the product | A54 |
3 | Name | String | 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 | String | 1 | Product group, whole hierarchy. Can be empty. | Books / Science fiction books |
3 | Uri | String | 1 | URI which can be used to retrieve details of the product | /getproduct.nv?id=123 |
Get Product details
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 |
replyoption | 0...1 | If 1, returns only active (not-deleted) products If 2, returns only published (including deleted, but published) products If 3, returns only active products | 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 | String | 1 | Product code | CC |
3 | ProductGroup | String | 1 | Product group's name | Books |
3 | Name | String | 1 | Product's name | Code Complete |
3 | Description | String | 1 | Description | Second edition |
3 | UnitPrice | Numeric | 1 | Net price of a single unit | 42,5 |
Attr. | type | String | 1 | Always net | net |
3 | UnitGrossPrice | Numeric | 1 | Gross price of a single unit | 52,7 |
Attr. | type | String | 1 | Always gross | gross |
3 | Unit | String | 1 | Unit of measurement | pc |
3 | UnitWeight | Numeric | 1 | Weight of a single unit. NB element is expired, please use element ProductNetWeight instead | 1 |
3 | PurchasePrice | Numeric | 1 | Purchase price of a single unit | 25 |
3 | TariffHeading | String | 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 | String | 1 | Country of origin | FI |
Attr. | type | String | 1 | Always ISO-3166 | ISO-3166 |
2 | ProductBookkeepingDetails | Aggr. | 1 | ||
3 | DefaultVatPercent | Numeric | 1 | VAT rate | 24 |
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 | String | 1 | Name of the dimension | Animals |
Attr. | Netvisorkey | Numeric | 1 | ||
5 | DimensionItem | String | 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 | String | 1 | Unit of net weight: g, kg or t | kg |
3 | ProductGrossWeight | Numeric | 1 | Gross weight | 12,60 |
Attr. | weightunit | String | 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 | String | 1 | Package width unit | cm |
4 | PackageHeight | Numeric | 1 | Package height in centimeters | 15,00 |
Attr. | unit | String | 1 | Package height unit | cm |
4 | PackageLength | Numeric | 1 | Package lenght in centimeters | 36,10 |
Attr. | unit | String | 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 |
Get product groups
Resource: getproductgroups.nv
List of product groups from Netvisor can be retrieved as described below.
QueryString parameters:
Parameter name | Occurs | Desciption | Example |
replyoptions | 0...1 | Include product hierarchy in response, 1 or 0 | 1 |
searchlanguage | 0...1 | Search languae, FI, SE or EN | EN |
productgroupnamekeyword | 0...1 | Keyword from the retreived product group's name | Example |
productgroupnetvisorkeys | 0...1 | List of product group NetvisorKey values separated by comma. Can also have one value. | 4 |
productgroupnamefreetext | 0...1 | Hierarchy name of the product group includes the given parameter | Example |
Response:
Level | Element Name | Type and length | Occurs | Description | Example |
Root | root | Aggr. | 1 | ||
1 | ProductGroups | Aggr. | 1 | ||
2 | ProductGroup | Aggr. | 1...n | ||
3 | NetvisorKey | Numeric | 1 | Product group Netvisor-id | 16 |
3 | ProductGroupNameTranslations | Aggr. | 1 | ||
4 | Translation | String | 1...3 | Product group name | Example product group |
Attr. | Language | String | 1...3 | Language of the product group name | FI |
4 | ProductGroupDescriptionTranslations | Aggr. | 1 | ||
5 | Translation | String. | 1...3 | Product group description | Example description |
Attr. | Language | String | 1...3 | Language of the product group description | EN |
4 | ProductGroupHierarchy | Aggr. | 1 | ||
5 | ProductGroupHierarchyNameTranslations | Aggr. | 1 | ||
6 | Translation | String | 1...3 | Product group hierarchy | Example product group / Product group |
Attr. | Language | String | 1...3 | Language of the product group hierarchy | EN |
5 | ParentGroupNetvisorKey | Numeric | 1 | Parent product group Netvisor-id. Can also be empty. | 18 |
5 | ChildGroups | Aggr. | 1 | ||
6 | NetvisorKey | Numeric | 0...n | Child group Netvisor-id:s | 12 |
Import product details
Resource: product.nv
Importing data trough the interface is not supported for extended product management.
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 | String | 0...1 | Product code | CC |
3 | productgroup | String | 1 | Product is added to the group if it exist. If it doesn't, it will be created | Books |
3 | name | String, max 200 characters | 1 | Name of the product | Code Complete |
3 | description | String | 0...1 | Description of the product | Second edition |
3 | unitprice | Numeric | 1 | Price of a single unit | 42,5 |
Attr. | type | String | 1 | net or gross | net |
3 | unit | String, max 50 characters | 0...1 | Unit of measurement, existing is used if found, otherwise new one is created | pc |
3 | unitweight | Numeric | 0...1 | Product unit weight with two decimals | 1,00 |
3 | purchaseprice | Numeric | 0...1 | Purchase price of a single unit | 25 |
3 | tariffheading | String | 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 | inventorybatchlinkingmode | Numeric | 0...1 | Product's batch processing type. Possible values: No batch processing = 1 Manual batch selection = 2 Newest first by delivery date = 3 Oldest first by delivery date = 4 (FIFO) Newest first by use-by date = 5 Oldest first by yse-by date = 6 Newest first by manufacturing date = 7 Oldest first by manufacturing date = 8 | 4 |
3 | countryoforigin | String | 0...1 | Country of origin | FI |
Attr. | type | String | 0...1 | Always ISO-3166 | ISO-3166 |
3 | primaryeancode | String | 0...1 | Product's primary EAN-code | 123456789012 |
Attr. | type | String | 0...1 | Type of the EAN-code. any, ean8, ean13, code128. | ean13 |
3 | secondaryeancode | String | 0...1 | Product's secondary EAN-code | 123456789012 |
Attr | type | String | 0...1 | Type of the EAN-code. any, ean8, ean13, code128. | ean13 |
3 | inventoryalertlimit | Numeric | 0...1 | Product's balance alert | 20,50 |
2 | productbookkeepingdetails | Aggr. | 0...1 | ||
3 | defaultvatpercentage | Numeric | 1 | Vat class, if class is not found, an error is returned | 24 |
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 | dimension | Aggr. | 0...1 | ||
4 | dimensionname | String | 1 | Default dimension header name. Created if needed. | Project |
4 | dimensionitem | String | 1 | Default dimension name. Created if needed. | Project 1 |
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 | productcustomtags | Aggr. | 0...1 | ||
4 | productcustomtag | Aggr. | 1...n | Product additional information field | |
5 | tagname | String | 1 | Field name | Date field |
5 | tagvalue | String | 1 | Field value | 2022-01-01 |
Attr. | datatype | String | 1 | Field type. date, text, decimal or enum | date |
Get structural product list
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 time are included in result. Time format yyyy-MM-ddTHH:mm:ss | 2016-01-28T12:00:00 |
limitSourceProductNetvisorKey | 0...1 | Limits result by given source product key in Netvisor | 154 |
productGroupNetvisorKeys | 0...1 | List of product group NetvisorKey values separated by comma. Can also have one value. | 7,20 |
productGroupName | 0...1 | Name of the retrieved product group. | Test product |
productGroupNameKeyword | 0...1 | Keyword from the retreived product group's name. | Test |
productGroupNameFreeText | 0...1 | Name of the retreived product group includes the given parameter value. | product |
excludeProductGroupNameFreeText | 0...1 | Name of the retreived product group doesn't include the given parameter value. | Test |
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 | String | 1...3 | Name of the product | The Product |
Attr. | language | String | Language of the name: FI, EN or SE | FI | |
3 | Description | String | 1...3 | Description of the product | this is a product |
Attr. | language | String | Language of the description: FI, EN or SE | FI | |
3 | ProductCode | String | 1 | Product code | A123 |
3 | ProductGroup | Aggr. | 0...n | ||
4 | Name | String | 1...3 | Name of the product group | Group 1 |
Attr. | language | String | 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 | String | 1 | Unit of measurement | pcs |
3 | UnitWeight | Numeric | 1 | Weight of a single unit | 1,50 |
3 | ImageURI | String | 1 | URI for an image for the product | /webshopproductimages.nv? identifier=165 |
3 | URI | String | 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 |
3 | 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 | 24 |
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 | String | 1 | Description of the price group | CA1 |
5 | Value | Numeric | 1 | Value of the price group | 1,5 |
Attr. | type | String | 1 | Type of value, multiplier or fixed | multiplier |
3 | Variants | Aggr. | 1 | ||
4 | Variant | Aggr. | 0...n | ||
5 | Name | String | 1...3 | Name of the variant | Shirt, Red |
Attr. | language | String | 1 | Language of variant name: FI, EN or SE | FI |
5 | Description | String | 1...3 | Description of variant | A red shirt |
Attr. | language | String | 1 | Language of variant description: FI, EN or SE | FI |
5 | VariantIdentifier | String | 1 | Identifier of the product variant in Netvisor | ABC002 |
5 | ImageUri | String | 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 | String | 1 | Description of the variant's price group | |
7 | Value | Numeric | 1 | Value of the price group | |
Attr. | type | String | 1 | Type of value, multiplier | multiplier |
5 | VariantProperties | Aggr. | 0...n | ||
6 | VariantProperty | String | 1 | Product attribute | Material |
6 | VariantPropertyValue | String | 1 | Product attribute value | Cotton |
3 | CustomTag | Aggr. | 0...n | Product additional information field | |
4 | CustomTagName | String | 1 | Field name | Additional information |
4 | CustomTagValue | String | 1 | Field value | Field 1 |
Get structural product images
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 |
identifier | 1 | Identifier of product which images to get | 123 |
Response:
Level | Element Name | Type and length | Occurs | Description | Example |
1 | WebShopProductImages | Aggr. | 1 | ||
2 | WebShopProductImage | Aggr. | 0...n | ||
3 | MimeType | String | 1 | Image MIME type | image/jpg |
3 | Title | String | 1 | Title of the image | Image |
3 | FileName | String | 1 | File name of the image | image.jpg |
3 | DocumentData | Base64 | 1 | Image data in Base64 encoded string |
Get inventory by warehouse
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 | Aggr. | |||
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 | String | 1 | Product name | Test product |
3 | Code | String | 1 | Product's code | TT |
3 | GroupName | String | 1 | Productgroup | campaign products |
3 | ProductUri | String | 1 | URI for retrieving full product information | /getproduct.nv?id=165 |
3 | Warehouse | Aggr. | |||
4 | NetvisorKey | Numeric | 1 | Warehouse's ID | 12 |
4 | Name | String | 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 |
Get inventory places
Resurssi: getinventoryplaces.nv
List of inventory places from Netvisor can be retrieved as described below.
QueryString parameters:
Parameter | Occurs | Description | Example |
inventoryplacelocationfreetext | 0...1 | Inventory location includes the given parameter | Example location |
inventoryplacedescriptionfreetext | 0...1 | Inventory description includes the given parameter | Example description |
inventoryplacenetvisorkeys | 0...1 | Inventory Netvisor-ID:s | 321 |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | Root | Aggr. | 1 | ||
1 | InventoryPlaces | Aggr. | 1 | ||
2 | InventoryPlace | Aggr. | 0...n | ||
3 | NetvisorKey | Numeric | 1 | Inventory Netvisor-ID | 165 |
3 | InventoryPlaceName | String | 1 | Inventory description, inventory location | Example location, Example description |
3 | InventoryPlaceEmailAddress | String | 1 | Inventory email-address | example@example.com |
3 | InventoryPlaceShelves | Aggr. | 1 | ||
4 | InventoryPlaceShelve | Aggr. | 0...n | ||
5 | NetvisorKey | Numeric | 1 | Netvisor-id of the inventory shelve | 12 |
5 | ShelveName | String | 1 | Inventory shelve name | Example shelve |
5 | ShelveHierarchy | Aggr. | 1 | ||
6 | ShelveHierarchyName | Numeric | 0...1 | Inventory shelve hierarchy | Shelve 1 / Shelve 2 |
Import warehouse event
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 | String | 0...1 | Description of the event | Test event |
2 | reference | String | 1 | Reference number of the event | 1070 |
2 | deliverymethod | String | 0...1 | Method of delivery, delivery methods are controlled in Netvisor, imported line must match with one in Netvisor | Pick up |
2 | distributer | String | 0...1 | ID or name of the distributor | 110 |
Attr. | type | String | 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 | String | 1 | Type of the warehouse event, warehouse events are controlled in Netvisor, imported line must match with one in Netvisor | Sale |
Attr. | type | String | 0...1 | Type of the event, for now, always "customer" | customer |
4 | product | String | 1 | Id of the product, netvisor-key or product code | 32154 |
Attr. | type | String | 0...1 | Type of product id, "netvisor" or "customer" | netvisor |
4 | inventoryplace | String | 0...1 | Name of the warehouse. Warehouses are controlled in Netvisor, imported line must match with one in Netvisor. Imported line can also be matched to the warehouse using warehouse NetvisorKey, when atrribute type = netvisor. | Main warehouse |
Attr. | type | String | 0...1 | Attribute type: - netvisor = NetvisorKey | netvisor |
4 | description | String | 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 | String | 1 | Always ansi | ansi |
4 | status | String | 1 | Status of the warehouse event | open |
Get warehouse report
This resource allows retrieving different kinds of warehouse reports, depending on the QueryString parameters.
QueryString parameters:
Parameter | Occurs | Description | Example |
report | 1 | Report: productinventoryamounts salesinventoryevents purchaseorderinventoryevents | salesinventoryevents |
Salesinventoryevents
When report=salesinventoryevents, also the following parameters can be used:
Parameter | Occurs | Description | Example |
page | 0...1 | Page, by default 1 | 1 |
salesentitiesonpage | 0...1 | Sales entities on page, by default 50000 | 50000 |
salesentitytype | 1 | Sales entity type: salesorder or salesinvoice | salesorder |
salesentitystatuses | 0...1 | Order state: billed delivered undelivered Invoice state: open unsent paid requested collected | billed |
salesentitiesnetvisorkeys | 0...1 | Order NetvisorKeys / Invoice NetvisorKeys, separated by comma. | 158 |
customernetvisorkeys | 0...1 | Customer NetvisorKeys, separated by comma. | 47 |
Response, when salesentitytype="salesorder":
Level | Element | Type | Occurs | Description | Example |
Root | root | 1 | |||
1 | InventoryReport | Aggr. | 1 | ||
Attr. | Report | String | 1 | Inventory report type | SalesInvetoryEvents |
Attr. | TimeStamp | Date | 1 | Date and time | 2021-10-26 10:49 |
2 | SalesEntities | Aggr. | 1 | ||
Attr. | CurrentPage | Numeric | 1 | Current page | 1 |
Attr. | PageCount | Numeric | 1 | Pages | 1 |
Attr. | SalesEntitiesOnPage | Numeric | 1 | Sales entities on page | 50000 |
Attr. | SalesEntitiesOnPages | Numeric | 1 | Sales entities on pages | 1 |
3 | SalesEntity | Aggr. | 1...n | ||
Attr. | Type | String | 1 | Sales entity type | salesorder |
4 | NetvisorKey | Numeric | 1 | Sales order Netvisor-id | 41 |
4 | OrderNumber | Numeric | 1 | Sales order number | 123456 |
4 | OrderState | String | 1 | Sales order state | undelivered |
4 | Customer | Aggr. | 1 | ||
5 | NetvisorKey | Numeric | 1 | Customer Netvisor-id | 89 |
5 | CustomerName | String | 1 | Customer name | Example customer |
4 | SalesEntityProductLines | Aggr. | 1 | ||
5 | SalesEntityProductLine | Aggr. | 1...n | ||
6 | NetvisorKey | Numeric | 1 | Product line Netvisor-id | 5 |
6 | OrderedAmount | Numeric | 1 | Product amount | 10 |
6 | InventoryEvents | Aggr. | 1 | ||
7 | InventoryEvent | Aggr. | 1...n | ||
Attr. | Context | String | 1 | Inventory event context | salesorder |
8 | NetvisorKey | Numeric | 1 | Inventory event Netvisor-id | 876 |
8 | EventType | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Inventory event type Netvisor-id | 1 |
9 | EventTypeDescription | String | 1 | Inventory event description | Sales |
8 | EventStatus | String | 1 | Inventory event status | open |
8 | EventDate | Date | 1 | Inventory event date | 2021-03-16 |
8 | DeliveryDate | Date | 1 | Delivery date | 2021-03-16 |
8 | Product | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Product Netvisor-id | 74 |
9 | ProductCodes | Aggr. | 1 | ||
10 | ProductCode | String | 1 | Product code | 1234 |
10 | ProductsPrimaryEanCode | Numeric | 1 | Products primary EAN-code | 123456789012 |
10 | ProductsSecondaryEanCode | Numeric | 1 | Products secondary EAN-code | 123456789012 |
9 | ProductNameTranslations | Aggr. | 1 | ||
10 | Translation | String | 1...3 | Product name | Example product |
Attr. | Language | String | 1 | Language of the product name | EN |
9 | ProductUnit | Aggr. | 1 | ||
10 | NetvisorKey | Numeric | 1 | Product unit Netvisor-id | 3 |
10 | ProductUnitTranslations | Aggr. | 1 | ||
11 | Translation | String | 1...3 | Product unit | pcs |
Attr. | Language | String | 1 | Language of the product unit | EN |
8 | InventoryPlace | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Inventory Netvisor-id | 3 |
9 | InventoryPlaceName | String | 1 | Inventory description, inventory location | Inventory-description, inventory-location |
9 | InventoryPlaceShelve | Aggr. | 1 | ||
10 | NetvisorKey | Numeric | 0...1 | Inventory shelve Netvisor-id | 5 |
10 | InventoryPlaceShelveName | String | 0...1 | Inventory shelve | Example shelve |
8 | Amount | Numeric | 1 | Product amount | -564 |
8 | UnitPrice | Numeric | 1 | Product unit price | 9,7 |
Attr. | PurchasePrice | Numeric | 1 | Product purchase price | 9,7 |
Attr. | FreightRate | Numeric | 1 | Product freight rate | 0 |
8 | Description | String | 1 | Inventory event description | Example description |
8 | BatchInformation | Aggr. | 1 | ||
9 | BatchNumber | Numeric | 1 | Batch number | 13 |
9 | ManufactureDate | Date | 1 | Manufacture date | 2021-09-23 |
9 | PackagingDate | Date | 1 | Packing date | 2021-09-23 |
9 | BestBeforeDate | Date | 1 | Best before date | 2021-09-23 |
9 | UseByDate | Date | 1 | Use by date | 2021-09-23 |
8 | ShipmentInformation | Aggr. | 1 | ||
9 | CountryOfOrigin | String | 1 | Country of origin | FI |
Attr. | Type | String | 1 | Always ISO-3166 | ISO-3166 |
9 | NetWeight | Numeric | 1 | Net weight | 11,5 |
Attr. | Unit | String | 1 | Unit | mg |
9 | GrossWeight | Numeric | 1 | Gross weight | 10 |
Attr. | Unit | String | 1 | Unit | mg |
9 | PackageWidth | Numeric | 1 | Package width | 12,5 |
Attr. | Unit | String | 1 | Unit | cm |
9 | PackageHeight | Numeric | 1 | Package height | 4,6 |
Attr. | Unit | String | 1 | Unit | cm |
9 | PackageLength | Numeric | 1 | Package length | 7,9 |
Attr. | Unit | String | 1 | Unit | cm |
8 | EventLinks | Aggr. | 1 | ||
9 | TargetInventoryEvent | Aggr. | 0...1 | ||
Attr. | Context | String | 0...1 | Linked inventory event context | manualpurchaseevents |
Attr. | ContextNetvisorKey | Numeric | 0...1 | Context Netvisor-id | 4 |
10 | NetvisorKey | Numeric | 0...1 | Linked inventory event Netvisor-id | 2140 |
10 | EventType | Aggr. | 0...1 | ||
11 | NetvisorKey | Numeric | 0...1 | Linked inventory event type Netvisor-id | 2 |
11 | EventTypeDescription | String | 0...1 | Linked inventory event type description | Purchase |
10 | EventStatus | String | 0...1 | Linked inventory event status | handled |
10 | DeliveryDate | Date | 0...1 | Delivery date/arrival date | 2021-11-06 |
10 | Amount | Numeric | 0...1 | Amount | 1968 |
10 | UnitPrice | Numeric | 0...1 | Unit | 9,7 |
10 | AmountLeft | Numeric | 0...1 | Amount left | 1210 |
Response, when salesentitytype="salesinvoice":
Level | Element | Type | Occurs | Description | Example |
Root | root | 1 | |||
1 | InventoryReport | Aggr. | 1 | ||
Attr. | Report | String | 1 | Inventory report type | SalesInvetoryEvents |
Attr. | TimeStamp | Date | 1 | Date and time | 2021-10-26 10:49 |
2 | SalesEntities | Aggr. | 1 | ||
Attr. | CurrentPage | Numeric | 1 | Current page | 1 |
Attr. | PageCount | Numeric | 1 | Pages | 1 |
Attr. | SalesEntitiesOnPage | Numeric | 1 | Sales entities on page | 50000 |
Attr. | SalesEntitiesOnPages | Numeric | 1 | Sales entities on pages | 1 |
3 | SalesEntity | Aggr. | 1...n | ||
Attr. | Type | String | 1 | Sales entity type | salesinvoice |
4 | NetvisorKey | Numeric | 1 | Sales invoice Netvisor-id | 41 |
4 | InvoiceNumber | Numeric | 1 | Sales invoice number | 123456 |
4 | InvoiceState | String | 1 | Sales invoice status | unsent |
4 | Customer | Aggr. | 1 | ||
5 | NetvisorKey | Numeric | 1 | Customer Netvisor-id | 89 |
5 | CustomerName | String | 1 | Customer name | Example customer |
4 | SalesEntityProductLines | Aggr. | 1 | ||
5 | SalesEntityProductLine | Aggr. | 1...n | ||
6 | NetvisorKey | Numeric | 1 | Product line Netvisor-id | 5 |
6 | InvoiceAmount | Numeric | 1 | Product amount | 10 |
6 | InventoryEvents | Aggr. | 1 | ||
7 | InventoryEvent | Aggr. | 1...n | ||
Attr. | Context | String | 1 | Inventory event context | salesinvoice |
8 | NetvisorKey | Numeric | 1 | Inventory event Netvisor-id | 876 |
8 | EventType | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Inventory event type Netvisor-id | 1 |
9 | EventTypeDescription | String | 1 | Inventory event type description | Sales |
8 | EventStatus | String | 1 | Inventory event status | handled |
8 | EventDate | Date | 1 | Inventory event date | 2021-03-16 |
8 | DeliveryDate | Date | 1 | Delivery date | 2021-03-16 |
8 | Product | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Product Netvisor-id | 74 |
9 | ProductCodes | Aggr. | 1 | ||
10 | ProductCode | String | 1 | Product code | 1234 |
10 | ProductsPrimaryEanCode | Numeric | 1 | Products primary EAN-code | 12345689012 |
10 | ProductsSecondaryEanCode | Numeric | 1 | Products secondary EAN-code | 12345789012 |
9 | ProductNameTranslations | Aggr. | 1 | ||
10 | Translation | String | 1...3 | Product name | Example product |
Attr. | Language | String | 1 | Language of the product name | EN |
9 | ProductUnit | Aggr. | 1 | ||
10 | NetvisorKey | Numeric | 1 | Product unit Netvisor-id | 3 |
10 | ProductUnitTranslations | Aggr. | 1 | ||
11 | Translation | String | 1...3 | Product unit | pcs |
Attr. | Language | String | 1 | Language of the product unit | EN |
8 | InventoryPlace | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Inventory Netvisor-id | 3 |
9 | InventoryPlaceName | String | 1 | Inventory description, inventory location | Inventory-description, inventory-location |
9 | InventoryPlaceShelve | Aggr. | 1 | ||
10 | NetvisorKey | Numeric | 0...1 | Inventory shelve Netvisor-id | 1 |
10 | InventoryPlaceShelveName | String | 0...1 | Inventory shelve name | Example shelve |
8 | Amount | Numeric | 1 | Product amount | -564 |
8 | UnitPrice | Numeric | 1 | Product unit price | 9,7 |
Attr. | PurchasePrice | Numeric | 1 | Product purchase price | 9,7 |
Attr. | FreightRate | Numeric | 1 | Product freight rate | 0 |
8 | Description | String | 1 | Inventory event description | Example description |
8 | BatchInformation | Aggr. | 1 | ||
9 | BatchNumber | Numeric | 1 | Batch number | 13 |
9 | ManufactureDate | Date | 1 | Manufacture Date | 2021-09-23 |
9 | PackagingDate | Date | 1 | Packaging date | 2021-09-23 |
9 | BestBeforeDate | Date | 1 | Best before date | 2021-09-23 |
9 | UseByDate | Date | 1 | Use by date | 2021-09-23 |
8 | ShipmentInformation | Aggr. | 1 | ||
9 | CountryOfOrigin | String | 1 | Country of origin | FI |
Attr. | Type | String | 1 | Always ISO-3166 | ISO-3166 |
9 | NetWeight | Numeric | 1 | Net weight | 11,5 |
Attr. | Unit | String | 1 | Unit | mg |
9 | GrossWeight | Numeric | 1 | Gross weight | 10 |
Attr. | Unit | String | 1 | Unit | mg |
9 | PackageWidth | Numeric | 1 | Package width | 12,5 |
Attr. | Unit | String | 1 | Unit | cm |
9 | PackageHeight | Numeric | 1 | Package height | 4,6 |
Attr. | Unit | String | 1 | Unit | cm |
9 | PackageLength | Numeric | 1 | Package length | 7,9 |
Attr. | Unit | String | 1 | Unit | cm |
8 | EventLinks | Aggr. | 1 | ||
9 | TargetInventoryEvent | Aggr. | 0...1 | ||
Attr. | Context | String | 0...1 | Linked inventory event context | manualpurchaseevents |
Attr. | ContextNetvisorKey | Numeric | 0...1 | Context Netvisor-id | 169 |
10 | NetvisorKey | Numeric | 0...1 | Linked inventory event Netvisor-id | 2140 |
10 | EventType | Aggr. | 0...1 | ||
11 | NetvisorKey | Numeric | 0...1 | Linked inventory event type Netvisor-id | 2 |
11 | EventTypeDescription | String | 0...1 | Linked inventory event type description | Purchase |
10 | EventStatus | String | 0...1 | Linked inventory event status | handled |
10 | DeliveryDate | Date | 0...1 | Delivery date / Arrival date | 2021-11-06 |
10 | Amount | Numeric | 0...1 | Amount | 1968,50 |
10 | UnitPrice | Numeric | 0...1 | Unit price | 9,7 |
10 | AmountLeft | Numeric | 0...1 | Amount left | 1210 |
Productinventoryamounts
When report=productinventoryamounts, also the following parameters can be used:
Parameter | Occurs | Description | Example |
page | 0...1 | Page, by default 1 | 1 |
productsonpage | 0...1 | Products on page, by default 50000 | 50000 |
searchlanguage | 0...1 | Search language, fi, se or en | fi |
productnetvisorkeys | 0...1 | Product NetvisorKeys, separated by comma. | 123 |
productnamekeyword | 0...1 | Keyword from the retreived product's name. | Example product |
productcodekeyword | 0...1 | Keyword from the retreived product's product code. | Test |
producteancode | 0...1 | Product EAN-code (primary/secondary) | 123456789012 |
onlysellableproducts | 0...1 | Retrieve only sellable products, true or false | true |
productchangedsince | 0...1 | Filters result to contain only products having change after given time, time in format yyyy-MM-ddTHH:mm:ss | 2021-09-01T12:00:00 |
productgroupnetvisorkeys | 0...1 | Product group NetvisorKeys, separated by comma. | 12 |
productgroupname | 0...1 | Retrieved product group's name | Example product group |
productgroupnamekeyword | 0...1 | Keyword from the retreived product group's name. | Example |
productgroupingcriterianame | 0...1 | Product grouping criteria name | Example grouping criteria |
inventoryplacenetvisorkeys | 0...1 | Inventory NetvisorKeys, separated by comma. | 54 |
inventoryplacename | 0...1 | Inventory name | Example inventory place |
inventoryplaceshelfnetvisorkeys | 0...1 | Inventory shelf NetvisorKeys, separated by comma. | 4 |
inventoryplaceshelfname | 0...1 | Inventory shelf name | Example shelf |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | root | 1 | |||
1 | InventoryReport | Aggr. | 1 | ||
Attr. | Report | String | 1 | Inventory report type | ProductInventoryAmounts |
Attr. | TimeStamp | Date | 1 | Date and time | 2021-10-26 10:49 |
2 | Products | Aggr. | 1 | ||
Attr. | CurrentPage | Numeric | 1 | Current page | 1 |
Attr. | PageCount | Numeric | 1 | Pages | 1 |
Attr. | ProductsOnPage | Numeric | 1 | Products on page | 50000 |
Attr. | ProductsOnPages | Numeric | 1 | Products on pages | 1 |
3 | Product | Aggr. | 1...n | ||
4 | NetvisorKey | Numeric | 1 | Product Netvisor-id | 41 |
4 | ProductCodes | Aggr. | 1 | ||
5 | ProductCode | String | 1 | Product code | Test product |
5 | ProductPrimaryEanCode | String | 1 | Product primary EAN-code | T1-PRIMARY-EAN |
5 | ProductSecondaryEanCode | String | 1 | Product secondary EAN-code | T1-SECONDARY-EAN |
4 | ProductNameTranslations | Aggr. | 1 | ||
5 | Translation | String | 1...3 | Product name | Example product |
Attr. | Language | String | 1 | Language of the product name | EN |
4 | ProductUnit | Aggr. | 1 | ||
5 | NetvisorKey | Numeric | 1 | Product unit Netvisor-id | |
5 | ProductUnitTranslations | Aggr. | 1 | ||
6 | Translation | String | 1...3 | Product unit | pcs |
Attr. | Language | String | 1 | Language of the product unit | EN |
4 | ProductInventoryStatus | Aggr. | 1 | ||
5 | InventoryAmount | Numeric | 1 | Product inventory amount | 209,12 |
5 | OrderedAmount | Numeric | 1 | Product ordered amount | 0 |
5 | ReservedAmount | Numeric | 1 | Product reserved amount | 0 |
4 | ProductInventoryPrices | Aggr. | 1 | ||
5 | AverageUnitPrice | Numeric | 1 | Product average unit price | 12,32402 |
5 | MinimumUnitPrice | Numeric | 1 | Product minimum unit price | 0 |
5 | MaximumUnitPrice | Numeric | 1 | Product maximum unit price | 15 |
4 | ProductInventoryValue | Aggr. | 1 | ||
5 | InventoryValue | Numeric | 1 | Inventory value | |
4 | InventoryPlaces | Aggr. | 1 | ||
5 | InventoryPlace | Aggr. | 1...n | ||
5 | NetvisorKey | Numeric | 1 | Inventory NetvisorKey | |
5 | InventoryPlaceName | String | 1 | Inventory description and location | Inventory-Description, Inventory-Location |
5 | InventoryPlaceStatus | Aggr. | 1 | ||
6 | InventoryAmount | Numeric | 1 | Product inventory amount in inventory | 119,00 |
6 | OrderedAmount | Numeric | 1 | Product ordered amount in inventory | 0 |
6 | ReservedAmount | Numeric | 1 | Product reserved amount in inventory | 0 |
5 | InventoryPlacePrices | Aggr. | 1 | ||
6 | AverageUnitPrice | Numeric | 1 | Product average unit price in inventory | 14,08403 |
6 | MinimumUnitPrice | Numeric | 1 | Product minimum unit price in inventory | 0 |
6 | MaximumUnitPrice | Numeric | 1 | Product maximum unit price in inventory | 15 |
5 | InventoryPlaceShelves | Aggr. | 1 | ||
6 | InventoryPlaceShelve | Aggr. | 0...n | ||
7 | NetvisorKey | Numeric | 1 | Inventory shelve Netvisor-id | 4 |
7 | InventoryPlaceShelveName | String | 1 | Inventory shelve name | Example shelve |
7 | InventoryPlaceShelveStatus | Aggr. | 1 | ||
8 | InventoryAmount | Numeric | 1 | Product inventory amount in inventory shelve | 119 |
8 | OrderedAmount | Numeric | 1 | Product ordered amount in inventory shelve | 0 |
8 | ReservedAmount | Numeric | 1 | Product reserved amount in inventory shelve | 0 |
Purchaseorderinventoryamounts
When report=purchaseorderinventoryamounts, also the following parameters can be used:
Parameter | Occurs | Description | Example |
page | 0...1 | Page, by default 1 | 1 |
purchaseordersonpage | 0...1 | Purchase orders on page, by default 50000 | 50000 |
purchaseorderstatus | 0...1 | Purchase order status: accepted purchaserequest sent archived | accepted |
purchaseordernetvisorkeys | 0...1 | Purchase order NetvisorKeys, separated by comma. | 123 |
distributernetvisorkeys | 0...1 | Distributer NetvisorKeys, separated by comma. | 158, 147 |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | root | 1 | |||
1 | InventoryReport | Aggr. | 1 | ||
Attr. | Report | String | 1 | Inventory report type | PurchaseOrderInventoryEvents |
Attr. | TimeStamp | Date | 1 | Date and time | 2021-10-26 10:49 |
2 | PurchaseOrders | Aggr. | 1 | ||
Attr. | CurrentPage | Numeric | 1 | Current page | 1 |
Attr. | PageCount | Numeric | 1 | Pages | 1 |
Attr. | PurchaseOrdersOnPage | Numeric | 1 | Purchase orders on page | 50000 |
Attr. | PurchaseOrdersOnPages | Numeric | 1 | Purchase orders on pages | 1 |
3 | PurchaseOrder | Aggr. | 1...n | ||
4 | NetvisorKey | Numeric | 1 | Purchase order Netvisor-id | 41 |
4 | OrderNumber | Numeric | 1 | Purchase order number | 17 |
4 | OrderStatus | String | 1 | Purchase order status | sent |
4 | Distributer | Aggr. | 1 | ||
5 | NetvisorKey | Numeric | 1 | Distributer Netvisor-id | 89 |
5 | DistributerName | String | 1 | Distributer name | Example distributer |
4 | PurchaseOrderProductLines | Aggr. | 1 | ||
5 | PurchaseOrderProductLine | Aggr. | 1...n | ||
6 | NetvisorKey | Numeric | 1 | Purchase order product line Netvisor-id | 5 |
6 | OrderedAmount | Numeric | 1 | Product amount | 10 |
6 | InventoryEvents | Aggr. | 1 | ||
7 | InventoryEvent | Aggr. | 1...n | ||
Attr. | Context | String | 1 | Inventory event context | purchaseorder |
8 | NetvisorKey | Numeric | 1 | Inventory event Netvisor-id | 876 |
8 | EventType | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Inventory event type Netvisor-id | 1 |
9 | EventTypeDescription | String | 1 | Inventory event type description | Purchase |
8 | EventStatus | String | 1 | Inventory event status | handled |
8 | EventDate | Date | 1 | Inventory event date | 2021-03-16 |
8 | DeliveryDate | Date | 1 | Delivery date | 2021-03-16 |
8 | Product | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 1 | Product Netvisor-id | 74 |
9 | ProductCodes | Aggr. | 1 | ||
10 | ProductCode | String | 1 | Product code | 1234 |
10 | ProductPrimaryEanCode | Numeric | 1 | Product primary EAN-code | 123456789012 |
10 | ProductSecondaryEanCode | Numeric | 1 | Product secondary EAN-code | 123456789012 |
9 | ProductNameTranslations | Aggr. | 1 | ||
10 | Translation | String | 1...3 | Product name | Example product |
Attr. | Language | String | 1 | Language of the product name | EN |
9 | ProductUnit | Aggr. | 1 | ||
10 | NetvisorKey | Numeric | 1 | Product unit Netvisor-id | 3 |
10 | ProductUnitTranslations | Aggr. | 1...3 | ||
11 | Translation | String | 1 | Product unit | pcs |
Attr. | Language | String | 1 | Language of the product unit | EN |
8 | InventoryPlace | Aggr. | 1 | ||
9 | NetvisorKey | Numeric | 0...1 | Inventory Netvisor-id | 3 |
9 | InventoryPlaceName | String | 0...1 | Inventory description, inventory location | Inventory-description, Inventory-location |
9 | InventoryPlaceShelve | Aggr. | 0...1 | ||
10 | NetvisorKey | Numeric | 0...1 | Inventory shelve Netvisor-id | 5 |
10 | InventoryPlaceShelveName | String | 0..1 | Inventory shelve name | Example shelve |
8 | Amount | Numeric | 1 | Product amount | -564 |
8 | UnitPrice | Numeric | 1 | Product unit price | 9,7 |
Attr. | PurchasePrice | Numeric | 1 | Product purchase price | 9,7 |
Attr. | FreightRate | Numeric | 1 | Product freight rate | 0 |
8 | Description | String | 1 | Description | Example description |
8 | BatchInformation | Aggr. | 1 | ||
9 | BatchNumber | Numeric | 1 | Batch number | 13 |
9 | ManufactureDate | Date | 1 | Manufacture date | 2021-09-23 |
9 | PackagingDate | Date | 1 | Packaging date | 2021-09-23 |
9 | BestBeforeDate | Date | 1 | Best before date | 2021-09-23 |
9 | UseByDate | Date | 1 | Use by date | 2021-09-23 |
8 | ShipmentInformation | Aggr. | 1 | ||
9 | CountryOfOrigin | String | 1 | Country of origin | FI |
Attr. | Type | String | 1 | Always ISO-3166 | ISO-3166 |
9 | NetWeight | Numeric | 1 | Net weight | 11,5 |
Attr. | Unit | String | 1 | Unit | mg |
9 | GrossWeight | Numeric | 1 | Gross weight | 10 |
Attr. | Unit | String | 1 | Unit | mg |
9 | PackageWidth | Numeric | 1 | Package width | 12,5 |
Attr. | Unit | String | 1 | Unit | cm |
9 | PackageHeight | Numeric | 1 | Package height | 4,6 |
Attr. | Unit | String | 1 | Unit | cm |
9 | PackageLength | Numeric | 1 | Paage length | 7,9 |
Attr. | Unit | String | 1 | Unit | cm |
8 | EventLinks | Aggr. | 1 | ||
9 | SourceInventoryEvent | Aggr. | 0...1 | ||
Attr. | Context | String | 0...1 | Linked inventory event context | production |
Attr. | ContextNetvisorKey | Numeric | 0...1 | Context Netvisor-id | 169 |
10 | NetvisorKey | Numeric | 0...1 | Linked inventory event Netvisor-id | 2140 |
10 | EventType | Aggr. | 0...1 | ||
11 | NetvisorKey | Numeric | 0...1 | Linked inventory event type Netvisor-id | 2 |
11 | EventTypeDescription | String | 0...1 | Linked inventory event type description | Manufacture |
10 | EventStatus | String | 0...1 | Linked inventory event status | handled |
10 | DeliveryDate | Date | 0...1 | Delivery date/Arrival date | 2021-11-06 |
10 | Amount | Numeric | 0...1 | Amount | 1968,50 |
10 | UnitPrice | Numeric | 0...1 | Unit price | 9,7 |
10 | AmountLeft | Numeric | 1 | Amount left | 1210 |
Get product attachments
Resource: getproductattachment.nv
The resource can be used to retreive product attachments. The used parameter is attachment's NetvisorKey, that is returned when retreiving extended product list (extendedproductlist.nv). The max size for the returned message is 50Mb.
Querystring parameters:
Parameter | Occurs | Description | Example |
productattachmentnetvisorkeys | 1 | Definition with attachments' NetvisorKey | 18, 19, 20 |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | Root | Aggr. | 1 | ||
1 | ProductAttachments | Aggr. | 1 | ||
2 | Attachment | Aggr. | 1...n | ||
3 | NetvisorKey | Numeric | 1 | Attachment's NetvisorKey | 18 |
3 | MimeType | String | 1 | Attachment's mime-type | application/pdf |
3 | FileName | String | 1 | Attachment name | Testattachment.pdf |
3 | AttachmentData | Base64 | 1 | Attachment in Base64 | |
Attr. | type | String | 1 | Always Base64 | Base64 |
Get product images
Resource: getproducimage.nv
The resource getproductimage.nv can be used to retreive product images. The used parameter is image's NetvisorKey, that is returned when retreiving extended product list (extendedproductlist.nv). The max size for the returned message is 50Mb.
Querystring parameters:
Parameter | Occurs | Description | Example |
productimagenetvisorkeys | 1 | Definition with images' NetvisorKey | 18, 19, 20 |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | Root | Aggr. | 1 | ||
1 | ProductImages | Aggr. | 1 | ||
2 | ProductImage | Aggr. | 1...n | ||
3 | MimeType | String | 1 | Image's mime-type | image/jpeg |
3 | Title | String | 0...1 | Caption | Product image |
3 | FileName | String | 1 | Image name | Productimage.jpg |
3 | ImageData | Base64 | 1 | Image in Base64 | |
Attr. | type | String | 1 | Always Base64 | Base64 |
Get extended product list
Resource: extendedproductlist.nv
The resource extendedproductlist.nv can be used to retreive normal products or models but not main products or TEMP-product. You can limit the query using different parameters that can be seen in the table below. You can use this resource even if the company doesn't use extended product management. In this case some element may not be returned because they are not available.
The query returns published products. deleted products are never returned. Unpublished products can be retreived when retreivin the extended produc list with product's NetvisorKey.
Querystring parameters:
Parameter | Occurs | Description | Example |
replyoptions | 0...1 | You can choose what infofmation is returned in addition to basic information. Given with numerical value or flag name. Options and flag names: Price groups - IncludeProductPriceGroups (1) Customer prices- IncludeProductCustomerPrices (2) Distributer purchase information- IncludeDistributerPurchaseInformation (4) Inventory place shelves- IncludeProductInventoryPlaceShelves (8) Shipment information- IncludeProductShipmentInformation (16) Grouping criterias- IncludeProductGroupingCriterias (32) Accounting information - IncludeProductAccountingInformation (64) Dimension information- IncludeProductDimensionInformation (128) Information fields- IncludeProductInformationFields (256) Product references- IncludeProductReferences (512) Properties- IncludeProductProperties (1024) Subproducts- IncludeProductSubProducts (2048) Images- IncludeProductImages (2096) Attachments- IncludeProductAttachments (8192) Set all reply options - SetAllReplyOptions (4294967295) | 3 Returns Price groups and Customer prices. Can be calculated by summing flag values. When using flag names, is given as "IncludeProductPriceGroups, IncludeProductCustomerPrices". As parameter: *.nv?replyoptions=I>ncludeProductPriceGroups, IncludeProductCustomerPrices or *.nv?replyoptions=3 |
searchlanguage | 0...1 | Target retreived keywords to a specific language version. Without extended product management only "fi". Allowed values "fi", "se" and "en". If not given, always "fi". | se |
productnetvisorkeys | 0...1 | List of product NetvisorKey values separated with comma. Can also have only one value. | 7,12 |
productnamekeyword | 0...1 | One keyword to be retreived from the product name. | test |
productcodekeyword | 0...1 | One keyword to be retreived from the productcode. | ABC |
producteancode | 0...1 | Retreived product's ean-code. Compared to primary and secondary ean codes. | |
onlysellableproducts | 0...1 | If the product is sellable. true or false. | true |
onlystoragedproducts | 0...1 | If the product is storaged. Used only with stock management. true or false. | false |
productchangedsince | 0...1 | Has the product been changed since given date and time. One minute accuracy. | 2020-09-17T10:21 |
productgroupnetvisorkeys | 0...1 | List of product group NetvisorKey values separated with comma. Can also have one value. | 7, 20 |
productgroupname | 0...1 | Name of the retreived product group. | Test product |
productgroupnamekeyword | 0...1 | Keyword from the retreivced product group's name. | Test |
productgroupnamefreetext | 0...1 | Name of the retreived product group includes the given parameter value. | product |
excludeproductgroupnamefreetext | 0...1 | Name of the retreived product group doesn includes the given parameter value. | |
productgroupingcriterianame | 0...1 | Grouping criteria name of the retreived products. | Grouping |
productsonpage | 0...1 | Maximum amount of products on page. (1-maximum amount in Netvisor) | 2500 |
page | 0...1 | The number of the returned page. | 2 |
Some of the returned data is returned only if the company uses extended product management, purchase order management or stock management. Otherwise the structure is the same for all companies.
The returned message has max size of 25Mb. If the max limit is being exceeded, the Web Service Interface returns an error with an instruction how to downsize the request. No data is returned before the querystring returns a smaller message.
Using pagination maximum amount of products per message can be set (ProductsOnPage = 1 - max set in Netvisor) and specific page can be retreived (Page = 1 - PageCount). Pages should always be retreived with same parameters. Please note that because product list can be changed at all times, same query can return different response.
Reponse:
Level | Element | Type | Occurs | Description | Example |
Root | Root | Aggr. | 1 | ||
1 | Products | Aggr. | 1 | ||
2 | Product | Aggr. | 1 | ||
3 | NetvisorKey | Numeric | 1 | Product NetvisorKey | 13848 |
3 | ProductCodes | Aggr. | 1 | ||
4 | ProductCode | Numeric | 1 | Product code | 1 |
4 | ProductPrimaryEanCode | Numeric | 1 | Primary ean-code | |
4 | ProductSecondaryEanCode | Numeric | 1 | Secondary ean-code | |
3 | ProductNameTranslations | Aggr. | 1 | Product name translations | |
4 | Translation | String | 1 | Product name | Test product |
Attr. | Language | String | 1 | FI, SE or EN | EN |
3 | ProductDescriptionTranslations | Aggr. | 1 | Product description translations | |
4 | Translation | String | 1 | Product description | Description |
Attr. | Language | String | 1 | FI, SE or EN | EN |
3 | ProductFeatures | Aggr. | 1 | Product features | |
4 | IsPublishedProduct | String | 1 | Is the product published, true or false | true |
4 | IsSellableProduct | String | 1 | Is the product sellable, true or false | true |
4 | IsStorageProduct | String | 1 | Is the product storaged true or false | false |
4 | IsProductStructureProduct | String | 1 | Is the product a structure product, true or false | false |
4 | IsModel | String | 1 | Is to product a model, true or false | false |
4 | IsSummaryOfProducts | String | 1 | Is the product summary of products, true or false | false |
4 | LastChangedDate | Date | 1 | Last modified time stamp | 2021-03-23 09:30 |
Attr. | Format | String | 1 | Date format, always ansi | ansi |
3 | ProductGroup | Aggr. | 1 | Product group | |
4 | NetvisorKey | Numeric | 0...1 | Product group NetvisorKey | 5 |
4 | ProductGroupTranslations | Aggr. | 0...1 | Product group translations | |
5 | Translation | String | 0...1 | Product group name | Product group |
Attr. | language | String | 1 | FI, EN or SE | EN |
3 | ProductUnit | Aggr. | 1 | Product unit details | |
4 | NetvisorKey | Numeric | 0...1 | Unit NetvisorKey | 10 |
4 | ProductUnitTranslations | Aggr. | 0...1 | Unit translations | |
5 | Translation | String | 0...1 | Unit name | pcs |
Attr. | language | String | 1 | FI, EN or SE | EN |
3 | ProductPriceInformation | Aggr. | 1 | Product price information | |
4 | DefaultNetPrice | Numeric | 1 | Product net price | 5,00 |
4 | DefaultGrossPrice | Numeric | 1 | Product gross price | 5,00 |
4 | Vat | Agge. | 1 | Product VAT | |
5 | NetvisorKey | Numeric | 1 | VAT base NetvisorKey | 1 |
5 | Percentage | Numeric | 1 | VAT percentage | 0 |
4 | PriceMargin | Numeric | 1 | Price margin | 8,00 |
4 | ProvisionPercentage | Numeric | 1 | Provision percentage | 2,00 |
4 | PriceGroups | Aggr. | 0...n | Price groups | |
5 | Group | Aggr. | 1 | ||
6 | NetvisorKey | Numeric | 1 | Price group NetvisorKey | 7 |
6 | PriceGroupName | String | 1 | Price group name | Price group |
6 | NetPrice | Numeric | 1 | Net price | 7,00 |
6 | GrossPrice | Numeric | 1 | Gross price | 9,00 |
4 | CustomerPrices | Aggr. | 0...n | Customer prices | |
5 | Customer | Aggr. | 1 | Customer | |
6 | NetvisorKey | Numeric | 1 | Customer NetvisorKey | 11 |
6 | CustomerCode | Numeric | 1 | Customer code | 1000 |
6 | CustomerName | String | 1 | Customer name | Customer |
6 | NetPrice | Numeric | 1 | Customer net price | 6,50 |
6 | GrossPrice | Numeric | 1 | Customer gross price | 8,05 |
3 | ProductPurchaseInformation | Aggr. | 0...1 | Purchase information | |
4 | DefaultPurchasePrice | Numeric | 1 | Purchase price | 2,50 |
4 | DistirbuterPurchaseInformations | Aggr. | 0...1 | Distributer purchase information | |
5 | Distributer | Aggr. | 1 | Distributer | |
6 | NetvisorKey | Numeric | 1 | Distributer NetvisorKey | 33587 |
6 | DistributerCode | Numeric | 1 | Distributer code | 855 |
6 | DistributerName | String | 1 | Distributer name | Distributer |
6 | DistributerProductCode | String | 1 | Distributer product code | abc |
6 | DistributerProductName | String | 1 | Distributer product name | Name |
6 | PurchasePrice | Numeric | 1 | Distributer purchase price | 1,50 |
6 | CurrencyAbbreviation | String | 1 | Distributer currency | SEK |
3 | ProductStorageInformation | Aggr. | 0...1 | Storage information | |
4 | DefaultInvetoryPlace | Aggr. | 1 | Default inventory place | |
5 | NetvisorKey | Numeric | 0...1 | Inventory NetvisorKey | 17 |
5 | InventoryPlaceName | String | 0...1 | Inventory name | Warehouse |
4 | InventoryPlaceShelves | Aggr. | 0...1 | Inventory place shelves | |
5 | InventoryPlaceShelve | Aggr. | 1 | Inventory place shelve | |
6 | InventoryPlaceNetvisorKey | Numeric | 1 | Inventory place NetvisorKey | 22 |
6 | InventoryPlaceName | String | 1 | Inventory place name | Warehouse 1 |
6 | ShelveNetvisorKey | Numeric | 1 | Shelve NetvisorKey | 31 |
6 | ShelveName | String | 1 | Shelve name | Shelve 1 |
4 | AlertLimit | Numeric | 1 | Alert limit | 10 |
4 | CustomsTariffHeader | String | 1 | Customs tariff header | Code |
4 | ProductBatchLinkingMode | Aggr. | 0...1 | Batch linking mode | |
5 | NetvisorKey | Numeric | 1 | Batch linking mode NetvisorKey | 4 |
5 | Definition | String | 1 | Batch linking mode definition | OldestFirstByValueDate |
3 | ProductShipmentInformation | Aggr. | 0...1 | Product shipment information | |
4 | DefaultProductCountryOfOrigin | String | 1 | Product country of origin | SE |
Attr. | type | String | 1 | Always ISO-3166 | ISO-3166 |
4 | ProductNetWeight | Numeric | 1 | Product net weight | 0 |
Attr. | unit | String | 1 | Weight unit | g |
4 | ProductGrossWeigh | Numeric | 1 | Product gross weight | 0 |
Attr. | unit | String | 1 | Weight unit | g |
4 | ProductPackageWidth | Numeric | 1 | Product package width | 0 |
Attr. | unit | String | 1 | Width unit | cm |
4 | ProductPackageHeight | Numeric | 1 | Product package height | 0 |
Attr. | unit | String | 1 | Height unit | cm |
4 | ProductPackageLength | Numeric | 1 | Product package length | 0 |
Attr. | unit | String | 1 | Length unit | cm |
3 | ProductGroupingCriterias | Aggr. | 0..n | Grouping criterias | |
4 | Translation | String | 1 | Grouping criteria name | TestGroup |
Attr. | language | String | 1 | FI, EN or SE | EN |
3 | ProductAccountInformation | Aggr. | 0...1 | Account information | |
4 | DefaultDomesticAccountNumber | Numeric | 1 | Domestic sales account number | 3000 |
4 | DefaultEuAccountNumber | Numeric | 1 | EU sales account number | 3360 |
4 | DefaultOutsideEUAccountNumber | Numeric | 1 | Outside EU sales account number | 3380 |
4 | DefaultInventoryAccountNumber | Numeric | 1 | Inventory account number | 1521 |
3 | ProductDimensionInformation | Aggr. | 0...1 | Product dimension information | |
4 | Dimension | Aggr. | 1 | ||
5 | NameNetvisorKey | Numeric | 1 | Dimension header NetvisorKey | 2 |
5 | DimensionNameName | String | 1 | Dimension header name | Dimension header |
5 | DetailNetvisorKey | Numeric | 1 | Dimension detail NetvisorKey | 15 |
5 | DimensionDetailName | String | 1 | Dimension detail name | Dimension |
3 | ProductInformationFields | Aggr. | 0...n | Product information fields | |
4 | InformationField | Aggr. | 1 | Product information field | |
5 | InformationFieldName | String | 1 | Information field name | Information field |
5 | InformationFieldItemValue | String | 1 | Information field value | 24 |
3 | ProductReferences | Aggr. | 0...1 | Product references | |
4 | RelatedProducts | Aggr. | 0...n | Related products | |
5 | Product | Aggr. | 1 | Related product | |
6 | NetvisorKey | Numeric | 1 | Related product NetvisorKey | 5 |
6 | ProductCode | Numeric | 1 | Related product code | 1000 |
6 | ProductNameTranslations | Aggr. | 1 | Related product name translations | |
7 | Translation | String | 1 | Related product name | Product 7 |
Attr. | language | String | 1 | FI, EN or SE | EN |
4 | ComplementaryProducts | Aggr. | 0...n | Complementary products | |
5 | Product | Aggr. | 1 | Complementary product | |
6 | NetvisorKey | Numeric | 1 | Complementary product NetvisorKey | 13 |
6 | ProductCode | Numeric | 1 | Complementary product code | 2005 |
6 | ProductNameTranslations | Aggr. | 1 | Complementary product translations | |
7 | Translation | String | 1 | Complementary product name | Product 10 |
Attr. | language | String | 1 | FI, EN or SE | EN |
3 | ProductProperties | Aggr. | 0...1 | Product properties | |
4 | Property | Aggr. | 0...n | Property | |
5 | NetvisorKey | Numeric | 1 | Property NetvisorKey | 88 |
5 | PropertyTranslations | Aggr. | 1 | Property translations | |
6 | Translation | String | 1 | Property name | |
Attr. | language | String | 1 | Fi, EN or SE | FI |
5 | PropertyValues | Aggr. | 0...1 | Property values | |
6 | NetvisorKey | Numeric | 1 | Value NetvisorKey | 70 |
6 | PropertyValueTranslations | Aggr. | 1 | Value translations | |
7 | Translation | String | 1 | Value name | |
Attr. | language | String | 1 | FI, EN or SE | FI |
3 | SubProductInformation | Aggr. | 0...1 | Subproducts | |
4 | Parents | Aggr. | 0...n | Parents | |
5 | Product | Aggr. | 1 | Parent product | |
6 | NetvisorKey | Numeric | 1 | Parent product NetvisorKey | 55 |
6 | Amount | Numeric | 1 | Amount | 25 |
6 | PurchasePriceChange | Numeric | 1 | Purchase price change | |
6 | UnitPriceChange | Numeric | 1 | Unit price change | |
4 | Children | Aggr. | 1 | Children | |
5 | Product | Aggr. | 1 | Child product | |
6 | NetvisorKey | Numeric | 1 | Child product NetvisorKey | 47 |
6 | Amount | Numeric | 1 | Amount | 20 |
6 | PurchasePriceChange | Numeric | 1 | Purchase price change | |
6 | UnitPriceChange | Numeric | 1 | Unit price change | |
3 | ProductImages | Aggr. | 1 | Product images | |
4 | Image | Aggr. | 0...n | Product image | |
5 | NetvisorKey | Numeric | 1 | Image NetvisorKey | 12 |
5 | IsDefaultImage | String | 1 | Is the image product default image, true or false | false |
5 | MimeType | String | 1 | Image mime-type | image/jpeg |
5 | Title | String | 1 | Caption | Caption |
5 | FileName | String | 1 | Image file name | berlin-attractions-map-large.jpg |
5 | LastEditedDate | Date | 1 | Last modified time stamp | 2021-09-24 23:08 |
3 | ProductAttachments | Aggr. | 0...1 | Product attachments | |
4 | Attachment | Aggr. | 0...n | Product attachment | |
5 | NetvisorKey | Numeric | 1 | Attachment NetvisorKey | 10 |
5 | MimeType | String | 1 | Attachment mime-type | document/pdf |
5 | FileName | String | 1 | Attachment | berlin-attractions-map-large.pdf |
Did you find it helpful? Yes No
Send feedback