Skip to main content

Creating data formats with FormatDesigner

The FormatDesigner allows you to create formats for exporting using the ElasticExport. All formats created with FormatDesigner are available in the Data » Elastic export menu. Using the FormatDesigner, you can not only set CSV options and select data fields, but also manipulate numeric data values during export.

Plugin updated?

ElasticSync is constantly updated and improved. As such, go to Plugins » Plugin overview » Open plugin set and check that you use the latest version of ElasticSync before creating syncs or export formats.

General settings

1. Create 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. Save the settings.

2. Editing the format

As soon as a format is created or opened, the editing window for the format opens. There you will find all available data fields. 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. You 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 will be 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

storeSpecial

Store special

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

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 item 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. ItemTag

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

Table 5. Fields for exporting item tags
Field Explanation

tagId

Tag ID

tagNames

Tag name

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 exporting variation data.

Table 8. Fields for exporting variation data
Field Explanation

id

Variation ID

isMain

Variation is the main variation

mainVariationId

Main variation ID

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

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

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 shipping charge 1

extraShippingCharge2

Extra shipping 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

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 the 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 the 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 the 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 the 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 the 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 the 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 the 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

1.8. VariationBarcode

Table 9 lists the fields available for exporting barcode data.

Table 9. Fields for exporting barcode data
Field Explanation

codes

Codes 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

Prices 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 category data.

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

WarehouseID

Warehouse ID

reservedListing

Reserved quantity for listings

reservedBundles

Quantity reserved for item packages

valueOfGoods

Value of items (Purchase price * Physical stock)

PurchasePrice

Purchase price

PhysicalStock

Physical stock

ReservedStock

Reserved stock

NetStock

Net stock

ReorderLevel

Net stock + reordered quantity + reorder level delta

deltaReorderLevel

Required reordered quantity to reach the reorder level

virtualPhysicalStock

Entire physical stock; Stock from all warehouses of the typ 0 (Sales warehouse)

1.14. StockStorageLocation

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

Table 15. Fields for exporting storage locations
Field Explanation

StorageLocationID

Storage location ID

WarehouseID

Warehouse ID

quantity

Quantity

bestBeforeDate

Expiration date

batch

Batch

updatedAt

Date of the last update

storageLocationName

Name of the storage location

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

ID of the country

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

warehouseZoneId

ID of the warehouse zone

StorageLocationType

Storage location type

ReorderLevel

Reorder level

maximumStock

Maximum stock

StockTurnoverInDays

Stock turnover in days

storageLocation

Storage location

StockBuffer

Stock buffer

isBatch

Batches are activated

isBestBeforeDate

Best before date is activated

lastUpdateTimestamp

Time stamp of the last update

1.20. VariationSupplier

Table 21 lists the fields available for exporting supplier data.

Table 21. Fields for exporting supplier data
Field Explanation

SupplierID

Supplier ID

PurchasePrice

Purchase price

minimumPurchase

Minimum purchase

itemNumber

Supplier item No.

lastPriceQuery

Last price query

deliveryTimeInDays

Delivery time in days

discount

Discount

isDiscountable

Discountable

PackagingUnit

Packaging unit

lastUpdateTimestamp

Time stamp of the last update

supplierPriceList

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

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;"EinText":"de"

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 2 lists the fields available for exporting attribute values.

Table 24. Fields for exporting attribute values
Field Explanation

attributeValues

Attribute values

1.24. VariationEigenschaften

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

Table 25. Fields for exporting variation properties
Field Explanation

id

ID of the property

all

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

1.25. Exporting custom values

Table 26 lists the fields available for importing custom values.

Table 26. Fields for exporting custom values
Field Explanation

custom_value

Own value

2. Item images

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

Table 27. Fields for exporting item images
Field Explanation

ItemImage

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

linkedVariations

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

Item

id

The item’s ID

mainVariationNumber

Main variation ID

mainVariationId

Main variation ID

ItemImageAvailability

value

Availability

ItemImageName

name

Name of the item image

alternate

Alternative text of item image

Own value

Own value for export

3. Attributes

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

Table 28. Fields for exporting attributes
Field Explanation

Attributes

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 29 explains the fields that are available for matching category data.

Table 29. 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 = Category and all sub-categories are visible to the public
customer = Category and all sub-categories are only visible to online store visitors that are logged in

sitemap

Sitemap

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

previewUrl

Category URL

position

Position

itemListView

Template list

singleItemView

Template product

pageView

Template page

CategoryClient

isActive

Active for client?

custom_value

custom_value

Own value

5. Manufacturer

Table 30 lists the fields available for exporting manufacturer data.

Table 30. Fields for exporting manufacturer data
Field Explanation

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

ID of the country

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

Own value

Own value for export

6. Orders

6.1. Order

Table 31 lists the fields available for exporting order data.

Table 31. Fields for exporting order data
Field Explanation

id

Order ID

typeID

ID of the order type

methodofPaymentId

Payment method ID

shippingProfileId

ID of the shipping profile

paymentStatus

Status of incoming payment

statusID

ID of the order status

statusName

Name of the current status ID of the order

ownerID

ID of the owner (plentymarkets user ID)

createdAt

Time stamp of the creation of the order data set

updatedAt

Time stamp of the update of the order data set

plentyId

ID of the client assigned to the order

locationId

ID of the assigned location

lockStatus

Locked status of the order

6.2. BillingAddress

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

Table 32. Fields for exporting invoice address data
Field Explanation

id

ID of the invoice address

gender

Gender

name1

Name (default: first name)

name2

Name (default: last name)

name3

Name (default: c/o)

name4

Name (default: freely definable)

companyName

Company name

firstName

First name

lastName

Last name

careOf

c/o name

address1

Address field 1

address2

Address field 2

address3

Address field 3

address4

Address field 4 (freely definable)

street

Street

houseNumber

House number

additional

Additional address information

postalCode

Postcode

town

Town

countryId

Country ID

stateId

ID of state, county or province

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

checkedAt

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

taxIdNumber

Tax ID number

externalId

External ID

entryCertificate

Entry certificate (Gelangensbestätigung)

phone

Telephone number

email

Email address

postident

Postident

fsk

Age rating

birthday

Date of birth

personalNumber

Personnel number

packstationNo

Number of the Packstation

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag defining whether a post office is used

6.3. BillingAddressOption

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

Table 33. Fields for exporting invoice address options
Field Explanation

value

Value of the billing address option

BillingAddressOption.value

vat_number

VAT identification number

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.4. 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

name

Name of the country

isoCode2

ISO code of the country

isoCode3

ISO code of the country

6.5. DeliveryAddress

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

Table 35. Fields for exporting delivery addresses
Field Explanation

id

ID of the address

gender

Gender

name1

Name (default: first name)

name2

Name (default: last name)

name3

Name (default: c/o)

name4

Name (default: freely definable)

companyName

Company name

firstName

First name

lastName

Last name

careOf

c/o

address1

Address field 1

address2

Address field 2

address3

Address field 3

address4

Address field 4 (default: freely definable)

street

Street

houseNumber

House number

additional

Additional address information

postalCode

Postcode

town

Town

CountryId

Country ID

stateID

ID of state, county or province

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

checkedAt

Time stamp of the last check of address

taxIdNumber

Tax ID number

externalId

External ID

entryCertificate

Entry certificate (Gelangensbestätigung)

phone

Telephone number

email

Email address

postident

Postident

fsk

Visual age check

birthday

Date of birth

personalNumber

Personnel number

packstationNo

Number of the Packstation

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag defining whether a post office is used

6.6. DeliveryAddressOption

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

Table 36. Fields for exporting delivery address options
Field Explanation

value

Value of the delivery address option

DeliveryAddressOption.value

vat_number

VAT identification number

external_address_id

ID of external 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.7. DeliveryAddressCountry

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

Table 37. Fields for exporting delivery address countries

Field

Explanation

id

Country of delivery ID

name

Name of country of delivery

isoCode2

ISO code of country of delivery

isoCode3

ISO code of country of delivery

6.8. Contact

Table 38 lists the fields available for exporting order contact data.

Table 38. Fields for exporting order contacts
Field Explanation

id

Contact ID

externalid

External contact ID

number

Contact number (previously the customer number)

typeId

Contact type ID

firstName

First name

lastName

Last name

fullName

Full name of the contact

email

Private email address of the contact

secondaryEmail

Second private email address of contact

gender

Gender of contact

title

Title of contact

formOfAddress

Form of address of the contact (salutation)

newsletterAllowanceAt

Time at which the contact agreed to receiving newsletters

classid

Customer class ID

blocked

Blocked status of the contact

rating

(Internal) rating 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.

lang

Language of the contact

referrerId

Referrer of the contact

plentyId

Plenty ID of the client assigned to the contact

userId

ID of the owner associated with the contact

birthdayAt

Birthday of the contact

lastLoginAt

Last login of the contact

lastLoginAtTimestamp

Last login of the contact (time stamp)

lastOrderAt

Date of the last order of the contact

privatePhone

Private telephone number of the contact

privateMobile

Private mobile phone number of the contact

ebayName

eBay name of the contact

paypalEmail

Email address associated with the contact’s PayPal account

paypalPayerId

PayPal ID of the contact

klarnaPersonalId

Klarna ID of the contact

dhlPostIdent

DHL PostIdent of the contact

singleAccess

Access type of the contact

contactPerson

Contact person of the contact

marketplacePartner

Marketplace status of the contact

6.9. OrderProperty

Table 39 lists the fields available for exporting order properties.

Table 39. 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

Warehouse

Warehouse associated with the order

Shipping profile

Shipping profile associated with the order

Payment method

Payment method of the order

Payment status

Payment status of 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

Flag of the order

Seller account

Account of the seller

Flag

Flag of the order

VAT ID of the customer

The customer’s VAT identification number

6.10. OrderDate

Table 40 lists the fields available for exporting order dates.

Table 40. 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

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

6.11. OrderAmount

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

Table 41. Fields for exporting order amounts
Field Explanation

isSystemCurrency

Defines whether order amounts are registered in the system currency.

isNet

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

currency

Currency

exchangeRate

Exchange rate of the currency

netTotal

Total amount of the order (net)

grossTotal

Total amount of the order (gross)

vatTotal

Total VAT amount of the order

invoiceTotal

Total invoice amount

paidAmount

Amount paid for the order

prepaidAmount

This field is deprecated. Use the field giftCardAmount instead.

giftCardAmount

Amout of coupon redeemed for the order (sales coupon)

shippingCostsGross

Amount of shipping costs (gross)

shippingCostsNet

Amount of shipping costs (net)

6.12. OrderReference

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

Table 42. Fields for exporting order references

Field

Explanation

originOrderId

ID of the main order

referenceOrderId

ID of the direct parent order

6.13. ShippingPackages

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

Table 43. Fields for exporting shipping packages

Field

Explanation

packageNumber

Number of the shipping package

exportLabelBase64

Base64 coded version of the shipping label

6.14. 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 notes

6.15. OrderDocument

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

Table 45. Fields for exporting order documents

Field

Explanation

id

ID of the order document

type

Type of the order document

number

Number of the order document

numberWithPrefix

Number and prefix of the order document

userId

ID of the user who generated the order document

displayDate

Date displayed on the order document

6.16. AccountingLocation

Table 46 lists the fields available for exporting order accounting location data.

Table 46. Fields for exporting accounting locations

Field

Explanation

id

ID of the accounting location

countryID

ID of the country of the accounting location

name

Name of the accounting location

clientId

ID of the client associated with the accounting location

plentyID

plenty ID of the client associated with the accounting location

6.17. OrderParcelServicePreset

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

Table 47. Fields for exporting preset parcel services

Field

Explanation

parcelServiceId

Shipping service provider ID

backendName

Back end Name of the shipping service provider

flag

Flag of the shipping profile

priority

Priority of the shipping profile

category

Category of the shipping profile

useArticlePorto

This field indicates whether additional shipping costs for variations apply

isInsured

This fields indicates whether the shipment is insured.

isExpress

This field indicates whether the shipment is an express shipment.

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.

isCod

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

shippingGroup

Associated shipping group

dispatchIdentifier

This field is currently without function.

6.18. OrderParcelServicePresetName

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

Table 48. Fields for exporting the parcel service preset name

Field

Explanation

name

Name of the default shipping provider

OrderParcelServicePresetName.name

German

Name of the default shipping service provider (German)

English

Name of the default shipping service provider (English)

6.19. OrderParcelService

Table 47 lists the fields available for exporting order parcel service data.

Table 49. Fields for exporting order parcel service data

Field

Explanation

backendName

Back end name of the shipping service provider

trackingUrl

Tracking URL of the shipping service provider

shippingServiceProviderId

Shipping service provider ID

ShippingServiceProviderAddress

Address of the shipping service provider

6.20. OrderParcelServiceName

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

Table 50. Fields for exporting the order parcel service name

Field

Explanation

parcelServiceId

ID of the shipping service provider

name

Name of the shipping service provider

6.21. Exporting custom values

Table 51 lists the fields available for exporting custom values.

Table 51. Fields for exporting custom values
Field Explanation

custom_value

Own (custom) value

7. Order items

7.1. Order

Table 52 explains the fields available for exporting order data.

Table 52. Fields for exporting order data
Field Explanation

id

Order ID

typeID

ID of the order type

methodofPaymentId

Payment method ID

shippingProfileId

ID of the shipping profile

paymentStatus

Status of incoming payment

statusID

ID of the order status

statusName

Name of the current status ID of the order

ownerID

ID of the owner (plentymarkets user ID)

plentyID

ID of the client assigned to the order

locationId

ID of the assigned location

lockStatus

Locked status of the order

7.2. OrderProperty

Table 53 lists the fields available for exporting order properties.

Table 53. 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

Warehouse

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 ID of the customer

The customer’s VAT identification number

7.3. OrderDate

Table 54 lists the fields available for exporting data on the order date.

Table 54. 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

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

Start date

Starting date of order

End date

End date of order

Estimated delivery date

Estimated delivery date of the order

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

7.4. OrderAmount

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

Table 55. Fields for exporting order amounts
Field Explanation

isSystemCurrency

Defines whether order amounts are registered in the system currency.

isNet

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

currency

Currency

exchangeRate

Exchange rate of the currency

netTotal

Total amount of the order (net)

grossTotal

Total amount of the order (gross)

vatTotal

Total VAT amount of the order

invoiceTotal

Total invoice amount

paidAmount

Amount paid for the order

prepaidAmount

This field is deprecated. Use the field giftCardAmount instead.

giftCardAmount

Amout of coupon redeemed for the order (sales coupon)

shippingCostsGross

Amount of shipping costs (gross)

shippingCostsNet

Amount of shipping costs (net)

7.5. OrderReference

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

Table 56. Fields for exporting order references
Field Explanation

originOrderId

ID of the main order

referenceOrderId

ID of the direct parent order

7.6. OrderItem

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

Table 57. Fields for exporting order item data
Field Explanation

id

Order item ID

typeId

Order item type ID

referrerId

Order item referrer

referrerName

Name of the order item referrer

itemVariationId

Variation ID of the order item

quantity

Quantity

orderItemName

Name of the order item

attributeValues

Attribute values of the order item

shippingProfileId

ID of the shipping profile assigned to the order item

countryVatId

ID of the VAT profile

vatField

ID of the VAT profile field

vatRate

VAT rate actually used

position

Position of the order item within the order

warehouseId

Warehouse ID

7.7. OrderItemProperty

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

Table 58. 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

Warehouse

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.8. OrderItemDate

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

Table 59. 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

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

7.9. OrderItemAmount

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

Table 60. Fields for exporting order item amounts
Field Explanation

isSystemCurrency

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

currency

Currency of the order item

exchangeRate

Exchange rate of the currency

PurchasePrice

Purchase price of the order item

priceOriginalGross

Regular gross price of the order item

priceOriginalNet

Regular net price of the order item

priceGross

Actual gross price of the order item

priceNet

Actual net price of the order item

surcharge

Surcharge for the order item

discount

Discount on the order item

isPercentage

Defines whether the discount is indicated in %

7.10. BillingAddress

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

Table 61. Fields for exporting invoice address data
Field Explanation

id

ID of the invoice address

gender

Gender

name1

Name (default: first name)

name2

Name (default: last name)

name3

Name (default: c/o)

name4

Name (default: freely definable)

companyName

Company name

firstName

First name

lastName

Last name

careOf

c/o name

address1

Address field 1

address2

Address field 2

address3

Address field 3

address4

Address field 4 (default: freely definable)

street

Street

houseNumber

House number

additional

Additional address information

postalCode

Postcode

town

Town

countryId

Country ID

stateId

ID of state, county or province

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

checkedAt

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

taxIdNumber

Tax ID number

externalId

External ID

entryCertificate

Entry certificate (Gelangensbestätigung)

phone

Telephone number

email

Email address

postident

Postident

fsk

Age rating

birthday

Date of birth

personalNumber

Personnel number

packstationNo

Number of the Packstation

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag defining whether a post office is used

7.11. BillingAddressOption

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

Table 62. 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 (age rating)

BBFC (age rating)

birthday

Date of birth

title

Title of the invoice recipient

7.12. BillingAddressCountry

[table-fields-orderitem-billing-address-country] lists the fields available for exporting country data used in the invoice address.

Table 63. Fields for exporting countries in invoice addresses
Field Explanation

id

Country ID

name

Name of the country

isoCode2

ISO code of the country

isoCode3

ISO code of the country

7.13. DeliveryAddress

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

Table 64. Fields for exporting delivery addresses
Field Explanation

id

ID of the invoice address

gender

Gender

name1

Name (default: first name)

name2

Name (default: last name)

name3

Name (default: c/o)

name4

Name (default: freely definable)

companyName

Company name

firstName

First name

lastName

Last name

careOf

c/o name

address1

Address field 1

address2

Address field 2

address3

Address field 3

address4

Address field 4 (default: freely definable)

street

Street

houseNumber

House number

additional

Additional address information

postalCode

Postcode

town

Town

CountryId

Country ID

stateID

ID of state, county or province

readOnly

Defines read-only fields

sessionId

Session ID used for creating the address

checkedAt

Time stamp of the last check of address

taxIdNumber

Tax ID number

title

Title of recipient of delivery

externalId

External ID

entryCertificate

Entry certificate (Gelangensbestätigung)

phone

Telephone number

email

email

postident

Postident

fsk

BBFC (age rating)

birthday

Date of birth

personalNumber

Personnel number

packstationNo

Number of the Packstation

isPackstation

Flag defining whether a Packstation is used

isPostfiliale

Flag defining whether a post office is used

7.14. DeliveryAddressOption

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

Table 65. Fields for exporting delivery address options
Field Explanation

value

Value of the delivery address option

DeliveryAddressOption.value

VAT number

VAT identification number

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 (age rating)

Age rating

Birthday

Date of birth

title

Title of recipient

7.15. DeliveryAddressCountry

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

Table 66. Fields for exporting delivery address countries

Field

Explanation

id

Country of delivery ID

name

Name of country of delivery

isoCode2

ISO code of country of delivery

isoCode3

ISO code of country of delivery

7.16. Contact

Table 67 lists the fields available for exporting order contact data.

Table 67. Fields for exporting order contacts
Field Explanation

id

Contact ID

externalid

External contact ID

number

Contact number (previously the customer number)

typeId

Contact type ID

firstName

First name

lastName

Last name

fullName

Full name of the contact

email

Private email address of the contact

secondaryEmail

Second private email address of the contact

gender

Gender of the contact

title

Title of contact

formOfAddress

Form of address of the contact (salutation)

newsletterAllowanceAt

Time at which the contact agreed to receiving newsletters

classid

Customer class ID

blocked

Blocked status of the contact

rating

(Internal) rating 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.

lang

Language of the contact

referrerId

Referrer of the contact

plentyID

Plenty ID of the client assigned to the contact

userId

ID of the owner associated with the contact

birthdayAt

Birthday of the contact

lastLoginAt

Last login of the contact (time stamp)

lastLoginAtTimestamp

Last login of contact

lastOrderAt

Date of the last order of the contact

privatePhone

Private telephone number of the contact

privateFax

Number of contact (previously the customer number)

privateMobile

Private mobile phone number of the contact

ebayName

eBay name of the contact

paypalEmail

Email address associated with the contact’s PayPal account

paypalPayerId

PayPal ID of the contact

klarnaPersonalId

Klarna ID of the contact

dhlPostIdent

DHL PostIdent of the contact

singleAccess

Access type of the contact

contactPerson

Contact person of the contact

marketplacePartner

Marketplace status of the contact

7.17. VariationBarcode

Table 68 lists the fields available for exporting variation barcodes.

Table 68. Fields for exporting variation bar codes
Field Explanation

codes

Codes saved for the selected bar code

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.18. OrderDocument

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

Table 69. Fields for exporting order documents
Field Explanation

id

ID of the order document

type

Type of the order document

number

Number of the order document

numberWithPrefix

Number and prefix of the order document

userId

ID of the user who generated the order document

displayDate

Date displayed on the order document

7.19. Item

Table 70 lists the fields available for exporting item data.

Table 70. Fields for exporting item data
Field Explanation

id

Item ID

itemType

Item type

ownerID

ID of the owner (plentymarkets user ID)

manufacturerId

Manufacturer ID

producingCountryId

ID of manufacturing country

customsTariffNumber

Customs tariff number

revenueAccount

Revenue account

flagOne

Flag 1

flagTwo

Flag 2

ageRestriction

Age rating

maximumOrderQuantity

Maximum item order quantity

7.20. Variation

Table 71 lists the fields available for exporting variation data.

Table 71. Fields for exporting variation data
Field Explanation

id

Variation ID

isMain

Indicates whether the variation is a main variation

mainVariationId

Main variation ID

itemId

Item ID

number

Variation number

model

Model

externalId

External variation ID

movingAveragePrice

Moving average price

mainWarehouseId

ID of the main warehouse

releasedAt

Release date of the variation

name

Name

unitCombinationId

WeightG

Weight (in g)

WeightNetG

Net weight (in g)

WidthMM

Width (in mm)

lengthMM

Length (in mm)

heightMM

Height (in mm)

vatId

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

propertyVariationId

7.21. OrderParcelServicePreset

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

Table 72. Fields for exporting preset parcel services
Field Explanation

parcelServiceId

ID of the shipping service provider

backendName

Back end name of the shipping service provider

flag

Flag of the shipping profile

priority

Priority of the shipping profile

category

Category of the shipping profile

useArticlePorto

This field indicates whether additional shipping costs for variations apply

isInsured

This fields indicates whether the shipment is insured.

isExpress

This field indicates whether the shipment is an express shipment.

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.

isCod

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

shippingGroup

Associated shipping group

dispatchIdentifier

This field is currently without function.

showDataPrivacyAgreementHint

Show procedures

transmitPrivacyRule

alternativeEmail

Alternative email address

alternativePhone

Alternative telephone number

isParcelBox

Flag that defines if the address is a parcel box

isPostOffice

Flag that defines if the address is a post office

7.22. OrderParcelServicePresetName

Table 73 lists the fields available for exporting the parcel service provider of the order.

Table 73. Fields for exporting the parcel service preset name

Field

Explanation

name

Name of the default shipping provider

OrderParcelServicePresetName.name

German

Name of the default shipping service provider (German)

English

Name of the default shipping service provider (English)

7.23. OrderParcelService

Table 74 lists the fields available for exporting order parcel service data.

Table 74. Fields for exporting order parcel service data

Field

Explanation

backendName

Back end name of the shipping service provider

trackingUrl

Tracking URL

shippingServiceProviderId

ID of the shipping service provider

ShippingServiceProviderAddress

Address of the shipping service provider

7.24. OrderParcelServiceName

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

Table 75. Fields for exporting the order parcel service name

Field

Explanation

parcelServiceId

ID of the shipping service provider

OrderParcelServiceName.parcelServiceID

German

Shipping service provider ID (German)

English

Shipping service provider ID (English)

name

Name of the shipping service provider

OrderParcelServiceName.name

German

Name of the shipping service provider (German)

English

Name of the shipping service provider (English)

7.25. Exporting custom values

Table 76 lists the fields available for importing custom values.

Table 76. Fields for exporting custom values
Field Explanation

Own (custom) value

Own (custom) value

8. Warehouses

8.1. WarehouseLocation

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

Table 77. 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)

types

Type

notes

Notes

8.2. WarehouseLocationLevel

Table 78 lists the fields available for exporting storage location levels.

Table 78. Fields for exporting storage locations
Field Explanation

id

Storage location level ID

parentId

Parent ID of level

dimensionID

ID of dimension

position

Position of the level

name

Name of the level

type

pathName

Storage location path (without storage location name)

8.3. WarehouseLocationName

Table 79 lists the fields available for exporting storage location dimensions.

Table 79. Fields for exporting storage location dimensions
Field Explanation

id

ID of 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 80. 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)

8.5. Exporting custom values

Table 81 lists the fields available for exporting custom values.

Table 81. Fields for exporting custom values
Field Explanation

Own value

Own value

To top