orderProperties
Use the orderProperties data format creator to export order properties 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.
Property | Meaning | Value | Explanation |
---|---|---|---|
dataName |
Name |
orderProperties |
Name of the creator process and prefix of the created file. |
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 |
op_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 orderProperties data columns included in the CSV file during raw data export.
Column name | Data type | Full name | Explanation |
---|---|---|---|
plenty_id |
INTEGER NOT NULL |
plenty ID |
ID of the plentymarkets system |
op_id (Primary key) |
VARCHAR NOT NULL |
order property ID |
ID of the order property |
o_id |
VARCHAR NOT NULL |
order ID |
ID of the order |
op_type_id |
INTEGER NOT NULL |
order property type ID |
ID of the order property type |
op_value |
VARCHAR |
order property value |
Value of the order property |
op_updated_at |
TIMESTAMPTZ NOT NULL |
order property updated at |
Time stamp of the last update |
o_created_at |
TIMESTAMPZ |
order created at |
Time stamp of the creation |