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

This resource allows retrieving different kinds of warehouse reports, depending on the QueryString parameters.

QueryString parameters:

ParameterOccurs
Description
Example
report
1Report:
productinventoryamounts
salesinventoryevents
purchaseorderinventoryevents
salesinventoryevents

Salesinventoryevents

When report=salesinventoryevents, also the following parameters can be used:

ParameterOccurs
Description
Example
page
0...1Page, by default 1
1
salesentitiesonpage0...1Sales entities on page, by default 5000050000
salesentitytype1Sales entity type:
salesorder or salesinvoice
salesorder
salesentitystatuses0...1Order state:
billed
delivered
undelivered

Invoice state:
open
unsent
paid
requested
collected
billed
salesentitiesnetvisorkeys0...1Order NetvisorKeys / Invoice NetvisorKeys, separated by comma.158
customernetvisorkeys0...1Customer NetvisorKeys, separated by comma.47

Response, when salesentitytype="salesorder":

Level
ElementType
Occurs
Description
Example
Rootroot
1  
1InventoryReport
Aggr.  
Attr.ReportString
1Inventory report type
SalesInvetoryEvents
Attr.
TimeStamp
Date
1Date and time
2021-10-26 10:49
2SalesEntitiesAggr.1

Attr.CurrentPageNumeric
1Current page
1
Attr.PageCountNumeric1Pages
1
Attr.SalesEntitiesOnPageNumeric1Sales entities on page
50000
Attr.SalesEntitiesOnPagesNumeric1Sales entities on pages
1
3SalesEntityAggr.1...n


Attr.TypeString1Sales entity type
salesorder
4NetvisorKeyNumeric1Sales order Netvisor-id
41
4OrderNumberNumeric1Sales order number
123456
4OrderStateString1Sales order state
undelivered
4CustomerAggr.1

5NetvisorKeyNumeric1Customer Netvisor-id89
5CustomerNameString1Customer name
Example customer
4SalesEntityProductLinesAggr.1

5SalesEntityProductLineAggr.1...n

6NetvisorKeyNumeric1Product line Netvisor-id5
6OrderedAmountNumeric1Product amount
10
6InventoryEventsAggr.1

7InventoryEventAggr.1...n

Attr.ContextString1Inventory event context
salesorder
8NetvisorKeyNumeric1Inventory event Netvisor-id876
8EventTypeAggr.1

9NetvisorKeyNumeric1Inventory event type Netvisor-id1
9EventTypeDescriptionString1Inventory event descriptionSales
8EventStatusString1Inventory event status
open
8EventDateDate1Inventory event date
2021-03-16
8DeliveryDateDate1Delivery date
2021-03-16
8ProductAggr.1

9NetvisorKeyNumeric1Product Netvisor-id74
9ProductCodesAggr.1

10ProductCodeString1Product code
1234
10ProductsPrimaryEanCodeNumeric1
Products primary EAN-code
123456789012
10ProductsSecondaryEanCodeNumeric1Products secondary EAN-code
123456789012
9ProductNameTranslations
Aggr.
1

10TranslationString1...3Product name
Example product
Attr.LanguageString1Language of the product name
EN
9ProductUnitAggr.1

10NetvisorKeyNumeric1Product unit Netvisor-id3
10ProductUnitTranslationsAggr.1

11TranslationString1...3Product unit
pcs
Attr.LanguageString1Language of the product unit
EN
8InventoryPlaceAggr.1

9NetvisorKeyNumeric1
Inventory Netvisor-id3
9InventoryPlaceNameString1
Inventory description, inventory locationInventory-description, inventory-location
9InventoryPlaceShelveAggr.
1


10NetvisorKeyNumeric0...1Inventory shelve Netvisor-id5
10InventoryPlaceShelveNameString
0...1Inventory shelve
Example shelve
8AmountNumeric1Product amount
-564
8UnitPriceNumeric1Product unit price
9,7
Attr.PurchasePriceNumeric1Product purchase price
9,7
Attr.FreightRateNumeric1Product freight rate
0
8DescriptionString1Inventory event description
Example description
8BatchInformationAggr.1

9BatchNumberNumeric
1Batch number
13
9ManufactureDateDate1Manufacture date
2021-09-23
9PackagingDateDate1Packing date2021-09-23
9BestBeforeDateDate1Best before date
2021-09-23
9UseByDateDate1Use by date
2021-09-23
8ShipmentInformationAggr.1

9CountryOfOriginString1Country of origin
FI
Attr.Type
String1Always ISO-3166ISO-3166
9NetWeightNumeric1Net weight11,5
Attr.UnitString1Unit
mg
9GrossWeightNumeric1Gross weight
10
Attr.UnitString1Unit
mg
9PackageWidthNumeric1Package width12,5
Attr.UnitString1Unit
cm
9PackageHeightNumeric1Package height4,6
Attr.UnitString
1Unit
cm
9PackageLengthNumeric1Package length7,9
Attr.UnitString1Unit
cm
8EventLinksAggr.1

9TargetInventoryEvent
Aggr.
0...1


Attr.ContextString0...1Linked inventory event context
manualpurchaseevents
Attr.ContextNetvisorKeyNumeric0...1Context Netvisor-id4
10NetvisorKeyNumeric0...1Linked inventory event Netvisor-id2140
10EventTypeAggr.0...1


11NetvisorKeyNumeric0...1
Linked inventory event type Netvisor-id2
11EventTypeDescriptionString0...1
Linked inventory event type description
Purchase
10EventStatusString0...1Linked inventory event statushandled
10DeliveryDateDate0...1Delivery date/arrival date2021-11-06
10AmountNumeric0...1Amount
1968
10UnitPriceNumeric0...1Unit
9,7
10AmountLeftNumeric0...1Amount left
1210

Response, when salesentitytype="salesinvoice":

Level
ElementType
Occurs
Description
Example
Rootroot
1  
1InventoryReport
Aggr.  
Attr.ReportString1Inventory report type
SalesInvetoryEvents
Attr.
TimeStamp
Date
1Date and time
2021-10-26 10:49
2SalesEntitiesAggr.1

Attr.CurrentPageNumeric
1Current page
1
Attr.PageCountNumeric1Pages
1
Attr.SalesEntitiesOnPageNumeric1Sales entities on page
50000
Attr.SalesEntitiesOnPagesNumeric1Sales entities on pages
1
3SalesEntityAggr.1...n

Attr.TypeString1Sales entity type
salesinvoice
4NetvisorKeyNumeric1Sales invoice Netvisor-id
41
4InvoiceNumberNumeric1Sales invoice number
123456
4InvoiceStateString1Sales invoice status
unsent
4CustomerAggr.1

5NetvisorKeyNumeric1Customer Netvisor-id89
5CustomerNameString1Customer name
Example customer
4SalesEntityProductLinesAggr.1

5SalesEntityProductLineAggr.1...n

6NetvisorKeyNumeric1Product line Netvisor-id5
6InvoiceAmountNumeric1Product amount
10
6InventoryEventsAggr.1

7InventoryEventAggr.1...n

Attr.ContextString1Inventory event context
salesinvoice
8NetvisorKeyNumeric1Inventory event Netvisor-id876
8EventTypeAggr.1

9NetvisorKeyNumeric1Inventory event type Netvisor-id1
9EventTypeDescriptionString1Inventory event type description
Sales
8EventStatusString1Inventory event status
handled
8EventDateDate1Inventory event date
2021-03-16
8DeliveryDateDate1Delivery date
2021-03-16
8ProductAggr.1

9NetvisorKeyNumeric1Product Netvisor-id74
9ProductCodesAggr.1

10ProductCodeString1Product code
1234
10ProductsPrimaryEanCodeNumeric1
Products primary EAN-code
12345689012
10ProductsSecondaryEanCodeNumeric1Products secondary EAN-code
12345789012
9ProductNameTranslations
Aggr.
1

10TranslationString1...3Product name
Example product
Attr.LanguageString1Language of the product name
EN
9ProductUnitAggr.1

10NetvisorKeyNumeric1Product unit Netvisor-id3
10ProductUnitTranslationsAggr.1

11TranslationString1...3Product unit
pcs
Attr.LanguageString1Language of the product unit
EN
8InventoryPlaceAggr.1

9NetvisorKeyNumeric1
Inventory Netvisor-id3
9InventoryPlaceNameString1
Inventory description, inventory locationInventory-description, inventory-location
9InventoryPlaceShelveAggr.
1


10NetvisorKeyNumeric0...1Inventory shelve Netvisor-id1
10InventoryPlaceShelveNameString0...1Inventory shelve name
Example shelve
8AmountNumeric1Product amount
-564
8UnitPriceNumeric1Product unit price
9,7
Attr.PurchasePriceNumeric1Product purchase price
9,7
Attr.FreightRateNumeric1Product freight rate
0
8DescriptionString1Inventory event description
Example description
8BatchInformationAggr.1

9BatchNumberNumeric
1Batch number
13
9ManufactureDateDate1Manufacture Date
2021-09-23
9PackagingDateDate1Packaging date2021-09-23
9BestBeforeDateDate1Best before date
2021-09-23
9UseByDateDate1Use by date
2021-09-23
8ShipmentInformationAggr.1

9CountryOfOriginString1Country of origin
FI
Attr.Type
String1Always ISO-3166ISO-3166
9NetWeightNumeric1Net weight11,5
Attr.UnitString1Unit
mg
9GrossWeightNumeric1Gross weight
10
Attr.UnitString1Unit
mg
9PackageWidthNumeric1Package width12,5
Attr.UnitString1Unit
cm
9PackageHeightNumeric1Package height4,6
Attr.UnitString1Unit
cm
9PackageLengthNumeric1Package length
7,9
Attr.UnitString1Unit
cm
8EventLinksAggr.1

9TargetInventoryEvent
Aggr.
0...1


Attr.ContextString0...1Linked inventory event context
manualpurchaseevents
Attr.ContextNetvisorKeyNumeric0...1Context Netvisor-id169
10NetvisorKeyNumeric0...1Linked inventory event Netvisor-id2140
10EventTypeAggr.0...1


11NetvisorKeyNumeric0...1
Linked inventory event type Netvisor-id2
11EventTypeDescriptionString0...1
Linked inventory event type descriptionPurchase
10EventStatusString0...1Linked inventory event statushandled
10DeliveryDateDate0...1Delivery date / Arrival date
2021-11-06
10AmountNumeric0...1Amount
1968,50
10UnitPriceNumeric0...1Unit price
9,7
10AmountLeftNumeric0...1Amount left
1210

Productinventoryamounts

When report=productinventoryamounts, also the following parameters can be used:

ParameterOccurs
Description
Example
page
0...1Page, by default 1
1
productsonpage
0...1Products on page, by default 5000050000
searchlanguage0...1Search language, fi, se or en
fi
productnetvisorkeys
0...1Product NetvisorKeys, separated by comma.
123
productnamekeyword
0...1
Keyword from the retreived product's name.
Example product
productcodekeyword
0...1Keyword from the retreived product's product code.
Test
producteancode0...1Product EAN-code (primary/secondary)123456789012
onlysellableproducts0...1Retrieve only sellable products, true or falsetrue
productchangedsince
0...1Filters result to contain only products having change after given time, time in format yyyy-MM-ddTHH:mm:ss2021-09-01T12:00:00
productgroupnetvisorkeys0...1Product group NetvisorKeys, separated by comma.
12
productgroupname0...1Retrieved product group's nameExample product group
productgroupnamekeyword0...1Keyword from the retreived product group's name.
Example
productgroupingcriterianame0...1Product grouping criteria name
Example grouping criteria
inventoryplacenetvisorkeys0...1Inventory NetvisorKeys, separated by comma.
54
inventoryplacename0...1Inventory name
Example inventory place
inventoryplaceshelfnetvisorkeys0...1Inventory shelf NetvisorKeys, separated by comma.
4
inventoryplaceshelfname0...1Inventory shelf nameExample shelf

Response: 

Level
ElementType
Occurs
Description
Example
Rootroot
1  
1InventoryReport
Aggr.  
Attr.ReportString
1Inventory report type
ProductInventoryAmounts
Attr.
TimeStamp
Date
1Date and time
2021-10-26 10:49
2Products
Aggr.1

Attr.CurrentPageNumeric
1Current page
1
Attr.PageCountNumeric1Pages
1
Attr.ProductsOnPageNumeric1Products on page
50000
Attr.ProductsOnPagesNumeric1Products on pages
1
3Product
Aggr.1...n

4NetvisorKeyNumeric1Product Netvisor-id
41
4ProductCodes
Aggr.1

5ProductCode
String
1Product code
Test product
5ProductPrimaryEanCode
String
1Product primary EAN-code
T1-PRIMARY-EAN
5ProductSecondaryEanCodeString1Product secondary EAN-code
T1-SECONDARY-EAN
4ProductNameTranslations
Aggr.1

5TranslationString1...3Product name
Example product
Attr.LanguageString1Language of the product name
EN
4ProductUnitAggr.1

5NetvisorKeyNumeric1Product unit Netvisor-id
5ProductUnitTranslationsAggr.1

6TranslationString1...3Product unit
pcs
Attr.LanguageString1Language of the product unit
EN
4ProductInventoryStatusAggr.1

5InventoryAmountNumeric1Product inventory amount
209,12
5OrderedAmountNumeric1Product ordered amount
0
5ReservedAmountNumeric1Product reserved amount
0
4ProductInventoryPricesAggr.1

5AverageUnitPriceNumeric1Product average unit price12,32402
5MinimumUnitPriceNumeric1Product minimum unit price
0
5MaximumUnitPriceNumeric1Product maximum unit price
15
4ProductInventoryValueAggr.1

5InventoryValueNumeric1Inventory value
4InventoryPlacesAggr.1

5InventoryPlaceAggr.1...n

5NetvisorKeyNumeric1Inventory NetvisorKey
5InventoryPlaceNameString1Inventory description and locationInventory-Description, Inventory-Location
5InventoryPlaceStatusAggr.1

6InventoryAmountNumeric1Product inventory amount in inventory
119,00
6OrderedAmountNumeric1Product ordered amount in inventory
0
6ReservedAmountNumeric1Product reserved amount in inventory
0
5InventoryPlacePricesAggr.1

6AverageUnitPriceNumeric1Product average unit price in inventory
14,08403
6MinimumUnitPriceNumeric1Product minimum unit price in inventory
0
6MaximumUnitPriceNumeric1Product maximum unit price in inventory
15
5InventoryPlaceShelvesAggr.1

6InventoryPlaceShelveAggr.0...n

7NetvisorKeyNumeric1Inventory shelve Netvisor-id
4
7InventoryPlaceShelveNameString1Inventory shelve name
Example shelve
7InventoryPlaceShelveStatusAggr.1

8InventoryAmountNumeric1Product inventory amount in inventory shelve
119
8OrderedAmountNumeric1Product ordered amount in inventory shelve
0
8ReservedAmountNumeric1Product reserved amount in inventory shelve
0

Purchaseorderinventoryamounts

When report=purchaseorderinventoryamounts, also the following parameters can be used:

ParameterOccurs
Description
Example
page
0...1Page, by default 1
1
purchaseordersonpage0...1Purchase orders on page, by default 5000050000
purchaseorderstatus
0...1Purchase order status:
accepted 
purchaserequest
sent
archived
accepted
purchaseordernetvisorkeys
0...1Purchase order NetvisorKeys, separated by comma.123
distributernetvisorkeys
0...1Distributer NetvisorKeys, separated by comma.158, 147

Response:

LevelElementType
OccursDescription
Example
Rootroot
1  
1InventoryReport
Aggr.  
Attr.ReportString
1Inventory report type
PurchaseOrderInventoryEvents
Attr.
TimeStamp
Date
1Date and time
2021-10-26 10:49
2PurchaseOrders
Aggr.1

Attr.CurrentPageNumeric
1Current page
1
Attr.PageCountNumeric1Pages
1
Attr.PurchaseOrdersOnPageNumeric1Purchase orders on page
50000
Attr.PurchaseOrdersOnPagesNumeric1Purchase orders on pages
1
3PurchaseOrder
Aggr.1...n

4NetvisorKeyNumeric1Purchase order Netvisor-id
41
4OrderNumberNumeric1Purchase order number
17
4OrderStatusString1Purchase order status
sent
4Distributer
Aggr.1

5NetvisorKeyNumeric1Distributer Netvisor-id89
5DistributerNameString1Distributer name
Example distributer
4PurchaseOrderProductLinesAggr.1

5PurchaseOrderProductLineAggr.1...n

6NetvisorKeyNumeric1Purchase order product line Netvisor-id5
6OrderedAmountNumeric1Product amount
10
6InventoryEventsAggr.1

7InventoryEventAggr.1...n

Attr.ContextString1Inventory event context
purchaseorder
8NetvisorKeyNumeric1Inventory event Netvisor-id876
8EventTypeAggr.1

9NetvisorKeyNumeric1Inventory event type Netvisor-id1
9EventTypeDescriptionString1Inventory event type description
Purchase
8EventStatusString1Inventory event status
handled
8EventDateDate1Inventory event date
2021-03-16
8DeliveryDateDate
1Delivery date
2021-03-16
8ProductAggr.1

9NetvisorKeyNumeric
1Product Netvisor-id74
9ProductCodesAggr.1

10ProductCodeString1Product code
1234
10ProductPrimaryEanCodeNumeric1
Product primary EAN-code
123456789012
10ProductSecondaryEanCodeNumeric1Product secondary EAN-code
123456789012
9ProductNameTranslations
Aggr.
1

10TranslationString1...3Product name
Example product
Attr.LanguageString1Language of the product name
EN
9ProductUnitAggr.1

10NetvisorKeyNumeric1Product unit Netvisor-id3
10ProductUnitTranslationsAggr.1...3

11TranslationString1Product unit
pcs
Attr.LanguageString1Language of the product unit
EN
8InventoryPlaceAggr.1

9NetvisorKeyNumeric0...1
Inventory Netvisor-id3
9InventoryPlaceNameString0...1
Inventory description, inventory locationInventory-description, Inventory-location
9InventoryPlaceShelveAggr.
0...1


10NetvisorKeyNumeric0...1Inventory shelve Netvisor-id5
10InventoryPlaceShelveNameString
0..1Inventory shelve name
Example shelve
8AmountNumeric1Product amount
-564
8UnitPriceNumeric1Product unit price
9,7
Attr.PurchasePriceNumeric1Product purchase price
9,7
Attr.FreightRateNumeric1Product freight rate
0
8DescriptionString1Description
Example description
8BatchInformationAggr.1

9BatchNumberNumeric
1Batch number
13
9ManufactureDateDate1Manufacture date
2021-09-23
9PackagingDateDate1Packaging date2021-09-23
9BestBeforeDateDate1Best before date
2021-09-23
9UseByDateDate1Use by date
2021-09-23
8ShipmentInformationAggr.1

9CountryOfOriginString1Country of origin
FI
Attr.Type
String1Always ISO-3166ISO-3166
9NetWeightNumeric1Net weight11,5
Attr.UnitString1Unit
mg
9GrossWeightNumeric1Gross weight
10
Attr.UnitString1Unit
mg
9PackageWidthNumeric1Package width12,5
Attr.UnitString1Unit
cm
9PackageHeightNumeric1Package height4,6
Attr.UnitString1Unit
cm
9PackageLengthNumeric1Paage length7,9
Attr.UnitString1Unit
cm
8EventLinksAggr.1

9SourceInventoryEvent
Aggr.
0...1

Attr.ContextString0...1Linked inventory event context
production
Attr.ContextNetvisorKeyNumeric0...1Context Netvisor-id169
10NetvisorKeyNumeric0...1Linked inventory event Netvisor-id2140
10EventTypeAggr.0...1


11NetvisorKeyNumeric0...1
Linked inventory event type Netvisor-id2
11EventTypeDescriptionString0...1
Linked inventory event type descriptionManufacture
10EventStatusString0...1Linked inventory event statushandled
10DeliveryDateDate
0...1Delivery date/Arrival date2021-11-06
10AmountNumeric0...1Amount
1968,50
10UnitPriceNumeric0...1Unit price
9,7
10AmountLeftNumeric1Amount left
1210


Did you find it helpful? Yes No

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