Resource: webshopproductlist.nv
HTTP-method: GET
Note! If Rackbeat inventory management is used in Netvisor, the API documentation can be found here: https://support.netvisor.fi/en/articles/766869-rackbeat-stoplight-api
This describes how a structural product list can be retrieved and can only be used by those who have extended product management in use. The list contains information about the product such as name and description in different languages, as well as information about the product variants. The resource returns models/features listed under the main product (no sub-products).
Querystring parameters:
Parameter | Occurs | Description | Example |
limitDeleted | 0...1 | When defined, only active main products are included in result | 1 |
limitActive | 0...1 | When defined, only active variants 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 | Filters products with changes after the given date and/or time. | 2016-01-28T12:00:00 |
limitSourceProductNetvisorKey | 0...1 | Limits result by given Netvisor product ID | 154 |
productGroupNetvisorKeys | 0...1 | Limits result by given Netvisor product group ID | 123 |
productGroupName | 0...1 | Name of the retrieved product group | Product group 1 |
productGroupNameKeyword | 0...1 | Beginning of the retrieved product group's name | Example product group |
productGroupNameFreeText | 0...1 | Name of the retrieved product group contains the given parameter | Product group |
excludeProductGroupNameFreeText | 0...1 | Name of the excluded product group contains the given parameter | Product group |
Response:
Level | Element | Type | Occurs | Description | Example |
Root | Root | Aggregate | 1 |
|
|
1 | WebShopProductList | Aggregate | 1 |
|
|
2 | WebShopProduct | Aggregate | 0...n |
|
|
3 | NetvisorKey | Numeric | 1 | Product's Netvisor ID | 145 |
3 | Name | String | 1...3 | Product name | Product |
Attr. | language | String | 1...3 | Language of the name: FI, EN or SE | FI |
3 | Description | String | 1...3 | Product description | This is a product |
Attr. | language | String | 1...3 | Language of the description: FI, EN or SE | FI |
3 | ProductCode | String | 1 | Product code | A123 |
3 | ProductGroup | Aggregate | 0...n |
|
|
4 | Name | String | 1...3 | Product group name | Group 1 |
Attr. | language | String | 1...3 | Language of the product group name: FI, EN or SE | FI |
3 | UnitNetPrice | Numeric | 1 | Unit price of the product | 12,00 |
3 | UnitGrossPrice | Numeric | 1 | Gross price of the product. Note, if the product is established in Netvisor with net price, the gross price is returned as 0.00. | 14,6 |
3 | Unit | String | 1 | Unit of measurement | pcs |
3 | UnitWeight | Numeric | 1 | Weight of the product | 1,50 |
3 | ImageURI | Text | 1 | URI for the product image | /webshopproductimages.nv? |
3 | URI | Text | 1 | URI for product information | /getproduct.nv?id=165 |
3 | InventoryAmount | Numeric | 1 | Amount of products in stock | 30,0 |
3 | InventoryOrderedAmount | Numeric | 1 | Amount of ordered products | 1,0 |
3 | InventoryReservedAmount | Numeric | 1 | Amount of reserved products | 3,00 |
3 | IsActive | Numeric | 1 | Is the product active: 0 = no / 1 = yes | 1 |
3 | IsSalesProduct | Numeric | 1 | Is the product for sale: 0 = no / 1 = yes | 1 |
3 | IsStorageProduct | Numeric | 1 | Is the product in stock: 0 = no / 1 = yes | 1 |
3 | DefaultVatPercentage | Numeric | 1 | VAT category | 22 |
3 | IsPublished | Numeric | 1 | Is the product published: 0 = no / 1 = yes | 1 |
3 | VersionNumber | Numeric | 1 | Product version number |
|
3 | PrimaryEANCode | Numeric | 1 | Primary EAN code of the product | 978020137962 |
3 | SecondaryEANCode | Numeric | 1 | Secondary EAN code of the product | 978020137963 |
3 | PriceGroups | Aggregate | 0...1 |
|
|
4 | PriceGroup | Aggregate | 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, either multiplier or fixed | multiplier |
3 | Variants | Aggregate | 1 |
|
|
4 | Variant | Aggregate | 0...n |
|
|
5 | Name | String | 1...3 | Variant name | Shirt, red |
Attr. | language | String | 1...3 | Language of variant name: FI, EN or SE | FI |
5 | Description | String | 1...3 | Variant description | Red shirt |
Attr. | language | String | 1...3 | Language of variant description: FI, EN or SE | FI |
5 | VariantIdentifier | String | 1 | Variant's Netvisor identifier | ABC002 |
5 | ImageUri | String | 1 | Uri for the variant image | /webshopproductimages.nv? |
5 | LastchangeDate | Date | 1 | Timestamp of the last change | 30.1.2014 10:12:06 |
5 | UnitNetPrice | Numeric | 1 | Net price of the variant | 1,00 |
5 | UnitGrossPrice | Numeric | 1 | Gross price of the variant | 1,22 |
5 | InventoryAmount | Numeric | 1 | Amount of variant in stock | 12,00 |
5 | InventoryOrderedAmount | Numeric | 1 | Amount ordered to stock | 12,00 |
5 | InventoryReservedAmount | Numeric | 1 | Amount reserved from stock | 12,00 |
5 | PrimaryEANCode | Numeric | 1 | Primary EAN code of the product | 978020137962 |
5 | SecondaryEANCode | Numeric | 1 | Secondary EAN code of the product | 978020137963 |
5 | PriceGroups | Aggregate | 0...1 |
|
|
6 | PriceGroup | Aggregate | 1...n |
|
|
7 | Description | Text | 1 | Description of the variant's price group |
|
Value | Numeric | 1 | Value of the price group |
| |
Attr. | type | Text | 1 | Type of value multiplier | multiplier |
5 | VariantProperties | Aggregate | 0...n |
|
|
6 | VariantProperty | String | 1 | Product feature | Material |
6 | VariantPropertyValue | String | 1 | Product feature value | Cotton |
3 | CustomTag | Aggregate | 0...n | Product additional information field |
|
4 | CustomTagName | String | 1 | Additional information field name | Additional information field |
4 | CustomTagValue | String | 1 | Additional information field value | Field 1 |
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.