Skip to main content

orderItemAmounts

Use the orderItemAmounts data format creator to export the monetary amounts for order items and save this data in the cloud. The raw data file is stored in the cloud for a maximum of 6 months. Therefore, the data must be processed before this date. 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 orderItemAmounts format
Property Meaning Value Explanation

dataName

Name

orderItemAmounts

Name of the creator process and prefix of the created file.
File name: orderItemAmounts-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 8,000

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

limitDay

Lines per day

up to 640,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

oi_updated_at

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

defaultActive

Activated by default

yes

As standard, the export runs automatically in the background.

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 tariff

plentyBI XS

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

processableFromPlan

Usage starting from tariff

plentyBI L

Minimum fee plan required for making the data available in plentyBI Data Warehouse, i.e. for using, filtering and processing key figures.

2. Data columns

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

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

plenty_id

INTEGER NOT NULL

plenty id

ID of the plentymarkets system

oia_id (Primary key)

VARCHAR NOT NULL

order item amount ID

Contains the primary key of the data line.

oi_id

VARCHAR NOT NULL

order item ID

Order item ID

oia_is_system_currency

SMALLINT NOT NULL

order item amount is system currency

Flag that indicates whether the currency that is saved for the order item is the system currency
Possible values:
0 = No
1 = Yes

oi_price_gross

NUMERIC(17,4) NOT NULL

order item price gross

Gross price of the order item

oi_price_net

NUMERIC(17,4) NOT NULL

order item price net

Net price of the order item

oi_price_currency

VARCHAR NOT NULL

order item price currency

Currency of the order item price

oi_exchange_rate

NUMERIC(12,6) NOT NULL

order item exchange rate

Exchange rate of the currency that’s saved for the order item

oi_purchase_price

NUMERIC(17,4) NOT NULL

order item purchase price

Purchase price of the order item

oi_updated_at

TIMESTAMPTZ NOT NULL

order item updated at

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

oi_created_at

TIMESTAMPZ

order item created at

Time stamp of the creation
Date format: MM/DD/YY HH:MI:SS TZ

To top