Skip to main content

orderDocuments

Use the orderDocuments data format creator to export Order documents and save them in the cloud. For further information on the properties of the format, see the following tables.

1. Technical specifications

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

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

dataName

Name

orderDocuments

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

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

earliestPossibleDataDate

Earliest point in time

01-Jan-2017

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

20

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 Setup » Settings » Report » Raw data menu.

deleteRawDataAfterDaysMaximum

Maximum number of days until the data is deleted

80

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 Setup » Settings » Report » Raw data menu.

filterType

Filter type

lastUpdate

Data are filtered based on the last update.

dataUpdatedAtColumnName

Column header

od_created_at

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

defaultActive

Activated by default

no

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.

2. Data columns

See {dataColumns} for further information on the orderDocuments data columns included in the CSV file during raw data export.

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

plenty_id

INTEGER NOT NULL

plenty id

ID of the plentymarkets system

od_id (Primary key)

VARCHAR NOT NULL

order document id

ID of the order document

od_type

VARCHAR NOT NULL

order document type

Type of the order document

od_number

VARCHAR NOT NULL

order document number

Number of the order document

o_id

VARCHAR NOT NULL

order ID

ID of the order

od_created_at

TIMESTAMPtZ

order documents updated at

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

To top