Skip to main content

orderItemProperties

Use the orderItemProperties data format creator to export order items properties 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 orderItemProperties
Property Meaning Value Explanation

dataName

Name

orderItemProperties

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

oip_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 S

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

processableFromPlan

Usage starting from edition

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 orderItemProperties data columns included in the CSV file during raw data export.

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

plenty_id

INTEGER NOT NULL

plenty ID

ID of the plentymarkets system

oip_id (Primary key)

VARCHAR NOT NULL

order item property ID

ID of the order item property
Possible values:
1 = Warehouse
2 = Shipping profile
3 = Method of payment
11 = Weight
12 = Width
13 = Length
14 = Height
16 = External token ID
17 = External item ID
18 = Coupon code
19 = Coupon type
20 = Original warehouse
21 = Original stock
Further possible values are listed in our documentation for developers .

oi_id

VARCHAR NOT NULL

order item ID

ID of the order item (item ID)

op_type_id

INTEGER NOT NULL

order property type ID

ID of the order property type

oip_value

VARCHAR

order item property value

Value of the order item property

oip_updated_at

TIMESTAMPTZ NOT NULL

order item property updated at

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

o_created_at

TIMESTAMPZ

order created at

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

To top