PlentyONE Transmitter

We provide a full configured station template with the necessary datamap and jobs for the Dynamic JSON Transmitter!

---

Setup the transmitter

In the settings you need to setup the following things:

1. The API-Url to the PlentyONE system
2. The username of the created api user
3. The password of the created api user

 

Setup the jobs

Each job needs the following configuration

1. The PlentyONE Id
2. The default language for the export

Below you find an example for the product job

 

Where to find the url and PlentyONE Id?

In you PlentyONE System hover over the shop icon. There you can copy the necessary values.

 
Copy the “plenty ID” and the “REST API”-Url.

How to create the API-User?

Head to the Settings and click on “Account Management”. There you can create a new user. Save the username and password for the transmitter settings.
Important: check the “API users only” checkbox!

 

Node Mappings

Please ensure that the nodemap settings are set correctly to identify products and variants and to differentiate if the record needs to be created/updated or deleted.

 

Configuring the datamaps

All necessary values for an export are already configured. You can add your own rows according to the official PlentyONE API documentation here (Link leads to PlentyONE API Documentation)
The last row in the datamaps is always called ‘additionalInformation’. This row is ignored by PlentyONE but is necessary for the connector to work. In this row the csrecordid and the csrecordclass are stored.

Categories

First configure the category datamap because products can only be sent when categories exist. The identifier for the category is sent in the datamap row “name” in the default language only.
The name needs to be unique!
 
“parentCategoryId”: row is required, but can be ‘null’ when the category is the first level category.
“type”: always set this value to “item” as configured in the template.
Below “details” are language dependent values.
 

Products

The identifier for items (product container) is the “number” of their default (main) variation.
(Datamap row: “variations||number”) If the product itself has variants, you can use the PdmarticleId but for simple products you should use the SKU.
Required fields for exporting items:

Row	Explanation
variations||number	Identifier for the item (product container)
variationAttributes|[replace_recursive]	Needed if exporting complex articles to create variant building attributes
variants	SKUs of the variants for the variant export (jump to details)
variations||variationCategories||categoryId	Name of the category the item should get linked to
variations||unit|unitId” and “variations||unit|content	The unit id and number

 
For the unitId:
You can find the Ids in PlentyONE under “Settings” -> “Article” -> “Units”

 
If you export products with variants you need to configure the row called ‘variants’ in the product datamap, in which an array of the skus from the variants is stored.
To correctly link the variants to the product, select the same attribute as SKU in the product datamap loop context that you also select in the variant datamap for “number” and ensure that the ‘Add linked products to the export “ checkbox is checked!
 

Example for variant linking

1. product datamap

 
2. variant datamap

Variants

Variants are called “variations” in PlentyONE.
In the variants datamap you also have some required datamap rows

Row	Explanation
number	Identifier for the variation
variationAttributeValues|[replace_recursive]	The values for the variant building attributes
variations||unit|unitId” and “variations||unit|content	see product

 

Image upload

Every image is either uploaded to PlentyONE as base64 encoded image or linked via an external link. Product images can be selected in the “images|[replace_recursive]” datamap row and variant images will be selected in the “variantImages|[replace_recursive]” datamap row (product datamap).
To link the image to the variant you also need to maintain the row “images” in the variant datamap, where only the filename is exported.
 
Important: The filename should be transformed with a transformation list to replace spaces and underscores with hyphens!

 

 

Was this article helpful?

1 0

How can we improve this article?

Please submit the reason for your vote so that we can improve the article.

Name

Email

Submit