Order items
Use the orderItem format to export order items.
Catalogue for export
Are you already familiar with the catalogue for exporting data formats? Catalogues are gradually replacing the old format types of the Elastic Export and offer you more usage and configuration options. Get all the essential information about catalogue functionalities on the manual page Catalogues: standard formats. |
1. BillingAddress
Table 1 lists the fields available for exporting invoices and 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 |
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 |
2. BillingAddressCountry
Table 2 lists the fields available for exporting country data used in the invoice address.
Field | Explanation |
---|---|
id |
Country ID |
isoCode2 |
ISO code of the country |
isoCode3 |
ISO code of the country |
name |
Name of the country |
3. BillingAddressOption
Table 3 lists the fields available for exporting different types of 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 address |
|
post_number |
Post number |
personal_id |
Personnel ID |
bbfc |
BBFC (age rating) |
birthday |
Date of birth |
title |
Title of the invoice recipient |
4. BillingAddressState
Table 4 lists the fields available for exporting data on federal states used in the invoice address.
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 |
5. Contact
Table 5 lists the fields available for exporting contact data.
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 |
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. DeliveryAddress
Table 6 lists the fields available for exporting delivery 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 |
companyName |
Company name |
countryId |
Country ID |
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. DeliveryAddressCountry
Table 7 lists the fields available for exporting delivery address country data.
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 |
8. DeliveryAddressOption
Table 8 lists the fields available for exporting delivery address option data.
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 address |
|
post_number |
Post number |
personal_id |
Personnel ID |
bbfc |
BBFC (age rating) |
birthday |
Date of birth |
title |
Title of recipient |
9. DeliveryAddressState
Table 9 lists the fields available for exporting data on federal states used in the delivery address.
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 |
10. Item
Table 10 lists the fields available for exporting order item data.
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 (PlentyONE user ID) |
producingCountryId |
ID of manufacturing country |
revenueAccount |
Revenue account |
11. Order
Table 11 explains the fields that are available 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 (PlentyONE 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 xref:data:internal-IDs.adoc#90[Internal IDs in PlentyONE. 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 |
12. OrderAmount
Table 12 lists the fields available for exporting the totality of calculated amounts belonging to the order.
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 |
13. OrderDate
Table 13 lists the fields available 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) |
14. OrderDocument
Table 14 lists the fields available for exporting order document data.
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 |
15. OrderItem
Table 15 lists the fields available 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 |
16. OrderItemAmount
Table 16 lists the fields available for exporting the totality of calculated amounts belonging to the order item.
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 |
17. OrderItemDate
Table 17 lists the fields available 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) |
18. OrderItemProperty
Table 18 lists the fields available 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) |
Order property ID |
ID of the order property of the order item |
Order property value |
Value of the order property of the order item |
Order property group ID |
Order property group ID of the order item |
19. OrderItemReference
Table 19 lists the fields available for exporting data on order item references of the order items.
Field | Explanation |
---|---|
referenceType |
Type of the reference of the order item |
referenceOrderItemID |
ID of the target order item, seen from the current order item |
20. OrderParcelService
Table 20 lists the fields available for exporting data on shipping service providers of the order items.
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 |
21. OrderParcelServiceName
Table 21 lists the fields available for exporting the name of the shipping service provider of the order item.
Field | Explanation |
---|---|
name |
Name of the shipping service provider |
parcelServiceId |
ID of the shipping service provider |
22. OrderParcelServicePreset
Table 22 lists the fields available for exporting data on 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 |
23. OrderParcelServicePresetName
Table 23 lists the fields available 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) |
24. OrderProperty
Table 24 lists the fields available 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 |
25. OrderReference
Table 25 lists the fields available for exporting order reference data.
Field | Explanation |
---|---|
originOrderId |
ID of the main order |
referenceOrderId |
ID of the direct parent order |
26. Variation
Table 26 lists the fields available for exporting variation data of order items.
Field | Explanation |
---|---|
automaticListVisibility |
Is automatically visible in the item list |
availabilityUpdatedAt |
Time stamp of last update of the availability |
customsTariffNumber |
Customs tariff number |
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 |
parentVariationQuantity |
Currently not in use |
propertyVariationId |
Variation ID or ID of the main variation of the item. |
releasedAt |
Release date |
singleItemCount |
Currently not in use |
tagVariationId |
|
unitCombinationId |
ID of the combination of unit and quantity |
vatId |
ID of the VAT rate |
WeightG |
Gross weight in g |
WeightNetG |
Net weight in g |
WidthMM |
Width in mm |
27. VariationBarcode
Table 27 lists the fields available 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 |
28. custom_value
Table 28 lists the fields available for exporting custom values.
Field | Explanation |
---|---|
custom_value |
Own value for export |