orderStatuses

Use the orderStatuses data format creator to export order statuses 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 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).

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

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

singleDump

One file contains all data.

dataUpdatedAtColumnName

Column header

os_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 XS

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

2. Data columns

See Table 2 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 PlentyONE system

os_id (Primary key)

NUMERIC(6,4) NOT NULL

order status id

Order status ID

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_created_at

TIMESTAMPTZ NOT NULL

order statuses created at

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

os_updated_at

TIMESTAMPTZ NOT NULL

order statuses updated at

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