Skip to main content

Creating data formats with FormatDesigner

Do you want to export data from your plentymarkets system? There are just two easy steps:

  • First you’ll use the FormatDesigner to create so-called data formats. In other words, you’ll decide which data should be exported.

  • Second, you’ll use the Elastic Export to export the data formats that you’ve just created.

This page of the manual explains the first step. Here you’ll learn how to set up the FormatDesigner plugin, how to create data formats and which types of data you can export.

The second step, i.e. the actual import, is done in the menu Data » Elastic export. You can find further information about the second step on the elastic export page of the manual.

General settings

1. Setting up the plugin

Find the FormatDesigner plugin on plentyMarketplace and add the plugin to your system. Refer to the plugin chapter for basic information about adding plugins to your plentymarkets system.

Is the plugin up to date?

Plugins are constantly being updated and improved. Before you start creating data formats, open the menu Plugins » Plugin overview » Open plugin set and make sure you’re using the most current version of the plugin.

FormatDesigner plugin has replaced the ElasticSync plugin

Do you still use the ElasticSync plugin to create export formats? This plugin will no longer be updated in the future. Therefore, we recommend that you switch to the FormatDesigner plugin and that you delete the ElasticSync plugin from your plugin set.

2. Creating a format

  1. Go to Data » FormatDesigner.

  2. Click on Add format.

  3. Enter a unique name.

  4. Select the desired format and field separator.

  5. Click on Save.

3. Editing the format

As soon as a format is created or opened, the editing window for the format opens. The available data fields are displayed on the right-hand side. By clicking on a field, this field is added to the left side of the screen. Once a data field has been created, it can be further edited. Once the data field was saved it is added to the export.

Table 1. Settings for the data fields
Setting Explanation

Name

Enter a name for the data format. The name is displayed in the column header of the CSV file.

Move

Left of the data field name is a section marked with dots where you can move and position the data fields. Specify the order of the columns of the CSV file by moving the data fields.

Mapping

Data fields, e.g. VariationSalesPrice.price, require additional mapping because more than one price may exist for every variation. The mapping allows you to export a specific sales price. To export more than one sales price, you can add the data field to the export format several times and map these fields to different sales prices. For data fields that do not require any additional mapping, the button is deactivated.

Change value

Data fields with numeric values can be changed with procedures during the export. As many procedures can be added as desired. These procedures are carried out sequentially and manipulate the value based on the setting selected.

Remove data field

The data field is removed from the format.

Creating format types

1. Item

With formats of the type Item, you export item and variation data.

1.1. Item

Table 2 lists the fields available for exporting item data.

Table 2. Fields for exporting item data
Field Explanation

id

Item ID

position

Variation

itemType

Item type

stockType

Type

ownerID

Owner

manufacturerId

Manufacturer ID

producingCountryId

Manufacturing country

customsTariffNumber

Customs tariff number

revenueAccount

Revenue account

couponRestriction

Coupon for special offers

isSubscribable

Subscription (yes/no)

isSerialNumber

Serial number (yes/no)

isShippingPackage

Shipping package (yes/no)

amazonFbaPlatform

Fulfillment by Amazon (FBA)

isShippableByAmazon

Shipment by Amazon (FBA)

amazonProductType

Amazon product type

amazonFedas

Amazon-FEDAS

ebayPresetId

Listing template

ebayCategory

Listing category 1

ebayCategory2

Listing category 2

ebayStoreCategory

Listing store category 1

ebayStoreCategory2

Listing store category 2

rakutenCategoryId

Rakuten.de categories

flagOne

Flag 1

flagTwo

Flag 2

ageRestriction

Age rating

feedback

Item feedback

free1;
free2;
free3;
…​
free20

Free text fields 1 to 20

maximumOrderQuantity

Max. item order quantity

storeSpecialId

ID of the store special

storeSpecialName

Name of the store special

conditionId

ID of the condition

conditionName

Name of the condition

conditionApiId

ID of the condition for API

conditionApiName

Name of the condition for API

producingCountryName

Name of the manufacturing country

manufacturerName

Name of the manufacturer

manufacturerLogo

Logo of the manufacturer

1.2. ItemImage

Table 3 lists the fields available for exporting image data.

Table 3. Fields for exporting item images
Field Explanation

id

Image ID

fileType

File format of the image (JPG, JPEG, PNG, GIF or SVG)

position

Position

createdAt

Time stamp of the creation

updatedAt

Time stamp of the last update

md5Checksum

The MD5 hash value of the image file

md5ChecksumOriginal

The MD5 hash value of the original image file

size

Image size in pixels

width

Image width in pixels

height

Image height in pixels

URL

URL of the image

urlMiddle

URL of the medium sized version of the image

urlPreview

URL of the preview version of the image

urlSecondPreview

URL of the second preview version of the image

allImages

URLs of all item images with positions in the format
url;position,url;position,etc.

1.3. ItemDescription

Table 4 lists the fields available for exporting item descriptions.

Table 4. Fields for exporting item descriptions
Field Explanation

name

Name

name2

Name 2

name3

Name 3

previewDescription

Preview text

metaDescription

Meta description

description

Item text

technicalData

Technical data

urlPath

The item’s URL path in the online store (categories and item name)

metaKeywords

Meta keywords

itemDeepLink

Complete link to the item including domain

1.4. VariationTag

Table 5 lists the fields available for exporting tags linked to variations.

Table 5. Fields for exporting variation tags
Field Explanation

tagId

Tag ID

tagName

Tag name

tagNames

Tag names

1.5. ItemCrossSelling

Table 6 lists the fields available for exporting cross-selling links.

Table 6. Fields for exporting cross-selling links
Field Explanation

all

All linked cross-selling items

1.6. ItemShippingProfile

Table 7 lists the fields available for exporting shipping profiles linked to items.

Table 7. Fields for exporting item shipping profiles
Field Explanation

profileIslinked

Assign the shipping profile in the format. 0 = Not linked, 1 = Linked

allShippingProfiles

Provides a list of IDs of linked shipping profiles (separated by commas).

allShippingProfileNames

Provides a list of names of linked shipping profiles (separated by commas).

1.7. Variation

Table 8 lists the fields available for importing variation data.

Table 8. Fields for exporting variation data
Field Explanation

id

Variation ID

isMain

Is main variation

mainVariationId

ID of main variation

itemId

Item ID

position

Position

isActive

Is active

number

Variation number

model

Model

externalId

External variation ID

estimatedAvailableAt

Estimated shipping date

PurchasePrice

Net purchase price

movingAveragePrice

Moving average purchase price (net)

createdAt

Time stamp of creating the variation

updatedAt

Time stamp of last update of the variation

relatedUpdatedAt

Time stamp of last update of linked data

availabilityUpdatedAt

Time stamp of last update of the availability

PriceCalculationID

Price calculation

picking

Order picking

stockLimitation

Stock limitation

isVisibleIfNetStockIsPositive

Store: visible if net stock is positive

isInvisibleIfNetStockIsNotPositive

Store: invisible if net stock is 0 or negative

isAvailableIfNetStockIsPositive

Available if net stock is positive

isUnavailableIfNetStockIsNotPositive

Not available if net stock is 0 or negative

isVisibleInListIfNetStockIsPositive

Visible in item list if net stock is positive

isInvisibleInListIfNetStockIsNotPositive

Invisible in item list if net stock is 0 or negative

mainWarehouseId

ID of the main warehouse

maximumOrderQuantity

Maximum order quantity

minimumOrderQuantity

Minimum order quantity

intervalOrderQuantity

Interval order quantity

availableUntil

Available until

releasedAt

Release date

name

Name

unitCombinationId

ID of the combination of unit and quantity

WeightG

Gross weight in g

WeightNetG

Net weight in g

WidthMM

Width in mm

lengthMM

Length in mm

heightMM

Height in mm

extraShippingCharge1

Extra charge 1

extraShippingCharge2

Extra charge 2

UnitsContained

UNITS CONTAINED

palletTypeId

ID of the pallet type

PackingUnits

Number of packages

packingUnitTypeId

Unit of packing units

TransportationCosts

Net transportation costs

StorageCosts

Net storage costs

customs

Customs in percent

operatingCosts

Operating costs (in percent)

vatId

ID of the VAT rate
A = 0
B = 1
C = 2
D = 3

bundleType

Bundle type

automaticClientVisibility

Display whether the variation is visible in a client.

isHiddenInCategoryList

Invisible in item list

defaultShippingCosts

Default shipping costs of the variation

mayShowUnitPrice

Show unit price

salesRank

Sales rank of the variation

parentVariationId

Currently not in use
ID of the parent variation

parentVariationQuantity

Currently not in use
Number of parent variations that this variation contains

singleItemCount

Currently not in use
Number of single items of the variation

parentVariationID

ID of main variation

parentVariationQuantity

singleItemCount

categoryVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Categories are not inherited from the main variation.
ID of main variation of the item = Categories are inherited from the main variation.

marketVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Markets are not inherited from the main variation.
ID of main variation of the item = Markets are inherited from the main variation.

clientVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Clients are not inherited from the main variation.
ID of main variation of the item = Clients are inherited from the main variation.

salesPriceVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Sales prices are not inherited from the main variation.
ID of main variation of the item = Sales prices are inherited from the main variation.

supplierVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Suppliers are not inherited from the main variation.
ID of main variation of the item = Suppliers are inherited from the main variation.

warehouseVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Warehouses are not inherited from the main variation.
ID of main variation of the item = Warehouses are inherited from the main variation.

propertyVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Properties are not inherited from the main variation.
ID of main variation of the item = Properties are inherited from the main variation.

availabilityId

ID of the availability (1-10)

availabilityAverageDays

Average delivery period

availabilityName

Name of the availability

unit.content

Quantity of the unit

unit.unitId

ID of the unit

unit.unitName

Unit name

1.8. VariationBarcode

Table 9 lists the fields available for exporting barcode data.

Table 9. Fields for exporting variation barcodes
Field Explanation

code

Code saved for the selected barcode

1.9. VariationBundle

Table 10 lists the fields available for exporting bundle data.

Table 10. Fields for exporting bundle data
Field Explanation

components

Item bundle components in the format
Component:Quantity;Component:Quantity

1.10. VariationSalesPrice

Table 11 lists the fields available for exporting price data.

Table 11. Fields for exporting prices
Field Explanation

price

Gross prices saved for the selected sales price

netPrice

Net prices saved for the selected sales price

1.11. VariationCategory

Table 12 lists the fields available for exporting categories linked to variations.

Table 12. Fields for exporting category data
Field Explanation

allCategories

Names of the linked categories (separated by commas)

allCategoryIds

IDs of the linked categories (separated by commas)

1.12. VariationDefaultCategory

Table 13 lists the fields available for exporting default categories.

Table 13. Fields for exporting default categories
Field Explanation

branchId

Category ID

manually

1.13. VariationStock

Table 14 lists the fields available for exporting stock data.

Table 14. Fields for exporting stock data
Field Explanation

deltaReorderLevel

Required reordered quantity to reach the reorder level

netStock

Net stock

physicalStock

Physical stock

purchasePrice

Purchase price

reorderLevel

Net stock \+ reordered quantity + reorder level delta

reservedBundles

Quantity reserved for item packages

reservedListing

Quantity reserved for listings

reservedStock

Reserved stock

valueOfGoods

Value of items (Purchase price * Physical stock)

virtualPhysicalStock

Entire physical stock; Stock from all warehouses of the type = 0 (Sales)

warehouseId

Warehouse ID

warehouseName

Name of the warehouse that the stock was booked into our out from.

1.14. StockStorageLocation

Table 15 lists the fields available for exporting storage location data.

Table 15. Fields for exporting storage locations
Field Explanation

batch

Batch

bestBeforeDate

Expiration date

quantity

Quantity

StorageLocationID

Storage location ID

storageLocationName

Name of the storage location

updatedAt

Date of the last update

warehouseId

ID of the warehouse

1.15. VariationClient

Table 16 lists the fields available for exporting client availabilities.

Table 16. Fields for exporting client availabilities
Field Explanation

isActive

Availability for the selected client

1.16. VariationMarket

Table 17 lists the fields available for exporting market availabilities.

Table 17. Fields for exporting market availabilities
Field Explanation

isActive

Availability for the selected market

1.17. VariationMarketIdentNumber

Table 18 lists the fields available for exporting ASIN/ePID data.

Table 18. Fields for exporting ASIN and ePID
Field Explanation

countryId

Country ID

type

Type (ASIN or ePID)

value

Value

1.18. VariationSKU

Table 19 lists the fields available for exporting SKU data.

Table 19. Fields for exporting SKU data
Field Explanation

marketId

Market ID

accountId

ID of the market account

sku

SKU

ParentSKU

The parent SKU

1.19. VariationWarehouse

Table 20 lists the fields available for exporting warehouse data.

Table 20. Fields for exporting warehouse data
Field Explanation

isBatch

Batches are activated

isBestBeforeDate

Best before date is activated

lastUpdateTimestamp

Time stamp of the last update

maximumStock

Maximum stock

reorderLevel

Reorder level

stockBuffer

Stock buffer

stockTurnoverInDays

Stock turnover in days

storageLocationSuggestion

suggestion for the storage location

warehouseZoneId

ID of the warehouse zone

1.20. VariationSupplier

Table 21 lists the fields available for exporting supplier data.

Table 21. Fields for exporting supplier data
Field Explanation

supplierRowId

Supplier link ID

SupplierID

Supplier ID

PurchasePrice

Purchase price

minimumPurchase

Minimum purchase

itemNumber

Supplier item No.

lastPriceQuery

Last price query

deliveryTimeInDays

Delivery time in days

discount

Discount on the order item

isDiscountable

Discountable

PackagingUnit

Packaging unit

lastUpdateTimestamp

Time stamp of the last update

supplierPriceList

Supplier price list in the format
SupplierID:SupplierRowID,PurchasePrice:MinimumPurchase;…​.

allIds

All linked supplier IDs are exported to one field, separated by commas.

allNames

All linked supplier names are exported to one field, separated by commas.

all

All linked supplier IDs, names, purchase prices and link IDs are exported to one field, separated by commas.
ID, name, purchase price and link ID of an individual supplier are separated by a colon. Different suppliers are separated by a semicolon. Example:
id:supplierId:supplierName:purchasePrice;…​

1.21. VariationProperty

Table 22 lists the fields available for exporting properties linked to the item at the item level.

Table 22. Fields for exporting properties
Field Explanation

value

Property value

all

Values of all properties (separated by semicolons), including language for properties of the types Selection and Text
Example: 512;"AText":"en"

allIds

All property IDs (separated by semicolons)

1.22. VariationComment

Table 23 lists the fields available for exporting notes.

Table 23. Fields for exporting notes
Field Explanation

Text

Note text

1.23. VariationAttributeValues

Table 24 lists the fields available for exporting attribute values.

Table 24. Fields for exporting attribute values
Field Explanation

attributeValues

Attribute values

1.24. VariationProperties

Table 25 lists the fields available for exporting property links at the variation level.

Table 25. Fields for exporting variation properties
Field Explanation

id

ID of the property

Cast

Type of the property
int = Whole number
float = Decimal number
select = Selection
date = Date
file = File
empty = None

linked

IDs of the linked properties

value

Property value

all

All characteristics in the format
name:value:language;name:value:language

1.25. ItemSerialNumber

Table 26 lists the fields available for importing serial number data.

Table 26. Fields for exporting serial numbers
Field Explanation

all

All serial numbers

available

Available serial numbers

used

Assigned serial numbers

1.26. Exporting custom values

Table 27 lists the fields available for exporting custom values.

Table 27. Fields for exporting custom values
Field Explanation

custom_value

Own value

2. Item images

Table 28 lists the fields available for exporting item image data with the format Item images.

Table 28. Fields for exporting item images
Field Explanation

ItemImage

id

Image ID

fileType

File format of the image (JPG, JPEG, PNG, GIF or SVG)

path

URL of the image

position

Position

createdAt

Time stamp of the creation

updatedAt

Time stamp of the last update

md5Checksum

The MD5 hash value of the image file

md5ChecksumOriginal

The MD5 hash value of the original image file

size

Image size in pixels

width

Image width in pixels

height

Image height in pixels

URL

URL of the image

urlMiddle

URL of the medium sized version of the image

urlPreview

URL of the preview version of the image

urlSecondPreview

URL of the second preview version of the image

linkedVariations

IDs of the variations linked to the image (separated by commas)

Item

id

The item’s ID

mainVariationNumber

Main variation ID

mainVariationId

ID of main variation

ItemImageAvailability

value

Availability

ItemImageName

name

Name of the item image

alternate

Alternative text of item image

custom_value

custom_value

Own value for export

3. Attributes

Table 29 explains the fields that are available for exporting attribute data.

Table 29. Fields for exporting attributes
Field Explanation

Attribute

id

Attribute ID

backendName

Internal name

position

Position

isSurchargePercental

Indicates whether the surcharge is a percentage value.

isLinkableToImage

Image link possible

amazonAtribute

Attribute of the market Amazon linked to this attribute.

fruugoAttribute

Attribute of the market Fruugo linked to this attribute.

pixmaniaAttribute

Attribute of the market Pixmania linked to this attribute.

ottoAttribute

Attribute of the market Otto linked to this attribute.

googleShoppingAttribute

Attribute of the market Google Shopping linked to this attribute.

neckermannAtEpAttribute

Attribute of the market Neckermann AT EP linked to this attribute.

typeOfSelectionInOnlineStore

Attribute selection in the online store
(dropdown, image or box)

laRedouteAttribute

isGroupable

Groupable in item lists

allValues

AttributeValue

id

Attribute value ID

attributeId

Attribute ID

backendName

Attribute value name

position

Position of the attribute value

image

Name of the image linked to the attribute value

comment

Internal comment concerning the attribute value

amazonValue

Attribute value of the market Amazon linked to this attribute value.

ottoValue

Attribute value of the market Otto linked to this attribute value.

neckermannAtEpValue

Attribute value of the market Neckermann AT EP linked to this attribute value.

tracdelightValue

Attribute value of the market tracdelight linked to this attribute value.

percentageDistribution

Percentage

AttributeName

name

The attribute’s name

AttributeValueName

name

Attribute value name

custom_value

custom_value

Own value

4. Categories

Table 30 explains the fields that are available for exporting category data.

Table 30. Fields for exporting category data
Field Explanation

category

id

Category ID

parentCategoryID

ID of the higher-ranking category

level

Category level

type

Category type

linklist

In link list (Y/N)

right

Visible
all = all = Category and all sub-categories are visible to the public
customer = customer = Category and all sub-categories are only visible to online store visitors that are logged in

sitemap

Sitemap

updatedAt

Time stamp of the last update

parentCategoryName

Name of the parent category

CategoryDetail

name

Name

description

Description 1

description2

Description 2

shortDescription

Short description

metaKeywords

Meta keywords

metaDescription

Meta description

nameUrl

URL name

metaTitle

Meta title

image2Path

previewUrl

Category URL

position

Position

itemListView

Template list

singleItemView

Template product

pageView

Template page

fullText

Full text search

CategoryClient

isActive

Active for client?

custom_value

custom_value

Own value

5. Manufacturers

Table 31 lists the fields available for exporting manufacturer data.

Table 31. Fields for exporting manufacturer data
Field Explanation

Manufacturer

id

Manufacturer ID

name

Name of the manufacturer

externalName

External name of the manufacturer

logo

Logo URL

URL

Homepage

street

Street

houseNo

House number

postcode

Postcode

town

Town

[PhoneNumber]

Telephone number

faxNumber

Fax number

email

Email address

countryId

Country ID

pixmaniaBrandId

Manufacturer ID of market

neckermannAtEpBrandId

Manufacturer ID of market

laRedouteBrandId

Manufacturer ID of market

position

Position

comment

Internal comment

updatedAt

Time stamp of the last update

custom_value

custom_value

Own value

6. Orders

6.1. AccountingLocation

Table 32 explains the fields that are available for exporting category data.

Table 32. Fields for exporting accounting locations
Field Explanation

clientId

ID of the client associated with the accounting location

countryID

ID of the country of the accounting location

id

ID of the accounting location

name

Name of the accounting location

plentyId

plenty ID of the client associated with the accounting location

6.2. BillingAddress

Table 33 lists the fields available for exporting invoices and invoice address data.

Table 33. Fields for exporting invoice address data
Field Explanation

additional

Additional address information

address1

Address field 1 (default: street)

address2

Address field 2 (default: house number)

address3

Address field 3 (default: additional address information)

address4

Address field 4 (freely definable)

birthday

Date of birth

careOf

c/o

checkedAt

Time stamp of the last check of address (Unix timestamp)

companyName

Company name

countryId

Country ID

email

Email

entryCertificate

Entry certificate (Gelangensbestätigung)

externalId

External ID

firstName

First name

fsk

Age rating

gender

Gender

houseNumber

House number

id

ID of the invoice address

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag that defines if the address is a post office

lastName

Last name

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (freely definable)

packstationNo

Number of the Packstation

personalNumber

Personnel number

phone

Telephone number

postalCode

Postcode

postident

Postident

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

stateId

ID of the federal state

street

Street

taxIdNumber

Tax ID number

title

Title included in the address data

town

Town

6.3. BillingAddressCountry

Table 34 lists the fields available for exporting country data used in the invoice address.

Table 34. Fields for exporting countries in invoice addresses

Field

Explanation

id

Country ID

isoCode2

ISO code of the country

isoCode3

ISO code of the country

name

Name of the country

6.4. BillingAddressOption

Table 35 lists the fields available for exporting different types of invoice address options.

Table 35. Fields for exporting invoice address options
Field Explanation

value

Value of the billing address option

BillingAddressOption.value

vat_number

VAT identification number of the customer

external_address_id

External ID of the invoice address

entry_certificate

Entry certificate (Gelangensbestätigung)

telephone

Telephone number

email

Email address

post_number

Post number

personal_id

Personnel ID

bbfc

BBFC (age rating)

birthday

Date of birth

title

Title of the invoice recipient

6.5. BillingAddressState

Table 36 lists the fields available for exporting data on federal states used in the invoice address.

Table 36. Fields for exporting federal states in invoice addresses

Field

Explanation

id

ID of the federal state

isoCode

ISO code of the federal state

isoCode3166

ISO code of the federal state

name

Name of the federal state

6.6. Contact

Table 37 lists the fields available for exporting contact data.

Table 37. Fields for exporting order contacts
Field Explanation

birthdayAt

Birthday of the contact

blocked

Blocked status of the contact

bookAccount

Debtor account of the contact. This is an additional, separate number that usually corresponds with the contact number or the debtor number in your administrative accounting.

classid

Customer class ID

contactPerson

Contact person of the contact

dhlPostIdent

DHL PostIdent of the contact

discountDays

Early payment discount (days) of the contact

discountPercent

Percentage for early payment discount of the contact

ebayName

eBay name of the contact

email

Private email address of the contact

externalid

External contact ID

firstName

First name

formOfAddress

Form of address of the contact (salutation)

fullName

Full name of the contact

gender

Gender of the contact

id

Contact ID

klarnaPersonalId

Klarna ID of the contact

lang

Language of the contact

lastLoginAt

Last login of the contact (time stamp)

lastLoginAtTimestamp

Last login of contact

lastName

Last name

lastOrderAt

Date of the last order of the contact

marketplacePartner

Marketplace status of the contact

newsletterAllowanceAt

Time at which the contact agreed to receiving newsletters

number

Contact number (previously the customer number)

paypalEmail

Email address associated with the contact’s PayPal account

paypalPayerId

PayPal ID of the contact

plentyId

Plenty ID of the client assigned to the contact

privateFax

Number of contact (previously the customer number)

privateMobile

Private mobile phone number of the contact

privatePhone

Private telephone number of the contact

rating

(Internal) rating of the contact

referrerId

Referrer of the contact

salesRepresentativeContactId

Contact ID of the sales representative

secondaryEmail

Second private email address of the contact

singleAccess

Access type of the contact

timeForPaymentAllowedDays

Payment due date of the contact

title

Title of contact

typeId

Contact type ID

userId

ID of the owner associated with the contact

valuta

Valuta of the contact

6.7. DeliveryAddress

Table 38 lists the fields available for exporting delivery address data.

Table 38. Fields for exporting delivery addresses
Field Explanation

additional

Additional address information

address1

Address field 1 (default: street)

address2

Address field 2 (default: house number)

address3

Address field 3 (default: additional address information)

address4

Address field 4 (freely definable)

birthday

Date of birth

careOf

c/o name

checkedAt

Time stamp of the last check of address

companyName

Company name

countryId

Country ID

email

Email

entryCertificate

Entry certificate (Gelangensbestätigung)

externalId

External ID

firstName

First name

fsk

Visual age check

gender

Gender

houseNumber

House number

id

ID of the invoice address

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag that defines if the address is a post office

lastName

Last name

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (freely definable)

packstationNo

Number of the Packstation

personalNumber

Personnel number

phone

Telephone number

postalCode

Postcode

postident

Postident

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

stateID

ID of the federal state

street

Street

taxIdNumber

Tax ID number

town

Town

title

Title of recipient

6.8. DeliveryAddressCountry

Table 39 lists the fields available for exporting delivery address country data.

Table 39. Fields for exporting delivery address countries

Field

Explanation

id

Country of delivery ID

isoCode2

ISO code of country of delivery

isoCode3

ISO code of country of delivery

name

Name of country of delivery

6.9. DeliveryAddressOption

Table 40 lists the fields available for exporting delivery address option data.

Table 40. Fields for exporting delivery address options
Field Explanation

value

Value of the delivery address option

DeliveryAddressOption.value

vat_number

VAT identification number of the customer

external_address_id

External ID of the delivery address

entry_certificate

Entry certificate (Gelangensbestätigung)

telephone

Telephone number

email

Email address

post_number

Post number

personal_id

Personnel ID

bbfc

BBFC (age rating)

birthday

Date of birth

title

Title of recipient

6.10. DeliveryAddressState

Table 41 lists the fields available for exporting data on federal states used in the delivery address.

Table 41. Fields for exporting federal states in delivery addresses

Field

Explanation

id

ID of the federal state

isoCode

ISO code of the federal state

isoCode3166

ISO code of the federal state

name

Name of the federal state

6.11. Order

Table 42 explains the fields that are available for exporting order data.

Table 42. Fields for exporting order data
Field Explanation

createdAt

Time stamp of the creation of the order data set

id

Order ID

locationId

ID of the assigned location

lockStatus

Locked status of the order

methodofPaymentId

ID of the payment method as described on the Internal IDs in plentymarkets manual page.

numberOfDecimals

Number of decimal places in order sums

ownerID

ID of the owner (plentymarkets user ID)

paymentStatus

Status of incoming payment

plentyId

ID of the client

referrerId

ID of the order referrer as described on the Internal IDs in plentymarkets manual page.

roundTotalsOnly

Only exports rounded total order sums

shippingProfileId

ID of the shipping profile

statusID

ID of the order status

statusName

Name of the current status ID of the order

typeID

ID of the order type as described on the Internal IDs in plentymarkets manual page.

updatedAt

Time stamp of the update of the order data set

6.12. OrderAmount

Table 43 lists the fields available for exporting the totality of calculated amounts belonging to the order.

Table 43. Fields for exporting order amounts
Field Explanation

currency

Currency

exchangeRate

Exchange rate of the currency

giftCardAmount

Amout of coupon redeemed for the order (sales coupon)

grossTotal

Total amount of the order (gross)

invoiceTotal

Total invoice amount

isNet

Defines whether the order has been saved in net amount or gross amount.

isSystemCurrency

Defines whether order amounts are registered in the system currency.

netTotal

Total amount of the order (net)

paidAmount

Amount paid for the order

prepaidAmount

Prepaid amount for the order

shippingCostsGross

Amount of shipping costs (gross)

shippingCostsNet

Amount of shipping costs (net)

vatTotal

Total VAT amount of the order

6.13. OrderComment

Table 44 lists the fields available for exporting order notes.

Table 44. Fields for exporting order notes
Field Explanation

Text

Text field containing the order note

6.14. OrderDate

Table 45 lists the fields available for exporting order dates.

Table 45. Fields for exporting order dates
Field Explanation

OrderDate.date

Deleted on

Date of order deletion

Created on

Date of order creation

Incoming payment

Date of incoming payment for the order

Last updated

Date of the last update of the order

Completed on

Date of order completion

Outgoing items on

Date at which outgoing items were booked for the order

Returned on

Date of return of the order

Due date for payment

Date on which payment is due for the order

Estimated shipping date

Estimated shipping date of order items

Market transfer date

Date of transfer of the order from a market

Cancellation date

Date of cancellation of the order

Last run

Date of last run

Next run

Date of next run

Ordered on

Date at which the purchase order has been initiated (for orders of the type redistribution and reorder)

Finish date

Date at which the purchase order has been finished (for orders of the type redistribution and reorder)

6.15. OrderDocument

Table 46 lists the fields available for exporting order document data.

Table 46. Fields for exporting order documents
Field Explanation

displayDate

Date displayed on the order document

id

ID of the order document

number

Number of the order document

numberWithPrefix

Number and prefix of the order document

type

Type of the order document

userId

ID of the user who generated the order document

6.16. OrderParcelService

Table 47 lists the fields available for exporting order document data.

Table 47. Fields for exporting order parcel service data
Field Explanation

backendName

Back end name of the shipping service provider

ShippingServiceProviderAddress

Address of the shipping service provider

shippingServiceProviderId

ID of the shipping service provider

trackingUrl

Tracking URL

6.17. OrderParcelServiceName

Table 48 lists the fields available for exporting the order parcel service name.

Table 48. Fields for exporting the order parcel service name
Field Explanation

name

Name of the shipping service provider

parcelServiceId

ID of the shipping service provider

6.18. OrderParcelServicePreset

Table 49 lists the fields available for exporting preset parcel service data.

Table 49. Fields for exporting preset parcel services
Field Explanation

alternativeEmail

Alternative e-mail address of the shipping service provider

alternativePhone

Alternative phone number of the shipping service provider

backendName

Back end name of the shipping service provider

category

Category

dispatchIdentifier

This field is currently without function.

flag

Flag of the shipping profile

parcelServiceId

ID of the shipping service provider

isCod

This field indicates whether Cash on Delivery applies to the order.

isExpress

This field indicates whether the shipment is an express shipment.

isInsured

This fields indicates whether the shipment is insured.

isParcelBox

Indicates if the order is delivered to a Packstation

isPostOffice

Indicates if the order is delivered to a post office

isPostident

This field indicates whether the Postident procedure is used with the shipment.

islandFee

This field indicates whether an extra charge for delivery to islands applies.

parcelServiceId

ID of the shipping service provider

priority

Priority of the shipping profile

shippingGroup

Associated shipping group

showDataPrivacyAgreementHint

Show procedures

transmitPrivacyRule

useArticlePorto

This field indicates whether additional shipping costs for variations apply

6.19. OrderParcelServicePresetName

Table 50 lists the fields available for exporting the preset order parcel service name.

Table 50. Fields for exporting the preset parcel service name

Field

Explanation

name

Name of the default shipping service provider

OrderParcelServicePresetName.name

German

Name of the default shipping service provider (German)

English

Name of the default shipping service provider (English)

6.20. OrderProperty

Table 51 lists the fields available for exporting order properties.

Table 51. Fields for exporting order properties
Field Explanation

value

Value of the order property. Several types can be entered for each property. The following types are available:

OrderProperty.value

Warehouses

Warehouse associated with the order

Shipping profile

Shipping profile associated with the order

Payment method

Payment method of the order

Status of incoming payment

Payment status of the order

External shipping profile

External shipping profile assigned to the order

Document Language

Language of the order documents

External order ID

External order ID of the order

Customer sign

Sign of the customer

Dunning level

Dunning level of the order

Seller account

Account of the seller

Flag

Flag of the order

VAT identification number of the customer

The customer’s VAT identification number

6.21. OrderReference

Table 52 lists the fields available for exporting order reference data.

Table 52. Fields for exporting order references

Field

Explanation

originOrderId

ID of the main order

referenceOrderId

ID of the direct parent order

6.22. ShippingPackages

Table 53 lists the fields available for exporting shipping package data.

Table 53. Fields for exporting shipping packages
Field Explanation

exportLabelBase64

Base64 coded version of the shipping label

isClosed

packageNumber

Number of the shipping package

palletId

Pallet ID

6.23. Exporting custom values

Table 54 lists the fields available for exporting custom values.

Table 54. Fields for exporting custom values
Field Explanation

custom_value

Own value

7. Order items

7.1. BillingAddress

Table 55 lists the fields available for exporting invoices and invoice address data.

Table 55. Fields for exporting invoice address data
Field Explanation

additional

Additional address information

address1

Address field 1 (default: street)

address2

Address field 2 (default: house number)

address3

Address field 3 (default: additional address information)

address4

Address field 4 (freely definable)

birthday

Date of birth

careOf

c/o name

checkedAt

Time stamp of the last check of address (Unix timestamp)

companyName

Company name

countryId

Country ID

email

Email

entryCertificate

Entry certificate (Gelangensbestätigung)

externalId

External ID

firstName

First name

fsk

Age rating

gender

Gender

houseNumber

House number

id

ID of the invoice address

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag that defines if the address is a post office

lastName

Last name

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (freely definable)

packstationNo

Number of the Packstation

personalNumber

Personnel number

phone

Telephone number

postalCode

Postcode

postident

Postident

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

stateId

ID of the federal state

street

Street

taxIdNumber

Tax ID number

title

Title included in the address data

town

Town

7.2. BillingAddressCountry

Table 56 lists the fields available for exporting country data used in the invoice address.

Table 56. Fields for exporting countries in invoice addresses

Field

Explanation

id

Country ID

isoCode2

ISO code of the country

isoCode3

ISO code of the country

name

Name of the country

7.3. BillingAddressOption

Table 57 lists the fields available for exporting different types of invoice address options.

Table 57. Fields for exporting invoice address options
Field Explanation

value

Value of the billing address option

BillingAddressOption.value

vat_number

VAT identification number of the customer

external_address_id

External ID of the invoice address

entry_certificate

Entry certificate (Gelangensbestätigung)

telephone

Telephone number

email

Email address

post_number

Post number

personal_id

Personnel ID

bbfc

BBFC (age rating)

birthday

Date of birth

title

Title of the invoice recipient

7.4. BillingAddressState

Table 58 lists the fields available for exporting data on federal states used in the invoice address.

Table 58. Fields for exporting federal states in invoice addresses

Field

Explanation

id

ID of the federal state

isoCode

ISO code of the federal state

isoCode3166

ISO code of the federal state

name

Name of the federal state

7.5. Contact

Table 37 lists the fields available for exporting contact data.

Table 59. Fields for exporting order contacts
Field Explanation

birthdayAt

Birthday of the contact

blocked

Blocked status of the contact

bookAccount

Debtor account of the contact. This is an additional, separate number that usually corresponds with the contact number or the debtor number in your administrative accounting.

classid

Customer class ID

contactPerson

Contact person of the contact

dhlPostIdent

DHL PostIdent of the contact

discountDays

Early payment discount (days) of the contact

discountPercent

Percentage for early payment discount of the contact

ebayName

eBay name of the contact

email

Private email address of the contact

externalid

External contact ID

firstName

First name

formOfAddress

Form of address of the contact (salutation)

fullName

Full name of the contact

gender

Gender of the contact

id

Contact ID

klarnaPersonalId

Klarna ID of the contact

lang

Language of the contact

lastLoginAt

Last login of the contact (time stamp)

lastLoginAtTimestamp

Last login of contact

lastName

Last name

lastOrderAt

Date of the last order of the contact

marketplacePartner

Marketplace status of the contact

newsletterAllowanceAt

Time at which the contact agreed to receiving newsletters

number

Contact number (previously the customer number)

paypalEmail

Email address associated with the contact’s PayPal account

paypalPayerId

PayPal ID of the contact

plentyId

Plenty ID of the client assigned to the contact

privateFax

Number of contact (previously the customer number)

privateMobile

Private mobile phone number of the contact

privatePhone

Private telephone number of the contact

rating

(Internal) rating of the contact

referrerId

Referrer of the contact

salesRepresentativeContactId

Contact ID of the sales representative

secondaryEmail

Second private email address of the contact

singleAccess

Access type of the contact

timeForPaymentAllowedDays

Payment due date of the contact

title

Title of contact

typeId

Contact type ID

userId

ID of the owner associated with the contact

valuta

Valuta of the contact

7.6. DeliveryAddress

Table 60 lists the fields available for exporting delivery address data.

Table 60. Fields for exporting delivery addresses
Field Explanation

additional

Additional address information

address1

Address field 1 (default: street)

address2

Address field 2 (default: house number)

address3

Address field 3 (default: additional address information)

address4

Address field 4 (freely definable)

birthday

Date of birth

careOf

c/o

checkedAt

Time stamp of the last check of address

companyName

Company name

countryId

Country ID

email

Email

entryCertificate

Entry certificate (Gelangensbestätigung)

externalId

External ID

firstName

First name

fsk

Visual age check

gender

Gender

houseNumber

House number

id

ID of the invoice address

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag that defines if the address is a post office

lastName

Last name

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (freely definable)

packstationNo

Number of the Packstation

personalNumber

Personnel number

phone

Telephone number

postalCode

Postcode

postident

Postident

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

stateID

ID of the federal state

street

Street

taxIdNumber

Tax ID number

title

Title of recipient

town

Town

7.7. DeliveryAddressCountry

Table 61 lists the fields available for exporting delivery address country data.

Table 61. Fields for exporting delivery address countries

Field

Explanation

id

Country of delivery ID

isoCode2

ISO code of country of delivery

isoCode3

ISO code of country of delivery

name

Name of country of delivery

7.8. DeliveryAddressOption

Table 62 lists the fields available for exporting delivery address option data.

Table 62. Fields for exporting delivery address options
Field Explanation

value

Value of the delivery address option

DeliveryAddressOption.value

vat_number

VAT identification number of the customer

external_address_id

External ID of the delivery address

entry_certificate

Entry certificate (Gelangensbestätigung)

telephone

Telephone number

email

Email address

post_number

Post number

personal_id

Personnel ID

bbfc

BBFC (age rating)

birthday

Date of birth

title

Title of recipient

7.9. DeliveryAddressState

Table 63 lists the fields available for exporting data on federal states used in the delivery address.

Table 63. Fields for exporting federal states in delivery addresses

Field

Explanation

id

ID of the federal state

isoCode

ISO code of the federal state

isoCode3166

ISO code of the federal state

name

Name of the federal state

7.10. Item

Table 64 lists the fields available for exporting order item data.

Table 64. Fields for exporting item data on order items

Field

Explanation

ageRestriction

Age rating

customsTariffNumber

Customs tariff number

flagOne

Flag 1

flagTwo

Flag 2

id

Item ID

itemType

Item type

manufacturerId

Manufacturer ID

maximumOrderQuantity

Maximum item order quantity

ownerID

ID of the owner (plentymarkets user ID)

producingCountryId

ID of manufacturing country

revenueAccount

Revenue account

7.11. Order

Table 65 explains the fields that are available for exporting order data.

Table 65. Fields for exporting order data
Field Explanation

id

Order ID

locationId

ID of the assigned location

lockStatus

Locked status of the order

methodofPaymentId

Payment method ID

numberOfDecimals

Number of decimal places in order sums

ownerID

ID of the owner (plentymarkets user ID)

paymentStatus

Status of incoming payment

plentyId

ID of the client assigned to the order

referrerId

ID of the order referrer as described on the Internal IDs in plentymarkets manual page.

roundTotalsOnly

Only exports rounded total order sums

shippingProfileId

ID of the shipping profile

statusID

ID of the order status

statusName

Name of the current status ID of the order

typeID

ID of the order type

7.12. OrderAmount

Table 43 lists the fields available for exporting the totality of calculated amounts belonging to the order.

Table 66. Fields for exporting order amounts
Field Explanation

currency

Currency

exchangeRate

Exchange rate of the currency

giftCardAmount

Amout of coupon redeemed for the order (sales coupon)

grossTotal

Total amount of the order (gross)

invoiceTotal

Total invoice amount

isNet

Defines whether the order has been saved in net amount or gross amount.

isSystemCurrency

Defines whether order amounts are registered in the system currency.

netTotal

Total amount of the order (net)

paidAmount

Amount paid for the order

prepaidAmount

Prepaid amount for the order

shippingCostsGross

Amount of shipping costs (gross)

shippingCostsNet

Amount of shipping costs (net)

vatTotal

Total VAT amount of the order

7.13. OrderDate

Table 45 lists the fields available for exporting order dates.

Table 67. Fields for exporting order dates
Field Explanation

OrderDate.date

Deleted on

Date of order deletion

Created on

Date of order creation

Incoming payment

Date of incoming payment for the order

Last updated

Date of the last update of the order

Completed on

Date of order completion

Outgoing items on

Date at which outgoing items were booked for the order

Returned on

Date of return of the order

Due date for payment

Date on which payment is due for the order

Estimated shipping date

Estimated shipping date of order items

Market transfer date

Date of transfer of the order from a market

Cancellation date

Date of cancellation of the order

Last run

Date of last run

Next run

Date of next run

Ordered on

Date at which the purchase order has been initiated (for orders of the type redistribution and reorder)

Finish date

Date at which the purchase order has been finished (for orders of the type redistribution and reorder)

7.14. OrderDocument

Table 46 lists the fields available for exporting order document data.

Table 68. Fields for exporting order documents
Field Explanation

displayDate

Date displayed on the order document

id

ID of the order document

number

Number of the order document

numberWithPrefix

Number and prefix of the order document

type

Type of the order document

userId

ID of the user who generated the order document

7.15. OrderItem

Table 69 lists the fields available for exporting order item data.

Table 69. Fields for exporting order item data
Field Explanation

attributeValues

Attribute values of the order item

countryVatId

ID of the VAT profile

id

Order item ID

itemVariationId

Variation ID of the order item

orderItemName

Name of the order item (Item name)

position

Position of the order item within the order

quantity

Quantity

referrerId

Order item referrer

referrerName

Name of the order item referrer

shippingProfileId

ID of the shipping profile assigned to the order item

typeId

Order item type ID

vatField

ID of the VAT profile field

vatRate

VAT rate actually used

warehouseId

ID of the warehouse associated with the order

7.16. OrderItemAmount

Table 70 lists the fields available for exporting the totality of calculated amounts belonging to the order item.

Table 70. Fields for exporting order item amounts
Field Explanation

currency

Currency of the order item

discount

Discount on the order item

exchangeRate

Exchange rate of the currency

isPercentage

Defines whether the discount is indicated in %

isSystemCurrency

Indicates whether order item amounts are registered in the system currency.

priceGross

Actual gross price of the order item

priceNet

Actual net price of the order item

priceOriginalGross

Regular gross price of the order item

priceOriginalNet

Regular net price of the order item

PurchasePrice

Purchase price of the order item

surcharge

Surcharge for the order item

7.17. OrderItemDate

Table 71 lists the fields available for exporting order item dates.

Table 71. Fields for exporting order item dates
Field Explanation

OrderItemDate.date

Deleted on

Date of order item deletion

Created on

Date or order item creation

Incoming payment

Date of incoming payment for the order item

Last updated

Date of the last update of the order item

Outgoing items on

Date at which outgoing items were booked for the order item

Completed on

Date of completion of the order item

Returned on

Date of return of the order item

Due date for payment

Due date for payment of the order item

Estimated shipping date

Estimated shipping date of the order item

Start date

Start date

End date

End date

Possible delivery date

Estimated delivery date of the order item

Market transfer date

Date of transfer of the order item from a market

Cancellation date

Cancellation date of the order item

Last run

Date of last run

Next run

Date of next run

Ordered on

Date at which the purchase order has been initiated (for orders of the type redistribution and reorder)

Finish date

Date at which the purchase order has been finished (for orders of the type redistribution and reorder)

7.18. OrderItemProperty

Table 72 lists the fields available for exporting order item properties.

Table 72. Fields for exporting order item properties
Field Explanation

value

Value of the order item property Several types can be entered for each property. The following types are available:

OrderItemProperty.value

Warehouses

Warehouse of the order item

Weight

Weight of the order item

Width

Width of the order item

Length

Length of the order item

Height

Height of the order item

External token ID

External token ID of the order item

External item ID

The order item’s external item ID, e.g. the eBay ID

Coupon code

Code of the coupon redeemed for the order item

Coupon type

Type of the coupon redeemed for the order item

Unit

Quantity unit of the order item

External shipping item ID

External shipping item ID of the order item

Return reason

Return reason of the order item

Item status

Item status of the order item

External order item ID

External order item ID of the order item

Weight in kg

Weight of the order item (in kg)

7.19. OrderParcelService

Table 73 lists the fields available for exporing data on shipping service providers of the order items.

Table 73. Fields for exporting order shipping service provider data
Field Explanation

backendName

Back end name of the shipping service provider

ShippingServiceProviderAddress

Address of the shipping service provider

shippingServiceProviderId

ID of the shipping service provider

trackingUrl

Tracking URL

7.20. OrderParcelServiceName

Table 74 lists the fields available for exporting the name of the shipping service provider of the order item.

Table 74. Fields for exporting the shipping service provider name
Field Explanation

name

Name of the shipping service provider

parcelServiceId

ID of the shipping service provider

7.21. OrderParcelServicePreset

Table 75 lists the fields available for exporting data on default shipping service providers of the order item.

Table 75. Fields for exporting the default shipping service providers of the order item
Field Explanation

alternativeEmail

Alternative e-mail address of the shipping service provider

alternativePhone

Alternative phone number of the shipping service provider

backendName

Back end name of the shipping service provider

category

Category

dispatchIdentifier

This field is currently without function.

flag

Flag of the shipping profile

isCod

This field indicates whether Cash on Delivery applies to the order.

isExpress

This field indicates whether the shipment is an express shipment.

isInsured

This fields indicates whether the shipment is insured.

isParcelBox

Indicates if the order is delivered to a Packstation

isPostOffice

Indicates if the order is delivered to a post office

isPostident

This field indicates whether the Postident procedure is used with the shipment.

islandFee

This field indicates whether an extra charge for delivery to islands applies.

parcelServiceId

ID of the shipping service provider

priority

Priority of the shipping profile

shippingGroup

Associated shipping group

showDataPrivacyAgreementHint

Show procedures

transmitPrivacyRule

useArticlePorto

This field indicates whether additional shipping costs for variations apply

7.22. OrderParcelServicePresetName

Table 76 lists the fields available for exporting the name of the default shipping service provider of the order item.

Table 76. Fields for exporting the name of the default shipping service provider of the order item

Field

Explanation

name

Name of the default shipping service provider

OrderParcelServicePresetName.name

German

Name of the default shipping service provider (German)

English

Name of the default shipping service provider (English)

7.23. OrderProperty

Table 77 lists the fields available for exporting order properties.

Table 77. Fields for exporting order properties
Field Explanation

value

Value of the order property. Several types can be entered for each property. The following types are available:

OrderProperty.value

Warehouses

Warehouse associated with the order

Shipping profile

Shipping profile associated with the order

Payment method

Payment method of the order

Status of incoming payment

Payment status of the order

External shipping profile

External shipping profile assigned to the order

Document Language

Language of the order documents

External order ID

External order ID of the order

Customer sign

Sign of the customer

Dunning level

Dunning level of the order

Seller account

Account of the seller

Flag

Flag of the order

VAT identification number of the customer

The customer’s VAT identification number

7.24. OrderReference

Table 78 lists the fields available for exporting order reference data.

Table 78. Fields for exporting order references
Field Explanation

originOrderId

ID of the main order

referenceOrderId

ID of the direct parent order

7.25. Variation

Table 79 lists the fields available for exporting variation data of order items.

Table 79. Fields for exporting order item variation data
Field Explanation

automaticListVisibility

Is automatically visible in the item list

availabilityUpdatedAt

Time stamp of last update of the availability

externalId

External variation ID

hasCalculatedBundleMovingAveragePrice

hasCalculatedBundleNetWeight

hasCalculatedBundlePurchasePrice

hasCalculatedBundleWeight

heightMM

Height in mm

id

Variation ID

isInvisibleInListIfNetStockIsNotPositive

Invisible in item list if net stock is 0 or negative

isMain

Is main variation

isVisibleInListIfNetStockIsPositive

Visible in item list if net stock is positive

itemId

Item ID

lengthMM

Length in mm

mainVariationId

ID of main variation

mainWarehouseId

ID of the main warehouse

model

Model

movingAveragePrice

Moving average price (net purchase price)

name

Name

number

Variation number

parentVariationId

Currently not in use
ID of the parent variation

parentVariationQuantity

Currently not in use
Number of parent variations that this variation contains

propertyVariationId

Variation ID or ID of the main variation of the item.
ID of the variation = Properties are not inherited from the main variation.
ID of main variation of the item = Properties are inherited from the main variation.

releasedAt

Release date

singleItemCount

Currently not in use
Number of single items of the variation

tagVariationId

unitCombinationId

ID of the combination of unit and quantity

vatId

ID of the VAT rate
A = 0
B = 1
C = 2
D = 3

WeightG

Gross weight in g

WeightNetG

Net weight in g

WidthMM

Width in mm

7.26. VariationBarcode

Table 80 lists the fields available for exporting variation barcodes.

Table 80. Fields for exporting variation barcodes
Field Explanation

code

Codes saved for the selected barcode

VariationBarcode.code

GTIN 13

GTIN 13 code of the order item

GTIN 128

GTIN 128 code of the order item

UPC

Universal product code of the order item

ISBN

ISBN code of the order item

7.27. Exporting custom values

Table 81 lists the fields available for importing custom values.

Table 81. Fields for exporting custom values
Field Explanation

Own value

Own value

8. Warehouses

8.1. WarehouseLocation

Table 15 lists the fields available for exporting warehouse data.

Table 82. Fields for exporting storage locations
Field Explanation

id

Storage location ID

levelId

Level ID

label

Storage location (without path)

purposekey

Designated use

statuskey

Status

position

Position

fulllabel

Full storage location name (including path)

type

Type

notes

Notes

allIds

All storage location IDs (separated by commas)

allNames

All storage location names (separated by commas)

8.2. WarehouseLocationLevel

Table 83 lists the fields available for exporting storage location level data.

Table 83. Fields for exporting storage location levels
Field Explanation

id

Storage location level ID

parentId

Parent ID of level

dimensionID

ID of the dimension

position

Position of the level

name

Name of the level

type

Type of the level

pathName

Storage location path (without storage location name)

8.3. WarehouseLocationDimension

Table 84 lists the fields available for exporting storage location dimension data.

Table 84. Fields for exporting storage location dimensions
Field Explanation

id

ID of the dimension

parentID

Parent ID

warehouseID

Warehouse ID

level

Level

name

Name of the dimension

shortcut

Abbreviation

separator

Separator

displayInName

Show in storage location name

isActiveForPickupPath

Include in picking path

8.4. Warehouse

Table 20 lists the fields available for exporting warehouse data.

Table 85. Fields for exporting warehouses
Field Explanation

id

Warehouse ID

name

Warehouse name

note

Note

typeId

Warehouse type

onStockAvailability

Availability with stock

outOfStockAvailability

Availability without stock

splitByShippingProfile

Split up according to shipping profile

repairWarehouseID

Warehouse assigned for repairs

isInventoryModeActive

Stocktaking mode active

logisticType

Assigned repair warehouse (own warehouses, DHL Fulfilment, Amazon)

updatedAt

Time stamp of the last update

createdAt

Time stamp of the creation

8.5. Exporting custom values

Table 86 lists the fields available for exporting custom values.

Table 86. Fields for exporting custom values
Field Explanation

Own value

Own value

9. Stock

Use formats of the type Stock to export stock data.

9.1. Stock

Table 14 lists the fields available for exporting stock data.
During the import, the stock is corrected, meaning that the stock is changed to reflect the imported value. This is necessary for stocktaking.

Table 87. Fields for exporting stock
Field Explanation

averagePrice

Average price

batch

Batch

bestBefore

Expiration date

bundle

Package

itemDescriptionName

Name of the item description

itemFlagOne

Flag 1 of the item

itemFlagTwo

Flag 2 of the item

itemId

The item’s ID

itemManufacturerId

Item manufacturer ID

itemManufacturerName

Name of the item manufacturer

purchasePrice

Purchase price

reordered

Reordered

reservedStock

Reserved stock

stock

Stock

storageLocationId

ID of the storage location

storageLocationName

Storage location name

variationBarcode

EAN code of the variation

variationId

ID of the variation

variationIsActive

The variation is active.

variationModel

Model of the variation

variationName

Name of the variation

variationNumber

Variation number

variationTags

Tags of the variation

warehouseID

ID of the warehouse

9.2. StockMovement

Table 88 lists the fields available for exporting stock movement data.

Table 88. Fields for exporting stock movements
Field Explanation

attributeValues

Attribute values

deliveryNoteNumber

delivery note number

entryDate

Date of the stock movement

itemId

Item ID

quantity

Quantity of items included in the stock movement. The leading sign shows if stock was booked in or out.
-: Stock was booked out
+: Stock was booked in

reasonId

ID of the stock movement reason

reasonString

Name of the stock movement reason

sourceId

Source ID of the stock movement. The source can be an order or incoming items. Thus, the source ID can be an order ID or the ID of incoming items.

sourceTypeId

ID of the source type of a stock movement. The source type refers to the menu or action that triggered the stock movement.

stockProcessId

Process ID of the stock movement. You can see the process ID in the data set of a variation in the Stock movements tab of the variation.

storageLocationName

Storage location name

userId

ID of the user

UserName

Name of the user who booked the stock movement

variationId

ID of the variation included in the stock movement

variationNumber

ID of the selection of attributes

variationTags

Tags of the variation

warehouseId

ID of the warehouse that the stock was booked into our out from.

warehouseName

Name of the warehouse that the stock was booked into our out from.

10. Contacts

Use formats of the type Contacts to export contact data, address data and company data.

10.1. Account

Table 89 lists the fields available for exporting company data.

Table 89. Fields for exporting company data
Field Explanation

companyName

Company name

dealerMinOrderValue

Minimum order value for the supplier

deliveryTime

Delivery time for the supplier

discountDays

Early payment discount (days) of the company

discountPercent

Percentage for early payment discount of the company

id

The company’s ID

number

Customer number This number is not assigned automatically. The maximum length is 128 characters.

salesRepresentativeContactId

Contact ID of the sales representative

taxIdNumber

VAT identification number of the customer

TimeForPaymentAllowedDays

Payment due date of the contact

userId

ID of the owner (plentymarkets user ID)

valuta

Valuta of the company

10.2. BillingAddress

Table 90 lists the fields available for exporting invoice address data.

Table 90. Fields for exporting invoice address data
Field Explanation

address1

Address field 1 (default: street)

address2

Address field 2 (default: house number)

address3

Address field 3 (default: additional address information)

address4

Address field 4 (freely definable)

checkedAt

Time stamp of the last check of address (Unix timestamp)

countryId

Country ID

id

ID of the invoice address

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (default: freely definable)

postalCode

Postcode

stateId

ID of the federal state

title

Title of contact

town

Town

10.3. BillingAddressOption

Table 91 lists the fields available for exporting different types of invoice address options.

Table 91. Fields for exporting invoice address options
Field Explanation

bBFC

BBFC (age rating)

birthday

Date of birth

contactPerson

Contact person

email

Email address

entryCertificate

Entry certificate (Gelangensbestätigung)

externalAddressID

External ID of the invoice address

personalId

Personnel ID

postNumber

Post number

sessionID

Session ID

telephone

Telephone number

title

Title of the invoice recipient

vatNumber

VAT identification number of the customer

10.4. Contact

Table 92 lists the fields available for exporting contact data.

Table 92. Fields for exporting contact data
Field Explanation

birthdayAt

Birthday of the contact

blocked

Status “Blocked”. A contact can be locked for a specific client.
Possible values: 0 = not blocked, 1 = blocked

bookAccount

Debtor account of the contact. An additional, separate number that usually corresponds to the contact number or the debtor number of the contact in your administrative accounting.

classId

Customer class ID

dhlPostIdent

DHL PostIdent of the contact

discountDays

Early payment discount (days) of the contact

discountPercent

Percentage for early payment discount of the contact

externalId

External contact ID

firstName

The contact’s first name

gender

Gender of the contact

id

ID of the contact

lang

Language of the contact

lastLoginAtTimestamp

Date of last login of the contact

lastName

The contact’s surname

lastOrderAt

Date of last order

newsletterAllowanceAt

Time stamp of the contact registering for the newsletter

number

Customer number This number is not assigned automatically. The maximum length is 128 characters.

plentyId

Client that is assigned to the contact

rating

Rating of the contact. This is an internal rating only. 5 red stars are the worst possible rating and 5 yellow stars are the best possible rating. Possible values:
-5 = 5 red stars (worst possible rating)
-4 = 4 red stars
-3 = 3 red stars
-2 = 2 red stars
-1 = 1 red star
0 = 5 grey stars, no rating saved for the contact.
1 = 1 yellow star
2 = 2 yellow stars
3 = 3 yellow stars
4 = 4 yellow stars
5 = 5 yellow stars (best possible rating)

referrerId

Referrer ID of the contact

salesRepresentativeContactId

Contact ID of the sales representative

timeForPaymentAllowedDays

Payment due date of the contact

title

Title of contact

typeId

Contact type ID

userId

Owner ID of the contact

valuta

Valuta of the contact

10.5. contactAllowedMethodOfPayment

Table 93 lists the fields available for exporting allowed methods of payment saved in the contact data record.

Table 93. Fields for exporting allowed methods of payment of the contact
Field Explanation

allowDebit

Information that states whether the contact is allowed to pay via direct debit.
Possible values:
0 = do not allow
1 = allow

allowInvoice

Information that states whether the contact is allowed to pay via invoice.
Possible values:
0 = do not allow
1 = allow

10.6. ContactBank

Table 94 lists the fields available for exporting bank details.

Table 94. Fields for exporting bank data
Field Explanation

accountNumber

Account number

accountOwner

The account holder’s name

bankAddress

The address of the bank

bankCountry

Country of the bank

bankName

The name of the bank

bankPostalCodeTown

Postcode and town of the bank

bic

BIC of the bank account

contactId

ID of the contact

directDebitMandateAt

Date the SEPA direct debit mandate was granted.

directDebiteMandateAvailable

Flag that indicates if a SEPA direct debit mandate was granted

directDebitMethod

Type of SEPA direct debit mandate. Possible values:
sepaDirectDebit
sepaB2bDirectDebit

directDebitType

Indicates if this is a first debit or recurring debit. Possible values:
first
next

iban

IBAN of bank account

id

ID of the bank account

lastUpdateBy

Date of last update. Possible values:
customer
back end
import

paymentMethod

Payment frequency of SEPA direct debit mandate. Possible values:
recurrent
onOff

sortCode

Bank code

10.7. ContactOption

Table 95 lists the fields available for exporting contact options.

Table 95. Fields for exporting contact options
Field Explanation

accessGuest

Account type. Indicates if the account is a regular account or a guest account.

accessMarketplacePartner

Access to the plentyMarketplace.

additionalContactPerson

Additional contact person

emailPayPal

PayPal email address

emailPrivate

Private email address

emailWork

Office email address

groupForum

Email address used in a forum

identificationNumberDHL

Identification number at DHL

identificationNumberKlarna

Identification number at Klarna

marketplaceAmazon

Email address at Amazon

marketplaceEbay

eBay name

paymentKlarna

Identification number at Klarna

paymentPayPal

Email address at PayPal

paymentStandard

Default payment method

salutationPrivate

Private form of address

salutationWork

Office form of address

telefaxPrivate

Private fax number

telefaxWork

Office fax number

telephoneMobilePrivate

Private mobile phone number

telephoneMobileWork

Office mobile phone number

telephonePrivate

Private telephone number

telephoneWork

Office telephone number

userNameForum

User name used in a forum

userNamePrivate

Private user name

userNameWork

Office user name

webPagePrivate

Private website

webPageWork

Office website

10.8. DeliveryAddress

Table 96 lists the fields available for exporting delivery address data.

Table 96. Fields for exporting delivery address data
Field Explanation

address1

Address field 1 (default: street)

address2

Address field 2 (default: house number)

address3

Address field 3 (default: additional address information)

address4

Address field 4 (freely definable)

checkedAt

Time stamp of the last check of address

countryId

Country ID

id

ID of the invoice address

name1

Name (default: Company)

name2

Name (default: First name)

name3

Name (default: Last name)

name4

Name (default: freely definable)

postalCode

Postcode

stateID

ID of the federal state

title

Title of contact

town

Town

10.9. DeliveryAddressOption

Table 97 lists the fields available for exporting different types of delivery address options.

Table 97. Fields for exporting delivery address options
Field Explanation

bBFC

BBFC (age rating)

birthday

Date of birth

contactPerson

Contact person

email

Email address

entryCertificate

Entry certificate (Gelangensbestätigung)

externalAddressID

External ID of the delivery address

personalId

Personnel ID

postNumber

Post number

sessionID

Session ID

telephone

Telephone number

title

Title of recipient

vatNumber

VAT identification number of the customer

10.10. SalesRepresentativeRegion

Table 98 lists the fields available for exporting data about the region of the sales representative.

Table 98. Fields for exporting data about the sales representative’s region
Field Explanation

countryId

Country ID

id

ID of the sales representative

postalCodeArea

Postcode area within which the sales representative is working

10.11. Exporting custom values

Table 99 lists the fields available for exporting custom values.

Table 99. Fields for exporting custom values
Field Explanation

Own value

Own value

11. Newsletter recipient

Table 100 lists the fields available for exporting newsletter data.

Table 100. Fields for exporting newsletter data
Field Explanation

Newsletter recipient

birthday

Date of birth of the newsletter recipient

confirmAuthString

Automatically generated key. This key recognises the user independent of whether the user is logged in in the system or not. The key then sets a time stamp.

confirmationURL

URL that the contact used to confirm the newsletter registration.
Note: The confirmation link can be inserted in the email template via the template variable NewsletterConfirmURL.

confirmedTimestamp

Time stamp when the recipient confirmed the newsletter registration.

contactId

ID of the contact

email

Email address of the newsletter recipient

firstName

First name of the newsletter recipient

folderId

ID of the folder in which the email address of the newsletter recipient is saved

gender

Gender of the newsletter recipient

id

ID of the email address to which the newsletter is sent

ipAddress

IP address that the contact used to confirm the newsletter registration

lastName

Last name of the newsletter recipient

templateLang

Language of the newsletter template.
Note: The language is set in the Email message tab of the email template.

timestamp

Time stamp when the newsletter email was sent to the recipient

Own value

Own value

Own value for export

12. Properties

Table 101 lists the fields available for exporting property links at the variation level.

Table 101. Fields for exporting variation properties
Field Explanation

Property

id

ID of the property

Cast

Type of the property
int = Whole number
float = Decimal number
select = Selection
date = Date
file = File
empty = None

position

Position of the property

typeIdentifier

item = Item
contact = Contact

allGroups

IDs of the assigned property groups

PropertyName

name

Type of the property

description

Description of the property

Group

id

ID of the property group

position

Position of the property group

GroupName

name

ID of the property group

description

Description of the property group

custom_value

custom_value

Own value

13. Date

Table 102 lists the field available for exporting the current date. For further information, refer to this page.

Table 102. Field for exporting the current date
Field Explanation

date

Current date

To top