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/support/solutions/articles/77000554491-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 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 |
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.