Resource: getproduct.nv
HTTP-method: GET
Note! If you are using Rackbeat inventory management in Netvisor, the API documentation can be found here: https://support.netvisor.fi/en/articles/766869-rackbeat-stoplight-api
Before retrieving product information, a list of products must be requested to pick the identifier of the wanted product. Specific product information can be retrieved for one product using the identifier, or with parameters idlist and codelist you can retrieve information for max. 400 products at once.
Querystring parameters:
Parameter | Occurs | Example | Description |
id | 0...1 | 123 | Netvisor key of the wanted product. |
idlist | 0...1 | 1,2,3 | Returns full information of all the wanted products in one request, max. 400 IDs |
eancode | 0...1 | 123456789012 | EAN-code of the wanted product |
code | 0...1 | 123 | Product code of the wanted product |
codelist | 0...1 | 1,2,product... | Returns full information of all the wanted products using product code as the identifier |
showsubproducts | 0...1 | 1 | If 1, returns all the sub products as well |
replyoption | 0...1 | 1 | If 1, returns only active (not-deleted) products |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | root | Aggregate | 1 |
|
|
1 | Product | Aggregate | 1 |
|
|
2 | ProductBaseInformation | Aggregate | 0...n |
|
|
3 | NetvisorKey | Numeric | 1 | Netvisor key of the product | 165 |
3 | ProductCode | String | 1 | Product code | CC |
3 | ProductGroup | String | 1 | Product group name | Books |
3 | Name | String | 1 | Product name | Code Complete |
3 | Description | String | 1 | Description | Second edition |
3 | UnitPrice | Numeric | 1 | Unit price | 42,5 |
Attr. | type | String | 1 | Always net (without VAT). | net |
3 | UnitGrossPrice | Numeric | 1 | Gross unit price | 52,7 |
Attr. | type | String | 1 | Always gross (including VAT) | gross |
3 | Unit | String | 1 | Unit | pc |
3 | UnitWeight | Numeric | 1 | Weight of a single unit | 1 |
3 | PurchasePrice | Numeric | 1 | Purchase price | 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 | IsStorageProduct | Numeric | 1 | Is this a stock product: 0 = no, 1 = yes | 1 |
3 | CountryOfOrigin | String | 1 | Country of origin | FI |
Attr. | type | String | 1 | Always ISO-3166 | ISO-3166 |
2 | ProductBookKeepingDetails | Aggregate | 1 |
|
|
3 | DefaultVatPercent | Numeric | 1 | VAT rate | 24 |
3 | DefaultDomesticAccountNumber | Numeric | 1 | Domestic default account number |
|
3 | DefaultEuAccountNumber | Numeric | 1 | EU default account number |
|
3 | DefaultOutsideEuAccountnumber | Numeric | 1 | International default account number |
|
3 | ProductDimensions | Aggregate | 1 | ||
4 | Dimension | Aggregate | 0...n | ||
5 | DimensionName | String | 1 | Cost object header name | Wild animals |
Attr. | Netvisorkey | Numeric | 1 | ||
5 | DimensionItem | String | 1 | Cost object name | Giraffes |
Attr. | Netvisorkey | Numeric | 1 | ||
5 | DimensionItemName | String | 0...1 | Cost object name | Website renewal |
5 | DimensionItemCode | String | 0...1 | Cost object identifier | P001 |
2 | ProductInventoryDetails | Aggregate | 1 |
|
|
3 | InventoryAmount | Numeric | 1 | Amount in stock | 2,00 |
3 | InventoryMidPrice | Numeric | 1 | Average price | 5,0 |
3 | InventoryValue | Numeric | 1 | Inventory value: amount in stock * average price | 10,0000 |
3 | InventoryReservedAmount | Numeric | 1 | Amount reserved | 1,00 |
3 | InventoryOrderedAmount | Numeric | 1 | Amount ordered | 0,00 |
3 | InventoryAccountNumber | Numeric | 1 | Stock account | 1521 |
2 | ProductAdditionalInformation | Aggregate | 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 | Aggregate | 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 | 1 | Package height unit | cm | |
4 | PackageLength | Numeric | 1 | Package length in centimeters | 36,10 |
Attr. | unit | String | 1 | Package length 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 | Aggregate | 1 | ||
3 | Parents | Aggregate | 1 | Parent products | |
4 | Product | Aggregate | 0...n | ||
5 | Netvisorkey | Numeric | 1 | Netvisor key of the parent product | 784 |
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 | Aggregate | 1 | Sub products | |
4 | Product | Aggregate | 0...n | ||
5 | Netvisorkey | Numeric | 1 | Netvisor key of the subproduct | 784 |
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 |
This article has been translated using an AI-based translation tool. The contents or wording of these instructions may differ from those in other instructions or in the software.