Skip to main content

orderStatuses

Using the orderStatuses data format creator, you can export Order statuses and save it 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 orderStatuses
Property Meaning Value Explanation

dataName

Name

orderStatuses

Name of the creator process and prefix of the created file.
File name: orderStatuses-xxx.csv.gz

fileFormat

File format

CSV, GZIP

The data is provided as a GZIP-compressed CSV file (RFC 1952).

defaultActive

Activated by default

no

The data is only exported automatically in the background after you have activated the creator in the Data » 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.

limitPage

Lines per request

up to 200

The maximum number of data rows that is written into a single file.

limitDay

Lines per day

up to 200

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

earliestPossibleDataDate

Earliest point in time

01-Jan-2016

Point in time as of which the raw data can be collected. The data is filtered by the date saved in the dataUpdatedAtColumnName column.

dataUpdatedAtColumnName

Column header

os_updated_at

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

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 Data » 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 Data » Raw data menu.

filterType

Filter type

singleDump

One file contains all data.

2. Data columns

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

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

plenty_id

INTEGER NOT NULL

plenty id

ID of the plentymarkets system

os_id (Primary key)

DECIMAL (6, 4) NOT NULL

account contact id

ID of the contact

os_name

VARCHAR

order status name

Name of the order status

os_color

VARCHAR

order status colour

Colour of the order status

os_is_frontend_visible

SMALLINT

order status is front end visible

1 = visible
0 = invisible

os_is_reorder_visible

SMALLINT

order status is reorder visible

1 = visible
0 = invisible

os_is_redistribution_visible

SMALLINT

order status is redistribution visible

1 = visible
0 = invisible

os_updated_at

TIMESTAMPZ

order statuses updated at

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

os_created_at

TIMESTAMPZ

order statuses created at

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

To top