Resource: extendedproductlist.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

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:

ParameterOccursDescriptionExample
replyoptions0...1You 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
searchlanguage0...1Target 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
productnetvisorkeys0...1List of product NetvisorKey values separated with comma. Can also have only one value.7,12
productnamekeyword0...1One keyword to be retreived from the product name.test
productcodekeyword0...1One keyword to be retreived from the productcode.ABC
producteancode0...1Retreived product's ean-code. Compared to primary and secondary ean codes.
onlysellableproducts0...1If the product is sellable. true or false.true
onlystoragedproducts0...1If the product is storaged. Used only with stock management. true or false.false
productchangedsince0...1Has the product been changed since given date and time. One minute accuracy.2020-09-17T10:21
productgroupnetvisorkeys0...1List of product group NetvisorKey values separated with comma. Can also have one value.7, 20
productgroupname0...1Name of the retreived product group.Test product
productgroupnamekeyword0...1Keyword from the retreivced product group's name. Test
productgroupnamefreetext0...1Name of the retreived product group includes the given parameter value.
product
excludeproductgroupnamefreetext0...1Name of the retreived product group doesn includes the given parameter value.

productgroupingcriterianame0...1Grouping criteria name of the retreived products.Grouping
productsonpage0...1Maximum amount of products on page. (1-maximum amount in Netvisor)2500
page0...1The 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:

LevelElementTypeOccursDescriptionExample
RootRootAggr.1  
1ProductsAggr.1

2ProductAggr.1

3NetvisorKeyNumeric1Product NetvisorKey13848
3ProductCodesAggr.1

4ProductCodeNumeric1Product code1
4ProductPrimaryEanCodeNumeric1Primary ean-code
4ProductSecondaryEanCodeNumeric1Secondary ean-code
3ProductNameTranslationsAggr.1Product name translations
4TranslationString1Product nameTest product
Attr.LanguageString1FI, SE or ENEN
3ProductDescriptionTranslationsAggr.1Product description translations
4TranslationString1Product descriptionDescription
Attr.LanguageString1FI, SE or ENEN
3ProductFeaturesAggr.1
Product features
4IsPublishedProductString1Is the product published, true or falsetrue
4IsSellableProductString1Is the product sellable, true or falsetrue
4IsStorageProductString1Is the product storaged true or falsefalse
4IsProductStructureProductString1Is the product a structure product, true or falsefalse
4IsModelString1Is to product a model, true or falsefalse
4IsSummaryOfProductsString1 Is the product summary of products, true or falsefalse
4LastChangedDateDate1Last modified time stamp
2021-03-23 09:30
Attr.FormatString1Date format, always ansiansi
3ProductGroupAggr.1Product group
4NetvisorKeyNumeric0...1Product group NetvisorKey5
4ProductGroupTranslationsAggr.0...1Product group translations
5TranslationString0...1Product group nameProduct group
Attr.languageString1FI, EN or SEEN
3ProductUnitAggr.1Product unit details
4NetvisorKeyNumeric0...1Unit NetvisorKey10
4ProductUnitTranslationsAggr.0...1Unit translations
5TranslationString0...1Unit namepcs
Attr.languageString1FI, EN or SEEN
3ProductPriceInformationAggr.1Product price information
4DefaultNetPriceNumeric1Product net price5,00
4DefaultGrossPriceNumeric1Product gross price5,00
4VatAgge.1Product VAT
5NetvisorKeyNumeric1VAT base NetvisorKey1
5PercentageNumeric1VAT percentage0
4PriceMarginNumeric1Price margin8,00
4ProvisionPercentageNumeric1Provision percentage2,00
4PriceGroupsAggr.0...nPrice groups
5GroupAggr.1

6NetvisorKeyNumeric1Price group NetvisorKey7
6PriceGroupNameString1Price group namePrice group
6NetPriceNumeric1Net price7,00
6GrossPriceNumeric1Gross price
9,00
4CustomerPricesAggr.0...nCustomer prices
5CustomerAggr.1Customer
6NetvisorKeyNumeric1Customer NetvisorKey11
6CustomerCodeNumeric1Customer code1000
6CustomerNameString1Customer nameCustomer
6NetPriceNumeric1Customer net price6,50
6GrossPriceNumeric1Customer gross price8,05
3ProductPurchaseInformationAggr.0...1Purchase information
4DefaultPurchasePriceNumeric1Purchase price2,50
4DistirbuterPurchaseInformationsAggr.0...1Distributer purchase information
5DistributerAggr.1Distributer
6NetvisorKeyNumeric1Distributer NetvisorKey33587
6DistributerCodeNumeric1Distributer code855
6DistributerNameString1Distributer nameDistributer
6DistributerProductCodeString
1Distributer product codeabc
6DistributerProductNameString1Distributer product nameName
6PurchasePriceNumeric1Distributer purchase price1,50
6CurrencyAbbreviationString1Distributer currency
SEK
3ProductStorageInformationAggr.0...1Storage information
4DefaultInvetoryPlaceAggr.1Default inventory place
5NetvisorKeyNumeric0...1Inventory NetvisorKey17
5InventoryPlaceNameString0...1Inventory nameWarehouse
4InventoryPlaceShelvesAggr.0...1Inventory place shelves
5InventoryPlaceShelveAggr.1Inventory place shelve
6InventoryPlaceNetvisorKeyNumeric1Inventory place NetvisorKey22
6InventoryPlaceNameString1Inventory place nameWarehouse 1
6ShelveNetvisorKeyNumeric1Shelve NetvisorKey31
6ShelveNameString1Shelve nameShelve 1
4AlertLimitNumeric1Alert limit10
4CustomsTariffHeaderString1Customs tariff headerCode
4ProductBatchLinkingModeAggr.0...1Batch linking mode
5NetvisorKeyNumeric1Batch linking mode NetvisorKey4
5DefinitionString1Batch linking mode definitionOldestFirstByValueDate
3ProductShipmentInformationAggr.0...1Product shipment information
4DefaultProductCountryOfOriginString1Product country of originSE
Attr.typeString1Always ISO-3166ISO-3166
4ProductNetWeightNumeric1Product net weight0
Attr.unitString1Weight unitg
4ProductGrossWeighNumeric1Product gross weight0
Attr.unitString1Weight unitg
4ProductPackageWidthNumeric1Product package width0
Attr.unitString1Width unitcm
4ProductPackageHeightNumeric1Product package height0
Attr.unitString
1Height unitcm
4ProductPackageLengthNumeric1Product package length0
Attr.unitString1Length unitcm
3ProductGroupingCriteriasAggr.0..nGrouping criterias
4TranslationString1Grouping criteria nameTestGroup
Attr.languageString1FI, EN or SEEN
3ProductAccountInformation
Aggr.0...1Account information

4DefaultDomesticAccountNumberNumeric1Domestic sales account number3000
4DefaultEuAccountNumberNumeric1EU sales account number3360
4DefaultOutsideEUAccountNumberNumeric1Outside EU sales account number
3380
4DefaultInventoryAccountNumberNumeric1Inventory account number1521
3ProductDimensionInformation
Aggr.0...1Product dimension information
4DimensionAggr.1

5NameNetvisorKeyNumeric1Dimension header NetvisorKey2
5DimensionNameNameString1Dimension header nameDimension header
5DetailNetvisorKeyNumeric1Dimension detail NetvisorKey15
5DimensionDetailNameString1Dimension detail nameDimension
3ProductInformationFields
Aggr.0...nProduct information fields
4InformationField
Aggr.1Product information field
5InformationFieldNameString1Information field nameInformation field
5InformationFieldItemValueString1Information field value24
3ProductReferences
Aggr.0...1Product references
4RelatedProducts
Aggr.0...nRelated products
5ProductAggr.1Related product
6NetvisorKeyNumeric1Related product NetvisorKey
5
6ProductCodeNumeric1Related product code1000
6ProductNameTranslations
Aggr.1Related product name translations
7TranslationString1Related product nameProduct 7
Attr.languageString1FI, EN or SEEN
4ComplementaryProducts
Aggr.0...nComplementary products
5ProductAggr.1Complementary product
6NetvisorKeyNumeric1Complementary product NetvisorKey13
6ProductCodeNumeric1Complementary product code2005
6ProductNameTranslationsAggr.1Complementary product translations

7TranslationString1Complementary product name
Product 10
Attr.languageString1FI, EN or SEEN
3ProductProperties
Aggr.0...1Product properties
4PropertyAggr.0...nProperty
5NetvisorKeyNumeric1Property NetvisorKey88
5PropertyTranslations
Aggr.1Property translations
6TranslationString1Property name
Attr.languageString1Fi, EN or SEFI
5PropertyValuesAggr.0...1Property values
6NetvisorKeyNumeric1Value NetvisorKey70
6PropertyValueTranslationsAggr.1Value translations

7TranslationString1Value name
Attr.languageString1FI, EN or SEFI
3SubProductInformationAggr.0...1Subproducts
4ParentsAggr.0...nParents
5ProductAggr.1Parent product
6NetvisorKeyNumeric1Parent product NetvisorKey55
6AmountNumeric1Amount25
6PurchasePriceChangeNumeric1Purchase price change
6UnitPriceChangeNumeric1Unit price change
4ChildrenAggr.1Children
5ProductAggr.1Child product
6NetvisorKeyNumeric1Child product NetvisorKey47
6AmountNumeric1Amount20
6PurchasePriceChangeNumeric1Purchase price change
6UnitPriceChangeNumeric1Unit price change
3ProductImagesAggr.1Product images
4ImageAggr.0...nProduct image
5NetvisorKeyNumeric1Image NetvisorKey12
5IsDefaultImageString1Is the image product default image, true or falsefalse
5MimeTypeString1Image mime-typeimage/jpeg
5TitleString1CaptionCaption
5FileNameString1Image file nameberlin-attractions-map-large.jpg
5LastEditedDateDate1Last modified time stamp2021-09-24 23:08
3ProductAttachmentsAggr.0...1Product attachments
4AttachmentAggr.0...nProduct attachment
5NetvisorKeyNumeric1Attachment NetvisorKey10
5MimeTypeString1Attachment mime-typedocument/pdf
5FileNameString1Attachmentberlin-attractions-map-large.pdf


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.