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/articles/766869-rackbeat-stoplight-api
The resource extendedproductlist.nv can be used to retrieve model products and normal products but not main products or TEMP-products. The resource can be limited with several different parameters that can be found in the table below. The resource can also be used without extended product management, in which case all information may not be returned because it is not available.
The query returns published products, deleted products are never returned. If you want to retrieve unpublished products, the product list must be retrieved with the product NetvisorKey.
Parameter | Occurs | Description | Example |
replyoptions | 0...1 | Choose what information is returned in addition to basic information. Given as a numeric value or flag names. Options and flag values: | 3 |
searchlanguage | 0...1 | Choose which language version the search keywords are targeted to. Without extended product management only "fi" is available. | se |
productnetvisorkeys | 0...1 | Comma separated list of product NetvisorKey values. Can also have only one value. | 7,12 |
productnamekeyword | 0...1 | One keyword that is searched from the product name. | test |
productcodekeyword | 0...1 | One keyword that is searched from the product code. | ABC |
producteancode | 0...1 | Ean-code of the product to be retrieved. The code is compared to primary and secondary ean-codes. | |
onlysellableproducts | 0...1 | If the product is sellable. Values true or false. | true |
onlystoragedproducts | 0...1 | If the product is stored. Only relevant if stock management is in use. Values true or false. | false |
productchangedsince | 0...1 | If the product has been changed after the given date and time. One minute accuracy. Format yyyy-MM-ddTHH:mm | 2020-09-17T10:21 |
productgroupnetvisorkeys | 0...1 | Comma separated list of product group NetvisorKey values. Can also have only one value. | 7, 20 |
productgroupname | 0...1 | Name of the product group of the retrieved products. | Test product |
productgroupnamekeyword | 0...1 | Beginning of the product group name of the retrieved products. | Test |
productgroupnamefreetext | 0...1 | Name of the product group of the retrieved products contains the given parameter | Test |
excludeproductgroupnamefreetext | 0...1 | Name of the product group of the excluded products contains the given parameter | Test |
productgroupingcriterianame | 0...1 | Grouping criteria name of the retrieved products. | Grouping |
productsonpage | 0...1 | Maximum amount of products per page/message. (1-maximum amount set in Netvisor) | 2500 |
page | 0...1 | Number of the page to be returned. (1-number of pages in the search result) |
Some of the returned data is available only if the company uses extended product management, purchase order management or stock management. Otherwise the structure is returned the same regardless of whether extended product management is enabled or not.
The maximum size of the returned message is 25Mb. If the maximum is about to be exceeded, the Web Service Interface returns an error and an instruction on how to reduce the size of the message. No data is returned until the size of the message has been reduced.
With pagination you can set the maximum number of products per message (ProductsOnPage = 1 - maximum set in Netvisor) and retrieve a specific page (Page = 1 - PageCount). Pages must always be retrieved with the same search criteria. Please note that if the product register is edited between retrievals, exactly the same query can return a different result.
Read more about the terminology of extended product management here.
Response:
Level | Element | Type | Occurs | Description | Example |
Root | Root | Aggregate | 1 |
|
|
1 | Products | Aggregate | 1 | ||
2 | Product | Aggregate | 1 | ||
3 | NetvisorKey | Numeric | 1 | Product NetvisorKey | 13848 |
3 | ProductCodes | Aggregate | 1 | ||
4 | ProductCode | Numeric | 1 | Product code | 1 |
4 | ProductPrimaryEanCode | Numeric | 1 | Product primary ean-code | |
4 | ProductSecondaryEanCode | Numeric | 1 | Product secondary ean-code | |
3 | ProductNameTranslations | Aggregate | 1 | Product name translations | |
4 | Translation | String | 1 | Product name | Testituote |
Attr. | Language | String | 1 | FI, SE or EN | FI |
3 | ProductDescriptionTranslations | Aggregate | 1 | Product description translations | |
4 | Translation | String | 1 | Product description | Kuvaus |
Attr. | Language | String | 1 | FI, SE or EN | FI |
3 | ProductFeatures | Aggregate | 1 | Product features | |
4 | IsPublishedProduct | String | 1 | Is the product published, true or false | true |
4 | IsSellableProduct | String | 1 | Is the product sellable, true or false | true |
4 | IsStorageProduct | String | 1 | Is the product stored, true or false | false |
4 | IsProductStructureProduct | String | 1 | Is the product an extended product management product, true or false | false |
4 | IsModel | String | 1 | Is the product a model product, true or false | false |
4 | IsSummaryOfProducts | String | 1 | Is the product a summary product, true or false | false |
4 | LastChangedDate | Date | 1 | Last modified date | 2021-03-23 09:30 |
Attr. | Format | String | 1 | Date format, always ansi | ansi |
3 | ProductGroup | Aggregate | 1 | Product group | |
4 | NetvisorKey | Numeric | 0...1 | Product group NetvisorKey | 5 |
4 | ProductGroupTranslations | Aggregate | 0...1 | Product group translations | |
5 | Translation | String | 0...1 | Product group translation | Tuoteryhmä |
Attr. | language | String | 1 | FI, EN or SE | FI |
3 | ProductUnit | Aggregate | 1 | Product unit details | |
4 | NetvisorKey | Numeric | 0...1 | Unit NetvisorKey | 10 |
4 | ProductUnitTranslations | Aggregate | 0...1 | Unit translations | |
5 | Translation | String | 0...1 | Unit translation | kpl |
Attr. | language | String | 1 | FI, EN or SE | FI |
3 | ProductPriceInformation | Aggregate | 1 | Product price information | |
4 | DefaultNetPrice | Numeric | 1 | Product net price | 5,00 |
4 | DefaultGrossPrice | Numeric | 1 | Product gross price | 5,00 |
4 | Vat | Aggregate | 1 | Product VAT | |
5 | NetvisorKey | Numeric | 1 | VAT base NetvisorKey | 1 |
5 | Percentage | Numeric | 1 | VAT percentage | 0 |
4 | PriceMargin | Numeric | 1 | Lowest sales price | 8,00 |
4 | ProvisionPercentage | Numeric | 1 | Provision percentage | 2,00 |
4 | PriceGroups | Aggregate | 0...n | Price groups | |
5 | Group | Aggregate | 1 | ||
6 | NetvisorKey | Numeric | 1 | Price group NetvisorKey | 7 |
6 | PriceGroupName | String | 1 | Price group name | Price group |
6 | NetPrice | Numeric | 1 | Net price | 7,00 |
6 | GrossPrice | Numeric | 1 | Gross price | 9,00 |
4 | CustomerPrices | Aggregate | 0...n | Customer prices | |
5 | Customer | Aggregate | 1 | Customer | |
6 | NetvisorKey | Numeric | 1 | Customer NetvisorKey | 11 |
6 | CustomerCode | Numeric | 1 | Customer code | 1000 |
6 | CustomerName | String | 1 | Customer name | Customer |
6 | NetPrice | Numeric | 1 | Customer net price | 6,50 |
6 | GrossPrice | Numeric | 1 | Customer gross price | 8,05 |
3 | ProductPurchaseInformation | Aggregate | 0...1 | Purchase information | |
4 | DefaultPurchasePrice | Numeric | 1 | Product purchase price | 2,50 |
4 | DistirbuterPurchaseInformations | Aggregate | 0...1 | Vendor details | |
5 | Distributer | Aggregate | 1 | Vendor | |
6 | NetvisorKey | Numeric | 1 | Vendor NetvisorKey | 33587 |
6 | DistributerCode | Numeric | 1 | Vendor code | 855 |
6 | DistributerName | String | 1 | Vendor name | Distributer |
6 | DistributerProductCode | String | 1 | Vendor product code | abc |
6 | DistributerProductName | String | 1 | Vendor product name | Name |
6 | PurchasePrice | Numeric | 1 | Vendor purchase price | 1,50 |
6 | CurrencyAbbreviation | String | 1 | Vendor currency | SEK |
3 | ProductStorageInformation | Aggregate | 0...1 | Storage information | |
4 | DefaultInvetoryPlace | Aggregate | 1 | Default stock | |
5 | NetvisorKey | Numeric | 0...1 | Stock NetvisorKey | 17 |
5 | InventoryPlaceName | String | 0...1 | Stock name | Warehouse |
4 | InventoryPlaceShelves | Aggregate | 0...1 | Shelves | |
5 | InventoryPlaceShelve | Aggregate | 1 | Shelf | |
6 | InventoryPlaceNetvisorKey | Numeric | 1 | Stock NetvisorKey | 22 |
6 | InventoryPlaceName | String | 1 | Stock name | Warehouse 1 |
6 | ShelveNetvisorKey | Numeric | 1 | Shelf NetvisorKey | 31 |
6 | ShelveName | String | 1 | Shelf name | Shelve 1 |
4 | AlertLimit | Numeric | 1 | Alert limit | 10 |
4 | CustomsTariffHeader | String | 1 | Customs tariff header | Code |
4 | ProductBatchLinkingMode | Aggregate | 0...1 | Batch handling | |
5 | NetvisorKey | Numeric | 1 | Batch handling method NetvisorKey | 4 |
5 | Definition | String | 1 | Batch handling method type | OldestFirstByValueDate |
3 | ProductShipmentInformation | Aggregate | 0...1 | Product shipment information | |
4 | DefaultProductCountryOfOrigin | String | 1 | Product country of origin | SE |
Attr. | type | String | 1 | Always ISO-3166 | ISO-3166 |
4 | ProductNetWeight | Numeric | 1 | Product net weight | 0 |
Attr. | unit | String | 1 | Weight unit | g |
4 | ProductGrossWeigh | Numeric | 1 | Product gross weight | 0 |
Attr. | unit | String | 1 | Weight unit | g |
4 | ProductPackageWidth | Numeric | 1 | Package width | 0 |
Attr. | unit | String | 1 | Width unit | cm |
4 | ProductPackageHeight | Numeric | 1 | Package height | 0 |
Attr. | unit | String | 1 | Height unit | cm |
4 | ProductPackageLength | Numeric | 1 | Package length | 0 |
Attr. | unit | String | 1 | Length unit | cm |
3 | ProductGroupingCriterias | Aggregate | 0..n | Grouping criterias | |
4 | Translation | String | 1 | Grouping criteria name | TestGroup |
Attr. | language | String | 1 | FI, EN or SE | FI |
3 | ProductAccountInformation | Aggregate | 0...1 | Product accounting information | |
4 | DefaultDomesticAccountNumber | Numeric | 1 | Default account for domestic sales | 3000 |
4 | DefaultEuAccountNumber | Numeric | 1 | Default account for EU sales | 3360 |
4 | DefaultOutsideEUAccountNumber | Numeric | 1 | Default account for sales outside EU | 3380 |
4 | DefaultInventoryAccountNumber | Numeric | 1 | Default stock account | 1521 |
3 | ProductDimensionInformation | Aggregate | 0...1 | Product default Cost objects | |
4 | Dimension | Aggregate | 1 | ||
5 | NameNetvisorKey | Numeric | 1 | Cost object header NetvisorKey | 2 |
5 | DimensionNameName | String | 1 | Cost object header name | Dimension header |
5 | DetailNetvisorKey | Numeric | 1 | Cost object NetvisorKey | 15 |
5 | DimensionDetailName | String | 1 | Cost object name | Dimension |
5 | DimensionDetailCode | String | 0...1 | Cost object identifier | P001 |
3 | ProductInformationFields | Aggregate | 0...n | Product information fields | |
4 | InformationField | Aggregate | 1 | ||
5 | InformationFieldName | String | 1 | Information field name | Information field |
5 | InformationFieldItemValue | String | 1 | Information field value | 24 |
3 | ProductReferences | Aggregate | 0...1 | Product references | |
4 | RelatedProducts | Aggregate | 0...n | Main products/products related to the product | |
5 | Product | Aggregate | 1 | ||
6 | NetvisorKey | Numeric | 1 | Product NetvisorKey | 5 |
6 | ProductCode | Numeric | 1 | Product code | 1000 |
6 | ProductNameTranslations | Aggregate | 1 | Product name translations | |
7 | Translation | String | 1 | Product name | Product 7 |
Attr. | language | String | 1 | FI, EN or SE | EN |
4 | ComplementaryProducts | Aggregate | 0...n | Complementary main products/products | |
5 | Product | Aggregate | 1 | ||
6 | NetvisorKey | Numeric | 1 | Product NetvisorKey | 13 |
6 | ProductCode | Numeric | 1 | Product code | 2005 |
6 | ProductNameTranslations | Aggregate | 1 | Product name translations | |
7 | Translation | String | 1 | Product name | Product 10 |
Attr. | language | String | 1 | FI, EN or SE | EN |
3 | ProductProperties | Aggregate | 0...1 | Product properties | |
4 | Property | Aggregate | 0...n | Property | |
5 | NetvisorKey | Numeric | 1 | Property NetvisorKey | 88 |
5 | PropertyTranslations | Aggregate | 1 | Property translations | |
6 | Translation | String | 1 | Property name | |
Attr. | language | String | 1 | FI, EN or SE | FI |
5 | PropertyValues | Aggregate | 0...1 | Property values | |
6 | NetvisorKey | Numeric | 1 | Value NetvisorKey | 70 |
6 | PropertyValueTranslations | Aggregate | 1 | Value translations | |
7 | Translation | String | 1 | Value name | |
Attr. | language | String | 1 | FI, EN or SE | FI |
3 | SubProductInformation | Aggregate | 0...1 | Subproducts | |
4 | Parents | Aggregate | 0...n | Parents | |
5 | Product | Aggregate | 1 | ||
6 | NetvisorKey | Numeric | 1 | Product NetvisorKey | 55 |
6 | Amount | Numeric | 1 | Amount | 25 |
6 | PurchasePriceChange | Numeric | 1 | Purchase price change | |
6 | UnitPriceChange | Numeric | 1 | Unit price change | |
4 | Children | Aggregate | 1 | Children | |
5 | Product | Aggregate | 1 | ||
6 | NetvisorKey | Numeric | 1 | Product NetvisorKey | 47 |
6 | Amount | Numeric | 1 | Amount | 20 |
6 | PurchasePriceChange | Numeric | 1 | Purchase price change | |
6 | UnitPriceChange | Numeric | 1 | Unit price change | |
3 | ProductImages | Aggregate | 1 | Product images | |
4 | Image | Aggregate | 0...n | Product image | |
5 | NetvisorKey | Numeric | 1 | Image NetvisorKey | 12 |
5 | IsDefaultImage | String | 1 | Is the image product default image, true or false | false |
5 | MimeType | String | 1 | Image mime-type | image/jpeg |
5 | Title | String | 1 | Caption | Description |
5 | FileName | String | 1 | Image file name | berlin-attractions-map-large.jpg |
5 | LastEditedDate | Date | 1 | Last modified time stamp | 2021-09-24 23:08 |
3 | ProductAttachments | Aggregate | 0...1 | Product attachments | |
4 | Attachment | Aggregate | 0...n | Attachment | |
5 | NetvisorKey | Numeric | 1 | Attachment NetvisorKey | 10 |
5 | MimeType | String | 1 | Attachment mime-type | document/pdf |
5 | FileName | String | 1 | Attachment name | berlin-attractions-map-large.pdf |
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.