Skip to main content

Get warehouse report warehousereport.nv

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/articles/766869-rackbeat-stoplight-api

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

QueryString parameters:

Parameter

Occurs

Description

Example

report

1

Report:

productinventoryamounts

salesinventoryevents

purchaseorderinventoryevents

salesinventoryevents

Salesinventoryevents

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

Parameter

Occurs

Description

Example

page

0...1

Page, by default 1

1

salesentitiesonpage

0...1

Sales entities on page, by default 50000

50000

salesentitytype

1

Sales entity type:

salesorder or salesinvoice

salesorder

salesentitystatuses

0...1

Order state:

billed

delivered

undelivered


Invoice state:

open

unsent

paid

requested

collected

billed

salesentitiesnetvisorkeys

0...1

Order NetvisorKeys / Invoice NetvisorKeys, separated by comma.

158

customernetvisorkeys

0...1

Customer NetvisorKeys, separated by comma.

47

Response, when salesentitytype="salesorder":

Level

Element

Type

Occurs

Description

Example

Root

root

1

1

InventoryReport

Aggr.

1

Attr.

Report

String

1

Inventory report type

SalesInvetoryEvents

Attr.

TimeStamp

Date

1

Date and time

2021-10-26 10:49

2

SalesEntities

Aggr.

1

Attr.

CurrentPage

Numeric

1

Current page

1

Attr.

PageCount

Numeric

1

Pages

1

Attr.

SalesEntitiesOnPage

Numeric

1

Sales entities on page

50000

Attr.

SalesEntitiesOnPages

Numeric

1

Sales entities on pages

1

3

SalesEntity

Aggr.

1...n

Attr.

Type

String

1

Sales entity type

salesorder

4

NetvisorKey

Numeric

1

Sales order Netvisor-id

41

4

OrderNumber

Numeric

1

Sales order number

123456

4

OrderState

String

1

Sales order state

undelivered

4

Customer

Aggr.

1

5

NetvisorKey

Numeric

1

Customer Netvisor-id

89

5

CustomerName

String

1

Customer name

Example customer

4

SalesEntityProductLines

Aggr.

1

5

SalesEntityProductLine

Aggr.

1...n

6

NetvisorKey

Numeric

1

Product line Netvisor-id

5

6

OrderedAmount

Numeric

1

Product amount

10

6

InventoryEvents

Aggr.

1

7

InventoryEvent

Aggr.

1...n

Attr.

Context

String

1

Inventory event context

salesorder

8

NetvisorKey

Numeric

1

Inventory event Netvisor-id

876

8

EventType

Aggr.

1

9

NetvisorKey

Numeric

1

Inventory event type Netvisor-id

1

9

EventTypeDescription

String

1

Inventory event description

Sales

8

EventStatus

String

1

Inventory event status

open

8

EventDate

Date

1

Inventory event date

2021-03-16

8

DeliveryDate

Date

1

Delivery date

2021-03-16

8

Product

Aggr.

1

9

NetvisorKey

Numeric

1

Product Netvisor-id

74

9

ProductCodes

Aggr.

1

10

ProductCode

String

1

Product code

1234

10

ProductsPrimaryEanCode

Numeric

1

Products primary EAN-code

123456789012

10

ProductsSecondaryEanCode

Numeric

1

Products secondary EAN-code

123456789012

9

ProductNameTranslations

Aggr.

1

10

Translation

String

1...3

Product name

Example product

Attr.

Language

String

1

Language of the product name

EN

9

ProductUnit

Aggr.

1

10

NetvisorKey

Numeric

1

Product unit Netvisor-id

3

10

ProductUnitTranslations

Aggr.

1

11

Translation

String

1...3

Product unit

pcs

Attr.

Language

String

1

Language of the product unit

EN

8

InventoryPlace

Aggr.

1

9

NetvisorKey

Numeric

1

Inventory Netvisor-id

3

9

InventoryPlaceName

String

1

Inventory description, inventory location

Inventory-description, inventory-location

9

InventoryPlaceShelve

Aggr.

1

10

NetvisorKey

Numeric

0...1

Inventory shelve Netvisor-id

5

10

InventoryPlaceShelveName

String

0...1

Inventory shelve

Example shelve

8

Amount

Numeric

1

Product amount

-564

8

UnitPrice

Numeric

1

Product unit price

9,7

Attr.

PurchasePrice

Numeric

1

Product purchase price

9,7

Attr.

FreightRate

Numeric

1

Product freight rate

0

8

Description

String

1

Inventory event description

Example description

8

BatchInformation

Aggr.

1

9

BatchNumber

Numeric

1

Batch number

13

9

ManufactureDate

Date

1

Manufacture date

2021-09-23

9

PackagingDate

Date

1

Packing date

2021-09-23

9

BestBeforeDate

Date

1

Best before date

2021-09-23

9

UseByDate

Date

1

Use by date

2021-09-23

8

ShipmentInformation

Aggr.

1

9

CountryOfOrigin

String

1

Country of origin

FI

Attr.

Type

String

1

Always ISO-3166

ISO-3166

9

NetWeight

Numeric

1

Net weight

11,5

Attr.

Unit

String

1

Unit

mg

9

GrossWeight

Numeric

1

Gross weight

10

Attr.

Unit

String

1

Unit

mg

9

PackageWidth

Numeric

1

Package width

12,5

Attr.

Unit

String

1

Unit

cm

9

PackageHeight

Numeric

1

Package height

4,6

Attr.

Unit

String

1

Unit

cm

9

PackageLength

Numeric

1

Package length

7,9

Attr.

Unit

String

1

Unit

cm

8

EventLinks

Aggr.

1

9

TargetInventoryEvent

Aggr.

0...1

Attr.

Context

String

0...1

Linked inventory event context

manualpurchaseevents

Attr.

ContextNetvisorKey

Numeric

0...1

Context Netvisor-id

4

10

NetvisorKey

Numeric

0...1

Linked inventory event Netvisor-id

2140

10

EventType

Aggr.

0...1

11

NetvisorKey

Numeric

0...1

Linked inventory event type Netvisor-id

2

11

EventTypeDescription

String

0...1

Linked inventory event type description

Purchase

10

EventStatus

String

0...1

Linked inventory event status

handled

10

DeliveryDate

Date

0...1

Delivery date/arrival date

2021-11-06

10

Amount

Numeric

0...1

Amount

1968

10

UnitPrice

Numeric

0...1

Unit

9,7

10

AmountLeft

Numeric

0...1

Amount left

1210

Response, when salesentitytype="salesinvoice":

Level

Element

Type

Occurs

Description

Example

Root

root

1

1

InventoryReport

Aggr.

1

Attr.

Report

String

1

Inventory report type

SalesInvetoryEvents

Attr.

TimeStamp

Date

1

Date and time

2021-10-26 10:49

2

SalesEntities

Aggr.

1

Attr.

CurrentPage

Numeric

1

Current page

1

Attr.

PageCount

Numeric

1

Pages

1

Attr.

SalesEntitiesOnPage

Numeric

1

Sales entities on page

50000

Attr.

SalesEntitiesOnPages

Numeric

1

Sales entities on pages

1

3

SalesEntity

Aggr.

1...n

Attr.

Type

String

1

Sales entity type

salesinvoice

4

NetvisorKey

Numeric

1

Sales invoice Netvisor-id

41

4

InvoiceNumber

Numeric

1

Sales invoice number

123456

4

InvoiceState

String

1

Sales invoice status

unsent

4

Customer

Aggr.

1

5

NetvisorKey

Numeric

1

Customer Netvisor-id

89

5

CustomerName

String

1

Customer name

Example customer

4

SalesEntityProductLines

Aggr.

1

5

SalesEntityProductLine

Aggr.

1...n

6

NetvisorKey

Numeric

1

Product line Netvisor-id

5

6

InvoiceAmount

Numeric

1

Product amount

10

6

InventoryEvents

Aggr.

1

7

InventoryEvent

Aggr.

1...n

Attr.

Context

String

1

Inventory event context

salesinvoice

8

NetvisorKey

Numeric

1

Inventory event Netvisor-id

876

8

EventType

Aggr.

1

9

NetvisorKey

Numeric

1

Inventory event type Netvisor-id

1

9

EventTypeDescription

String

1

Inventory event type description

Sales

8

EventStatus

String

1

Inventory event status

handled

8

EventDate

Date

1

Inventory event date

2021-03-16

8

DeliveryDate

Date

1

Delivery date

2021-03-16

8

Product

Aggr.

1

9

NetvisorKey

Numeric

1

Product Netvisor-id

74

9

ProductCodes

Aggr.

1

10

ProductCode

String

1

Product code

1234

10

ProductsPrimaryEanCode

Numeric

1

Products primary EAN-code

12345689012

10

ProductsSecondaryEanCode

Numeric

1

Products secondary EAN-code

12345789012

9

ProductNameTranslations

Aggr.

1

10

Translation

String

1...3

Product name

Example product

Attr.

Language

String

1

Language of the product name

EN

9

ProductUnit

Aggr.

1

10

NetvisorKey

Numeric

1

Product unit Netvisor-id

3

10

ProductUnitTranslations

Aggr.

1

11

Translation

String

1...3

Product unit

pcs

Attr.

Language

String

1

Language of the product unit

EN

8

InventoryPlace

Aggr.

1

9

NetvisorKey

Numeric

1

Inventory Netvisor-id

3

9

InventoryPlaceName

String

1

Inventory description, inventory location

Inventory-description, inventory-location

9

InventoryPlaceShelve

Aggr.

1

10

NetvisorKey

Numeric

0...1

Inventory shelve Netvisor-id

1

10

InventoryPlaceShelveName

String

0...1

Inventory shelve name

Example shelve

8

Amount

Numeric

1

Product amount

-564

8

UnitPrice

Numeric

1

Product unit price

9,7

Attr.

PurchasePrice

Numeric

1

Product purchase price

9,7

Attr.

FreightRate

Numeric

1

Product freight rate

0

8

Description

String

1

Inventory event description

Example description

8

BatchInformation

Aggr.

1

9

BatchNumber

Numeric

1

Batch number

13

9

ManufactureDate

Date

1

Manufacture Date

2021-09-23

9

PackagingDate

Date

1

Packaging date

2021-09-23

9

BestBeforeDate

Date

1

Best before date

2021-09-23

9

UseByDate

Date

1

Use by date

2021-09-23

8

ShipmentInformation

Aggr.

1

9

CountryOfOrigin

String

1

Country of origin

FI

Attr.

Type

String

1

Always ISO-3166

ISO-3166

9

NetWeight

Numeric

1

Net weight

11,5

Attr.

Unit

String

1

Unit

mg

9

GrossWeight

Numeric

1

Gross weight

10

Attr.

Unit

String

1

Unit

mg

9

PackageWidth

Numeric

1

Package width

12,5

Attr.

Unit

String

1

Unit

cm

9

PackageHeight

Numeric

1

Package height

4,6

Attr.

Unit

String

1

Unit

cm

9

PackageLength

Numeric

1

Package length

7,9

Attr.

Unit

String

1

Unit

cm

8

EventLinks

Aggr.

1

9

TargetInventoryEvent

Aggr.

0...1

Attr.

Context

String

0...1

Linked inventory event context

manualpurchaseevents

Attr.

ContextNetvisorKey

Numeric

0...1

Context Netvisor-id

169

10

NetvisorKey

Numeric

0...1

Linked inventory event Netvisor-id

2140

10

EventType

Aggr.

0...1

11

NetvisorKey

Numeric

0...1

Linked inventory event type Netvisor-id

2

11

EventTypeDescription

String

0...1

Linked inventory event type description

Purchase

10

EventStatus

String

0...1

Linked inventory event status

handled

10

DeliveryDate

Date

0...1

Delivery date / Arrival date

2021-11-06

10

Amount

Numeric

0...1

Amount

1968,50

10

UnitPrice

Numeric

0...1

Unit price

9,7

10

AmountLeft

Numeric

0...1

Amount left

1210

Productinventoryamounts

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

Parameter

Occurs

Description

Example

page

0...1

Page, by default 1

1

productsonpage

0...1

Products on page, by default 50000

50000

searchlanguage

0...1

Search language, fi, se or en

fi

productnetvisorkeys

0...1

Product NetvisorKeys, separated by comma.

123

productnamekeyword

0...1

Keyword from the retreived product's name.

Example product

productcodekeyword

0...1

Keyword from the retreived product's product code.

Test

producteancode

0...1

Product EAN-code (primary/secondary)

123456789012

onlysellableproducts

0...1

Retrieve only sellable products, true or false

true

productchangedsince

0...1

Filters result to contain only products having change after given time, time in format yyyy-MM-ddTHH:mm:ss

2021-09-01T12:00:00

productgroupnetvisorkeys

0...1

Product group NetvisorKeys, separated by comma.

12

productgroupname

0...1

Retrieved product group's name

Example product group

productgroupnamekeyword

0...1

Keyword from the retreived product group's name.

Example

productgroupingcriterianame

0...1

Product grouping criteria name

Example grouping criteria

inventoryplacenetvisorkeys

0...1

Inventory NetvisorKeys, separated by comma.

54

inventoryplacename

0...1

Inventory name

Example inventory place

inventoryplaceshelfnetvisorkeys

0...1

Inventory shelf NetvisorKeys, separated by comma.

4

inventoryplaceshelfname

0...1

Inventory shelf name

Example shelf

Response:

Level

Element

Type

Occurs

Description

Example

Root

root

1

1

InventoryReport

Aggr.

1

Attr.

Report

String

1

Inventory report type

ProductInventoryAmounts

Attr.

TimeStamp

Date

1

Date and time

2021-10-26 10:49

2

Products

Aggr.

1

Attr.

CurrentPage

Numeric

1

Current page

1

Attr.

PageCount

Numeric

1

Pages

1

Attr.

ProductsOnPage

Numeric

1

Products on page

50000

Attr.

ProductsOnPages

Numeric

1

Products on pages

1

3

Product

Aggr.

1...n

4

NetvisorKey

Numeric

1

Product Netvisor-id

41

4

ProductCodes

Aggr.

1

5

ProductCode

String

1

Product code

Test product

5

ProductPrimaryEanCode

String

1

Product primary EAN-code

T1-PRIMARY-EAN

5

ProductSecondaryEanCode

String

1

Product secondary EAN-code

T1-SECONDARY-EAN

4

ProductNameTranslations

Aggr.

1

5

Translation

String

1...3

Product name

Example product

Attr.

Language

String

1

Language of the product name

EN

4

ProductUnit

Aggr.

1

5

NetvisorKey

Numeric

1

Product unit Netvisor-id

5

ProductUnitTranslations

Aggr.

1

6

Translation

String

1...3

Product unit

pcs

Attr.

Language

String

1

Language of the product unit

EN

4

ProductInventoryStatus

Aggr.

1

5

InventoryAmount

Numeric

1

Product inventory amount

209,12

5

OrderedAmount

Numeric

1

Product ordered amount

0

5

ReservedAmount

Numeric

1

Product reserved amount

0

4

ProductInventoryPrices

Aggr.

1

5

AverageUnitPrice

Numeric

1

Product average unit price

12,32402

5

MinimumUnitPrice

Numeric

1

Product minimum unit price

0

5

MaximumUnitPrice

Numeric

1

Product maximum unit price

15

4

ProductInventoryValue

Aggr.

1

5

InventoryValue

Numeric

1

Inventory value

4

InventoryPlaces

Aggr.

1

5

InventoryPlace

Aggr.

1...n

5

NetvisorKey

Numeric

1

Inventory NetvisorKey

5

InventoryPlaceName

String

1

Inventory description and location

Inventory-Description, Inventory-Location

5

InventoryPlaceStatus

Aggr.

1

6

InventoryAmount

Numeric

1

Product inventory amount in inventory

119,00

6

OrderedAmount

Numeric

1

Product ordered amount in inventory

0

6

ReservedAmount

Numeric

1

Product reserved amount in inventory

0

5

InventoryPlacePrices

Aggr.

1

6

AverageUnitPrice

Numeric

1

Product average unit price in inventory

14,08403

6

MinimumUnitPrice

Numeric

1

Product minimum unit price in inventory

0

6

MaximumUnitPrice

Numeric

1

Product maximum unit price in inventory

15

5

InventoryPlaceShelves

Aggr.

1

6

InventoryPlaceShelve

Aggr.

0...n

7

NetvisorKey

Numeric

1

Inventory shelve Netvisor-id

4

7

InventoryPlaceShelveName

String

1

Inventory shelve name

Example shelve

7

InventoryPlaceShelveStatus

Aggr.

1

8

InventoryAmount

Numeric

1

Product inventory amount in inventory shelve

119

8

OrderedAmount

Numeric

1

Product ordered amount in inventory shelve

0

8

ReservedAmount

Numeric

1

Product reserved amount in inventory shelve

0

Purchaseorderinventoryamounts

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

Parameter

Occurs

Description

Example

page

0...1

Page, by default 1

1

purchaseordersonpage

0...1

Purchase orders on page, by default 50000

50000

purchaseorderstatus

0...1

Purchase order status:

accepted

purchaserequest

sent

archived

accepted

purchaseordernetvisorkeys

0...1

Purchase order NetvisorKeys, separated by comma.

123

distributernetvisorkeys

0...1

Distributer NetvisorKeys, separated by comma.

158, 147

Response:

Level

Element

Type

Occurs

Description

Example

Root

root

1

1

InventoryReport

Aggr.

1

Attr.

Report

String

1

Inventory report type

PurchaseOrderInventoryEvents

Attr.

TimeStamp

Date

1

Date and time

2021-10-26 10:49

2

PurchaseOrders

Aggr.

1

Attr.

CurrentPage

Numeric

1

Current page

1

Attr.

PageCount

Numeric

1

Pages

1

Attr.

PurchaseOrdersOnPage

Numeric

1

Purchase orders on page

50000

Attr.

PurchaseOrdersOnPages

Numeric

1

Purchase orders on pages

1

3

PurchaseOrder

Aggr.

1...n

4

NetvisorKey

Numeric

1

Purchase order Netvisor-id

41

4

OrderNumber

Numeric

1

Purchase order number

17

4

OrderStatus

String

1

Purchase order status

sent

4

Distributer

Aggr.

1

5

NetvisorKey

Numeric

1

Distributer Netvisor-id

89

5

DistributerName

String

1

Distributer name

Example distributer

4

PurchaseOrderProductLines

Aggr.

1

5

PurchaseOrderProductLine

Aggr.

1...n

6

NetvisorKey

Numeric

1

Purchase order product line Netvisor-id

5

6

OrderedAmount

Numeric

1

Product amount

10

6

InventoryEvents

Aggr.

1

7

InventoryEvent

Aggr.

1...n

Attr.

Context

String

1

Inventory event context

purchaseorder

8

NetvisorKey

Numeric

1

Inventory event Netvisor-id

876

8

EventType

Aggr.

1

9

NetvisorKey

Numeric

1

Inventory event type Netvisor-id

1

9

EventTypeDescription

String

1

Inventory event type description

Purchase

8

EventStatus

String

1

Inventory event status

handled

8

EventDate

Date

1

Inventory event date

2021-03-16

8

DeliveryDate

Date

1

Delivery date

2021-03-16

8

Product

Aggr.

1

9

NetvisorKey

Numeric

1

Product Netvisor-id

74

9

ProductCodes

Aggr.

1

10

ProductCode

String

1

Product code

1234

10

ProductPrimaryEanCode

Numeric

1

Product primary EAN-code

123456789012

10

ProductSecondaryEanCode

Numeric

1

Product secondary EAN-code

123456789012

9

ProductNameTranslations

Aggr.

1

10

Translation

String

1...3

Product name

Example product

Attr.

Language

String

1

Language of the product name

EN

9

ProductUnit

Aggr.

1

10

NetvisorKey

Numeric

1

Product unit Netvisor-id

3

10

ProductUnitTranslations

Aggr.

1...3

11

Translation

String

1

Product unit

pcs

Attr.

Language

String

1

Language of the product unit

EN

8

InventoryPlace

Aggr.

1

9

NetvisorKey

Numeric

0...1

Inventory Netvisor-id

3

9

InventoryPlaceName

String

0...1

Inventory description, inventory location

Inventory-description, Inventory-location

9

InventoryPlaceShelve

Aggr.

0...1

10

NetvisorKey

Numeric

0...1

Inventory shelve Netvisor-id

5

10

InventoryPlaceShelveName

String

0..1

Inventory shelve name

Example shelve

8

Amount

Numeric

1

Product amount

-564

8

UnitPrice

Numeric

1

Product unit price

9,7

Attr.

PurchasePrice

Numeric

1

Product purchase price

9,7

Attr.

FreightRate

Numeric

1

Product freight rate

0

8

Description

String

1

Description

Example description

8

BatchInformation

Aggr.

1

9

BatchNumber

Numeric

1

Batch number

13

9

ManufactureDate

Date

1

Manufacture date

2021-09-23

9

PackagingDate

Date

1

Packaging date

2021-09-23

9

BestBeforeDate

Date

1

Best before date

2021-09-23

9

UseByDate

Date

1

Use by date

2021-09-23

8

ShipmentInformation

Aggr.

1

9

CountryOfOrigin

String

1

Country of origin

FI

Attr.

Type

String

1

Always ISO-3166

ISO-3166

9

NetWeight

Numeric

1

Net weight

11,5

Attr.

Unit

String

1

Unit

mg

9

GrossWeight

Numeric

1

Gross weight

10

Attr.

Unit

String

1

Unit

mg

9

PackageWidth

Numeric

1

Package width

12,5

Attr.

Unit

String

1

Unit

cm

9

PackageHeight

Numeric

1

Package height

4,6

Attr.

Unit

String

1

Unit

cm

9

PackageLength

Numeric

1

Paage length

7,9

Attr.

Unit

String

1

Unit

cm

8

EventLinks

Aggr.

1

9

SourceInventoryEvent

Aggr.

0...1

Attr.

Context

String

0...1

Linked inventory event context

production

Attr.

ContextNetvisorKey

Numeric

0...1

Context Netvisor-id

169

10

NetvisorKey

Numeric

0...1

Linked inventory event Netvisor-id

2140

10

EventType

Aggr.

0...1

11

NetvisorKey

Numeric

0...1

Linked inventory event type Netvisor-id

2

11

EventTypeDescription

String

0...1

Linked inventory event type description

Manufacture

10

EventStatus

String

0...1

Linked inventory event status

handled

10

DeliveryDate

Date

0...1

Delivery date/Arrival date

2021-11-06

10

Amount

Numeric

0...1

Amount

1968,50

10

UnitPrice

Numeric

0...1

Unit price

9,7

10

AmountLeft

Numeric

1

Amount left

1210

Did this answer your question?