Skip to main content

orderItems

Using the orderItems data format creator, you can export properties of order items and save it in the cloud. For more information on the properties of the format, see the following tables.

1. Technical specifications

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

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

dataName

Name

orderItems

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

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

earliestPossibleDataDate

Earliest point in time

2016-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.

deleteRawDataAfterDaysMinimum

Minimum number of days until the data is deleted

1095

The minimum number of days until the generated raw data file is deleted from the cloud storage. Therefore, the data must be processed before this date. The exact duration can be defined in the Data » Raw data menu.

deleteRawDataAfterDaysMaximum

Maximum number of days until the data is deleted

1095

The maximum number of days until the generated raw data file is deleted from the cloud storage. Therefore, the data must be processed before this date. The exact duration can be defined in the Data » Raw data menu.

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.

filterType

Filter type

lastUpdate

Data are filtered based on the last update.

2. Data columns

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

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

plenty_id

INTEGER NOT NULL

plenty id

ID of the plentymarkets system

oi_id (Primary key)

VARCHAR NOT NULL

order item ID

ID of the order item

o_id

VARCHAR NOT NULL

order ID

ID of the order

iv_id

VARCHAR NOT NULL

item variation id

Variation ID of the order item

i_id

VARCHAR NOT NULL

item id

Item ID of the order item

oi_quantity

DECIMAL(8,2) NOT NULL

order item quantity

Quantity of the order items contained in the order

oi_type_id

INTEGER NOT NULL

order item type id

ID of the order item type.
Possible values:
1= Variation
2 = Bundle
3 = Bundle component
4 = Promotional coupon
5 = Gift card
6 = Shipping costs
7 = Surcharge (depending on the payment method)
8 = Gift wrap
9 = Unassigned variation
10 = Deposit
11 = Order (e.g. with multi-orders)

smw_id

VARCHAR NOT NULL

stock management warehouse id

ID of the warehouse that is assigned to the order item

oi_updated_at

TIMESTAMPTZ

order item updated at

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

To top