Skip to main content

stockManagementStock

Use the stockManagementStock data format creator to export stock data and save this data in the cloud. Depending on the plentyBI edition that has been booked, the raw data file is stored in the cloud for 6 to 48 months. Therefore, the data must be processed before this period of time ends. More detailed information on the storage periods are available on the Managing reports page of the manual. The following tables contain further information about the format.

1. Technical specifications

See Table 1 for further information on the available properties and their corresponding values.

Table 1. Technical specifications of the format stockManagementStock
Property Meaning Value Explanation

dataName

Name

stockManagementStock

Name of the creator process and prefix of the created file.
File name: stockManagementStock-xxx.csv.gz

fileFormat

File format

CSV, GZIP

The data is provided as a GZIP-compressed CSV file (RFC 1952).

limitPage

Lines per request

up to 10,000

The maximum number of data rows that is written into a single file.

limitDay

Lines per day

up to 200,000

The maximum number of data rows that is written on one day in total.

earliestPossibleDataDate

Earliest point in time

2020-01-01

Point in time as of which the raw data can be collected. The data is filtered by the date saved in the dataUpdatedAtColumnName column.

filterType

Filter type

lastUpdate

Data are filtered based on the last update.

dataUpdatedAtColumnName

Column header

sms_updated_at

Name of the column that contains the time stamp of the last data update.

defaultActive

Activated by default

no

The data is only exported automatically in the background after you have activated the creator in the Setup » plentyBI » Raw data menu.

interval

Interval

daily

With this setting, all data that has been changed since the last run is exported once a day, usually during the night.

storableFromPlan

Storage starting from edition

plentyBI XS

Minimum fee plan required for saving the data in cloud storage and making it available via REST.

2. Data columns

See Table 2 for further information on the stockManagementStock data columns included in the CSV file during raw data export.

Table 2. Data columns of the format stockManagementStock
Column name Data type Full name Explanation

plenty_id

INTEGER NOT NULL

plenty id

ID of the plentymarkets system

sms_id (Primary key)

VARCHAR NOT NULL

stock management stock ID

Contains the primary key of the data line.

i_id

VARCHAR NOT NULL

item id

The item’s ID

iv_id

VARCHAR NOT NULL

item variation id

ID of the variation

smw_id

VARCHAR NOT NULL

stock management warehouse ID

ID of the warehouse

sms_physical

NUMERIC(8,2)

stock management stock physical

Quantity of items that are physically available in the warehouse (physical stock)

sms_reserved

NUMERIC(8,2)

stock management stock reserved

Quantity of stocked items that are reserved (partial quantity of the physical stock)

sms_net

NUMERIC(8,2)

stock management stock net

Quantity of stocked items available for sale (physical stock minus reserved stock = net stock) = Net stock

sms_reordered

NUMERIC(8,2)

stock management stock reordered

Quantity of reordered items for which incoming items has not yet been booked

sms_average_purchase_price

NUMERIC(10,4)

stock management stock average purchase price

Average purchase price of the item, depending on the purchase price settings made beforehand.

sms_updated_at

TIMESTAMPTZ NOT NULL

stock management stock updated at

Time stamp of the last update
Date format: MM/DD/YYYY HH:MI:SS TZ

To top