Skip to main content

categories

Use the categories data format creator to export categories of the type Item and save this data in the cloud. The raw data file is stored in the cloud for a maximum of 6 months. Therefore, the data must be processed before this date. 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 categories
Property Meaning Value Explanation

dataName

Name

categories

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

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

limitDay

Lines per day

up to 20,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

c_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 tariff

plentyBI XS

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

processableFromPlan

Usage starting from tariff

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 categories data columns included in the CSV file during raw data export.

Table 2. Data columns of the format categories
Property Data type Full name Explanation

plenty_id

INTEGER NOT NULL

plenty ID

ID of the plentymarkets system

c_id (Primary key)

VARCHAR NOT NULL

category ID

Category ID

c_parent_id

VARCHAR

category parent ID

ID of the higher-ranking category. The field is empty for categories on level 1.

c_level

SMALLINT NOT NULL

category level

Category level

c_type

VARCHAR NOT NULL

category type

Category type
item = Categories of the type Item

c_name

VARCHAR

category name

Category name

c_updated_at

TIMESTAMPTZ NOT NULL

category updated at

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

To top