Skip to main content

orders

Using the orders data format creator, you can export orders 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 orders
Property Meaning Value Explanation

dataName

Name

orders

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

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

limitDay

Lines per day

up to 150,000

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.

deleteRawDataAfterDaysMinimum

Minimum number of days until the data is deleted

1095

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

1095

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.

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.

filterType

Filter type

lastUpdate

Data are filtered based on the last update.

2. Data columns

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

Table 2. Data columns of the format orders
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

DECIMAL(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 find the IDs of the standard statuses on the Internal Ids in plentymarkets page of the manual.

o_referrer

DECIMAL(5,2)

order referrer

Referrer of the order.
Possible values:
0 = Manual entry
1 = Client (store)
2 = eBay
4 = Amazon
5 = Yatego
6 = Kelkoo
7 = Google Shopping
9 = Wish
101 = ricardo
102 = real.de
You find further possible values for order referrers on the Internal IDs in plentymarkets page of the manual.

o_global_referrer

DECIMAL(5,2)

order global referrer

Global referrer of the order

o_type

VARCHAR NOT NULL

order type

Order type
Possible values:
order = Order
delivery order = Delivery order
return = Return
credit note = Credit note
warranty = Warranty
repair = Repair
offer = Offer
advance order = Advance order
multi-order = Multi-order
multi credit note = Multi credit note

o_is_net

SMALLINT NOT NULL

order is net

Contains 1 if the order has been calculated with a net amount, or 2 if the order has been calculated with a gross amount.

ac_id

VARCHAR NOT NULL

account contact id

ID of the contact that is assigned to 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 invoice 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

smw_id

VARCHAR NOT NULL

stock management warehouse ID

ID of the warehouse associated with the order

o_entry_at

TIMESTAMPZ

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

TIMESTAMPZ

order created at

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

o_goods_issue_at

TIMESTAMPZ

order goods issue at

Time stamp for booking outgoing items
Date format: MM/DD/YY HH:MI:SS TZ

o_paid_at

TIMESTAMPZ

order paid at

Time stamp for booking the incoming payment
Date format: MM/DD/YY HH:MI:SS TZ

o_updated_at

TIMESTAMPZ

order updated at

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

To top