orders
Use the orders data format creator to export orders 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.
| Property | Meaning | Value | Explanation |
|---|---|---|---|
dataName |
Name |
orders |
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 5,000 |
The maximum number of data rows that is written into a single file. |
limitDay |
Lines per day |
up to 500,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 |
o_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 edition |
plentyBI XS |
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 orders 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 |
o_id (Primary key) |
VARCHAR NOT NULL |
order ID |
ID of the order |
o_plenty_id |
INTEGER NOT NULL |
order plenty ID |
ID of the plentymarkets system or the client via which the order was created |
o_origin_order_ID |
VARCHAR |
order origin order ID |
ID of the main order. This ID is only exported for order types that are assigned to a so-called main order (e.g. credit notes, returns and delivery orders). |
os_id |
NUMERIC(6,4) NOT NULL |
order status |
Status of the order in decimal format. Depending on the statuses set up in the system, numbers with up to 4 decimal places are exported. You can find the IDs of the standard statuses on the Internal IDs in plentymarkets page of the manual. |
o_referrer |
NUMERIC(5,2) |
order referrer |
Referrer of the order. |
o_global_referrer |
NUMERIC(5,2) |
order global referrer |
Global referrer of the order |
o_type |
VARCHAR NOT NULL |
order type |
Order type |
o_is_main_order |
SMALLINT NOT NULL |
order is main order |
Indicates whether the order is a main order. |
o_is_net |
SMALLINT NOT NULL |
order is net |
Indicates whether the order was billed as net or gross. |
o_is_b2b |
SMALLINT NOT NULL |
order is b2b |
Indicates whether it is a B2B order. |
ac_id |
VARCHAR NOT NULL |
account contact id |
ID of the contact that is assigned to the order |
o_payment_status |
SMALLINT NOT NULL |
order payment status |
Payment status of the order |
o_invoice_postal_code |
VARCHAR |
order invoice postal code |
Postcode listed in the invoice address |
o_invoice_town |
VARCHAR |
order invoice town |
Town listed in the invoice address |
o_invoice_country |
VARCHAR |
order invoice country |
Country listed in the invoice address (ISO2 code) |
o_delivery_postal_code |
VARCHAR |
order delivery postal code |
Postcode listed in the delivery address |
o_delivery_town |
VARCHAR |
order delivery town |
Town listed in the delivery address |
o_delivery_country |
VARCHAR |
order delivery country |
Country listed in the delivery address (ISO2 code) |
o_shipping_profile |
INTEGER NOT NULL |
order shipping profile |
ID of the shipping profile of the order |
o_parcel_service |
INTEGER NOT NULL |
order parcel service |
Shipping service provider of the order |
smw_id |
VARCHAR |
stock management warehouse ID |
ID of the warehouse associated with the order |
smw_country |
VARCHAR |
stock management warehouse country |
Country of the warehouse associated with the order |
smw_postal_code |
VARCHAR |
stock management warehouse postal code |
Postcode of the warehouse associated with the order |
o_entry_at |
TIMESTAMPTZ NOT NULL |
order entry at |
Timestamp of the entry of the order. This date is editable in the user interface in the back end. If no change has been made, this field is identical to the existing field o_created_at (timestamp at which the order has been saved in the database). |
o_created_at |
TIMESTAMPTZ NOT NULL |
order created at |
Time stamp of the order creation |
o_goods_issue_at |
TIMESTAMPZ |
order goods issue at |
Time stamp for booking outgoing items |
o_paid_at |
TIMESTAMPZ |
order paid at |
Time stamp for booking the incoming payment |
o_updated_at |
TIMESTAMPTZ NOT NULL |
order updated at |
Time stamp of the last order update |