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