plentyONE an e-commerce solution that brings together the features that are needed for an online shop. pixi* amongst other shop vendors, also supports connection to plentyONE. This is done through the pixi* Control Center > Import and Export.
More information on plentyONE: https://www.plentymarkets.eu/en/.
See also: Imports 2.0 - Overview, Imports 2.0 - Troubleshooting
Latest supported Plenty version:
from LOU Update 31 / AVA Update 7 on: Plenty SOAP API version 113
from LOU Update 33 / AVA Update 9 on: Plenty SOAP API version 114
Not supported Plenty version:
Plenty SOAP API version 115 / Plenty 7
Step 1 - Connect to a plentyONE Shop
pixi* is connected to a plentyONEshop through SOAP API connection. Older API URL connection is not officially supported anymore.
plentyONE uses different naming conventions for order and customer details fields. To assure the data is correctly imported into pixi*, a matching table is provided. In this table the fields in plentyONE are matched with the corresponding fields in pixi* and the original value in the XML field will be substituted with the matching value in the pixi* field.
Connect to plentyONE with SOAP API Connection
Open pixi* Control Center and click the Import and Export tab.
Click Options to open the pixi* Settings window and then click Edit Channels.
Click New to open the Edit/Add new channel wizard.
-
Enter the channel name, in the Channel Type drop-down list select plentySOAP and select the item export options:
Export to all Channels: Items, imported from this channel, are exported to all enabled channels.
Export to This Channel Only: Items, imported from this channel, are exported to this channel only.
Do not Export at all for this Channel: Items will not be exported to this channel at all.
Do not export any items to this channel: No items at all are exported to this channel.
Click Next.
Enter the channel settings as required (for detailed descriptions of channel settings refer to chapter Descriptions of Channel Settings) and click Next.
Enter the matching table settings for the fields in XML. To do this, click New, select the field name, enter the values as required and click OK (for detailed descriptions of matching table settings refer to chapter Descriptions of Matching Table Settings).
Click Finish. The new channel is created.
In the list of channels select the new channel and click Enable.
To test the connection select the new channel and click Check Connection. If the connection is OK, the session ID is returned.
Notes:
Item import is performed every 5 minutes.
Suppliers are imported or updated every 24 hours after last suppliers import.
Authentication is limited to 30 login calls per day. Login data (user id, session id and login date) is automatically written in the channel settings for the plentyONE with SOAP API connection.
-
Item information exported to plentyONE:
Available stock quantity: Displayed in plentyONE under Stock > Stocks > Physical.
-
Order information exported to plentyONE:
Order status according to the matching table.
Tracking number: Displayed in plentyONE under Salesorders > Editing salesorders > Searching for salesorders > Settings >Package number.
Used plentyONE API Calls
You can find a list of plentyONE API calls here. pixi* currently uses the following API calls to exchange data:
GetAuthentificationToken
GetCustomers
GetItemsBase
SetCurrentStocks
SearchOrders
GetOrdersPaymentInformation
SetOrderStatus
AddOrdersPackageNumber
SetOrdersHead
Descriptions of Channel Settings
The table below contains a list of all available channel settings for plentyONE. The table is the same as the table in “Imports 2.0 – User and Setup Guide” document, with additional settings for plentyONE.
Channel Setting |
Description |
StoreHouse_ID |
Stock from pixi* is exported to shop on location (warehouse), defined in this field. Only one StoreHouse_ID is supported per channel. |
PixiOrderLocation |
All stock for items will be imported to shop to the storage location specified in this field (for example, 1). Only one Location ID is supported per channel. |
PlentyLastItemImportDate |
Date of last import job is saved to this field automatically. |
PlentyItemsVAT0 |
If the value for <VATInternalID> in the XML file = 0, the matching VAT rate in pixi* is set in the fields (MwSt_High, MwSt_Low or MwSt_None). |
PlentyItemsVAT1 |
If the value for <VATInternalID> in the XML file = 1, the matching VAT rate in pixi* is set in the fields (MwSt_High, MwSt_Low or MwSt_None). |
PlentyItemsVAT2 |
If the value for <VATInternalID> in the XML file = 2, the matching VAT rate in pixi* is set in the fields (MwSt_High, MwSt_Low or MwSt_None). |
PlentyItemsVAT3 |
If the value for <VATInternalID> in the XML file = 3, the matching VAT rate in pixi* is set in the fields (MwSt_High, MwSt_Low or MwSt_None). |
PlentyOrderImportStatus |
Orders in plentyONE with the numerical value set with this setting will be imported to pixi*. The default value is specified in plentyONE specification. |
PlentyOrderImportStatusAfterImport |
Status of orders which were imported to pixi* is set to this numerical value in plentyONE. The default value is specified in plentyONE specification. |
PlentyCustomerNrExternal |
If the value is:
|
OrderExport_SetBookOutgoingItems |
If the value = 1, reservation for the ordered item will be released in the shop when the order is shipped out. If the value = 0, this functionality is disabled. |
ItemImport_external_article_id |
If the value is 0, the items with value specified for external_article_id in the XML are not imported to pixi*. If the value is 1, the items with value specified for external_article_id in the XML are imported to pixi*. In all cases the article_id value is imported to ItemNrInt in pixi*. |
ItemImport_OrderUnit |
If the value is 0, the update of the Packing Unit is not allowed when an item is imported to pixi*. Note: With the value of setting set to 0 or empty, if an item does not exist in pixi*, Packing Unit will be set to 1. If the value is 1, the update of the Packing Unit is allowed when an item is imported to pixi*. |
ItemImport_MinOrderQty |
If the value is 0, the update of the Minimum Order Quantity is not allowed when an item is imported to pixi*. If the value is 1 and the database setting BMECat, Import der Mindestbestellmenge is enabled, the update of the Minimum Order Quantity is allowed when an item is imported to pixi*. |
Free1 as SerialNrReq |
If the value = 0, the <Free1> field in the XML is ignored. If the value = 1, the <Free1> field in the XML is used for importing the Serial Number Required flag. Serial Number Required flag is set for the item if the value of <Free1> = 1, otherwise the item is imported without the Serial Number Required flag. |
AUS |
The value that represents the AUS status in plentyONE. |
STO |
The value that represents the STO status in plentyONE. |
NLB |
The value that represents the NLB status in plentyONE. |
RET |
The value that represents the RET status in plentyONE. |
MatchReferrerToShopId |
If the value is 0, the ShopID is read from the <storeID> field in XML. In this case the ShopID values are additionally set in the matching table. If the value is 1, the ShopID is read from the <referrerID> field in XML. In this case the referrer values are additionally set in the matching table. If the value is “Referrer;MultiShop;” the ShopID is read from both <referrerID> and <StoreID> XML fields (for example: <referrerID> = “4”, <StoreID> = “0”, the ShopID will be read from values “4;0;”). In this case the values are additionally set in the matching table. Important: SOAP API version 106c or older is using XML tag <multishopID> instead of the <storeID>. |
Shop Username |
Access data for plentyONE with SOAP API connection. |
Shop Password |
Access data for plentyONE with SOAP API connection. |
URLSoapAPI |
Access data for plentyONE with SOAP API connection. URLSoapAPI is defined in the plentyONE > Settings >plentyAPI data: SOAP WSDL(for example, http://mad.plenty-test.de/plenty/api/soap/version103c/). |
PlentyLastOrderImportDate |
Date of the last order import is saved to this field automatically. |
PlentyLastSupplierImportDate |
Date of the last supplier import is saved to this field automatically. |
UserId |
User ID is saved to this field automatically. Do not edit this field. |
Token |
Session ID is saved to this field automatically. Do not edit this field. |
LoginDate |
Date of login is saved to this field automatically. Do not edit this field. |
GetSalesOrderProperties |
If this setting is set to 1, XML request is with new GetSalesOrderProperties call. Response returns SalesOrderPropertyID, SalesOrderPropertyName, SalesOrderPropertyType and SalesOrderPropertyValue values for ordered item. If setting is set to 0, then XML is without GetSalesOrderProperties call. This is supported from version 106c. |
PropertyValueForItemNote |
In this setting you write names of new values, which are returned if GetSalesOrderProperties is set to 1. (Example: <SalesOrderPropertyID>;<SalesOrderPropertyName>;<SalesOrderPropertyType>;<SalesOrderPropertyValue>.) This is saved for ordered item as Item Note in pixi* Customer Service. |
Internal Item Number |
Insert XML tag, which will be used for importing of Internal Item Number to pixi* via plentySOAP channel.
|
VariantItemNrSupplier |
When importing variants from which data GeneratedVariantItemNrSuppl shold be generated. Possible values (ItemId, ItemNo, AttributeValueSetId, ColliNo, Ean) |
Import Payment Information |
If the value is 0, the payment information is not imported to pixi*.
|
ItemNrSupplier |
Define Tag from which the supplier item number should be imported. Possible values: ItemID, ExternalItemID, EAN1, SupplierID, ItemNo, SupplierItemID Default: ItemID |
AddItemNrSupplier |
Define Tag from which the supplier item number should be imported. Possible values: ItemID, ExternalItemID, EAN1, SupplierID, ItemNo, SupplierItemID Default: ItemID |
Import CustomsTariffText (path) |
If set (default value is empty), CustomsTariffText will be imported from given XML tag on path set by this setting under each "Item" node. Example "PriceSet/Lot" |
Item name suffix formula |
if set (default value is empty), Item Name and Title will get suffix from formula set by this setting. Example: " VPE: {{CustomsTariffText}}", this would produce "Item Name VPE:CustomsTariffText" for item name. |
Shop Item Number (Tag) |
Insert XML tag, which will be used for importing of Shop Item Number (ItemNrInt) to pixi*. The following values are possible:
|
Import Purchase Price as Supplier price for Variants |
If the value = 0 (default), the functionality is disabled. |
Multiply order qty with order unit |
Value = 0: The order gets imported as provided in the order XML. Value = 1 (default): The ordered quantity for each item gets multiplied with the packing unit that is defined for the item. |
Export Bundle Item |
Value = 0: (default) pixi does not export bundle stock to plentyONE Value = 1: pixi exports the available stock for bundles to plentyONE as physical stock; this only works in case the bundle in pixi is a normal item in plentyONE- otherwise plentyONE returns an error |
Import Warranty Orders |
When both the Import Warranty Orders and the Support Split Orders channel settings are enabled (Value = 1), warranty orders are imported together with sales and delivery orders. |
ItemImport_LastPageNumber |
The ItemImport_LastPageNumber channel setting specifies the number of Plenty "pages" already imported. By default, the setting is set to 0, but the counter automatically increments after each processed page and can also be reset or restarted from any "page" if needed. Value = 0 (default): Starts with the first page |
Allow Attribute Import |
Default value is 0(OFF) |
Consider AttributeName |
Default value is 0(OFF) |
Attribute Delimiter |
This setting defines a delimiter between variation name and attributes. Example with AttributeDelimiter = ','
|
Number of items to import |
This setting determines the number of items that will be imported to pixi. The default value is "100". |
Always Export Gdpr Data for Polling |
When this setting is enabled, pixi exports the email address and telephone number (GDPR-relevant data) during polling |
Number of Exported Items Per Batch |
Use this setting to control the number of items that are exported per batch. Bundles are considered in the export process. If bundles are sent to Plenty, the stock is not updated, but the XML is updated to the status "OK." |
Primary Barcode ID |
All imported items use the configured barcode ID as their primary barcode in pixi. Default value: 1 Important: All imported items will use the configured barcode ID as their primary barcode in pixi. Changing this setting after items have already been imported may result in inconsistencies between existing item data and newly imported data, which can affect downstream processes such as barcode scanning. |
Descriptions of Matching Table Settings
The table below contains a list of all available matching table settings for the plentyONE connection types.
XML field name |
Name |
Description |
|||||||||||||||
storeID |
ShopID |
See the documentation for MatchReferrerToShopID field in channel settings for more information. |
|||||||||||||||
method_of_payment |
Payment |
The following are the payment types in pixi* and the corresponding values in plentyONE:
|
|||||||||||||||
parcel_service |
ShipVendor |
If the parcel_service value is equal to the Shipping Vendor value in pixi*, it is automatically matched. Otherwise the value is read from the matching table. |
|||||||||||||||
parcel_service_preset_id |
ShipInstruct |
If the setting Control Center > Database Settings > Import / Export > Bestellimport (Opentrans): Don't hard code DHL transport remark on import is set to ON, the ShipInstruct values are read from the XML or from the matching table for the channel. If this setting is set to OFF, the values for the Ship Instruct are inserted in pixi* as hard coded. Ship Instruct must be in the format Verfahren | Product |Extras(for example, 53|5302|5311) |
|||||||||||||||
ShippingProfileID |
ShipInstruct |
If the setting Control Center > Database Settings > Import / Export > Bestellimport (Opentrans): Don't hard code DHL transport remark on import is set to ON, the ShipInstruct values are read from the matching table for the channel. The pixi* value must be entered in the format Verfahren | Product |Extras(for example, 53|5302|5311). If this setting is OFF, the values in pixi* are hard-coded and depend on the country of the delivery address and payment type:
|
|||||||||||||||
ShippingMethodID |
ShipVendor |
The ShippingMethodID value should be added to the matching table with the corresponding shipping vendor code in pixi*. If the ShippingMethodID value does not exist in the matching table, the default shipping vendor is inserted in pixi*. |
|||||||||||||||
referrerID |
Referrer |
See the documentation for MatchReferrerToShopID field in channel settings for more information. |
Custom matching between plentyONE and pixi*
Table below shows a list of fields from the XML that are imported to a field with different name in pixi*.
XML field name |
Name |
Information |
ExternalOrderID |
Gift message |
Value from “<ExternalOrderID>” field in the XML is displayed in “Gift message” field. |
Company |
Company |
Value from "<Company>" field in the XML is displayed in "Company" field. |
AdditionalName |
Address remarks |
Value from “<AdditionalName>” field in the XML is displayed in “Address remarks” field. |
Street |
Street, Nr. And Company |
Values from “<Street>” field get distributed between “Street”, “Nr.” And “Company” fields in pixi*. (Example: “<Street xsi:type="xsd:string"> PSTATION;1033;18</Street>” is imported to Street = PSTATION, Nr. = 18 and Company = 1033.) Only the postnumber should be included in the <Street> field. |
HouseNumber |
Nr. |
The value from <HouseNumber> is put to the "Nr." field in pixi*. (Example: "<HouseNumber |
ItemNo |
Shop Item Number |
Value from “<ItemNo>” field in the XML is stored as “Supplier item number” in pixi*. Channel setting “Shop Item Number (Tag)” must be set to “<ItemNo>” for it to work. Important:This only concerns the normal, stand-alone type of item. |
SupplierItemID |
Supplier Item Number |
Value from “<SupplierItemID>” field in the XML is stored as “Supplier item number” in pixi*. Channel setting “AddItemNrSupplier” must be set to “<SupplierItemID>” for it to work. Important:This only concerns the normal, stand-alone type of item. |
ColliNo |
Supplier Item Number |
Value from “<ColliNo>” field in the XML is stored as “Supplier item number” in pixi*. If this tag is empty, a combination of values from tags “<ItemnrInt>” and “<AttributeValueSetID>” (in format ItemnrInt_AttributeValueSetID) is used. Important:This only concerns the variant type of item imported from shop. |
PayPalTransactionREFID |
Transaction ID (payID) |
Value from Tag <PayPalTransactionREFID> is imported to field "payID" of the order in pixi* Customer Service for payment type PayPal |
Step 2 - Select Constraints for Import and Export
Constraints are a predefined set of rules, which prevent importing items or orders with missing, wrong or incompatible data to pixi*.
See: Imports 2.0 - Setup
Step 3 - Edit Database Settings
The general setup and configuration of Imports 2.0 functionality is also valid for plentyONE. These are located in different folders:
Control Center > Database settings > Imports 2.0
Control Center > Database settings > Imports 2.0 > Export
Control Center > Database Settings > Import/Export
Furthermore the following database settings in pixi* Control Center influence the functionality of the connection to plentyONE:
Setting |
Description |
Folder General > Number of decimal places for prices |
Number of decimal places used for rounding for prices. Default value is 2 decimal places. |
Folder General > Show Item Nr. Suppl. from MGS supplier |
If set to ON, item number supplier from MGS supplier (if exists) is always displayed for the item. |
Folder Import/Export > Folder OpenTRANS > Don't hard code DHL transport remark on import |
Enable this setting if you wish to import custom made DHL transport remarks from shop trough order import XML. |
Folder Import/Export > Folder BMEcat > DF-Type - Default Value |
This setting defines the default value of the direct fulfillment type of an order line if the order import XML does not contain any value. |
Start or Stop Import/Export Services
See: Imports 2.0 - Setup
Important information for Multi-Currency
Please be sure to use the latest supported Plenty SOAP API version.
All the prices in plentyONE are in the "plentyONE standard currency" (defined in the plentyONE settings), which means that the prices in the XML for the item and order import are in that currency.
Item import
Currency is not provided in the XML for item import, all the prices are in the "plentyONE standard currency"
for the ShopID (required at item import, to know the currency of the provided prices), the first shop from the Channel Matching Settings is used (you have to make sure the currency of the first shop in the Channel Matching Settings is the same as the home currency in the pixi* database and the "plentyONE standard currency")
Order import
XML for order import includes "Currency" and "ExchangeRatio" tags. The values in those tags define the order currency and the exchange rate - but in this case it is the exchange rate from the "plentyONE standard currency" to the order currency.
The following example of order import XML is for a case when the home, the shop currency (in pixi*) and the "plentyONE standard currency" are all EUR and the order currency is USD:
...
<Currency xsi:type="xsd:string">USD</Currency>
...
<ExchangeRatio xsi:type="xsd:float">1.1172</ExchangeRatio>
...
<Price xsi:type="xsd:float">20.00</Price>
...
The (gross) price for the item is 20,00 EUR. The calculation to the order currency (USD) is done with the provided exchange rate (1,1172), which means the price in pixi* is 22,34 USD. The exchange rate (1 EUR = 1,1172 USD) is also saved with the order, which allows pixi* to do the exact calculation from the order currency to the shop/home currency. (for reports).
Note: When an invoice is created, the exchange rate that is saved with the order is ignored and the system default exchange rate that is valid on the date of invoice creation is used.