In order to make use of this you are required to have your API settings configured correctly and have a valid API token.
Using a version below 3.0.0 of the integration? Please read the "Configuring API settings" page in order to setup your connection to the Copernica Marketing Software.
Using version 3.0.0 of the integration or later? Please read the "Configuring REST settings" page in order to setup your connection to the Copernica Marketing Software.
You also are required to have a database created on Copernica and have it set through the menu item "Database" on "Link Fields".
Configuring Collection fields
In order to configure collection fields in Copernica you need to login on the admin of Magento and go to the Copernica menu and select the "Link Fields" menu item.
Once there you need to select one of the "collection" menu items shown in the screenshot below.
In this guide the collection 'Cart items collection' will be used in the examples as the steps are the same for each collection, the only difference is the specific fields that a collection has for synchronization.
Creating a collection on Copernica through the API:
In order to create a collection you need to fill in a collection name, in this example the field is called 'Cart items collection'.
Once this has been entered you need to click 'Save' shown in the screenshot below.
Do note that if the collection already exists on your copernica account it will use that collection ( only when using the same database ).
There will be a loading screen and it may take a while.
Adding profile fields to your collection:
To add collection fields to your collection on Copernica you need to fill in the fields and click 'Save' shown in the screenshot below.
What you enter in those fields is what the fields on Copernica will be called.
There will be a loading screen and it may take a while.
You can choose to do this along with "creating a collection" by filling in all fields at once.
Validating your database and its fields:
To validate your collection and its fields you need to click 'Validate' shown in the screenshot below.
This will show a message(s) whether the names correspond to the collection name and field names that exist on Copernica.
There will be a loading screen and it may take a while.
If your database name is not correct it will show the following errors.
If your field name is not correct it will show the following error.
The collections represent the tables within the Copernica database and the fields represent its columns.
Each profile ( aka. customer ) will have its own data within these collections.
| Cart items collection | This will hold the data from cart items of a customer |
|---|---|
| Orders collection | This will hold the data from orders of a customer |
| Order items colelction | This will hold the data from order items of a customer's order |
| Address collection | This will hold the data from addresses of an order's billing and shipping address |
| Viewed products collection | This will hold the data from products that were viewed by a customer |
| Wishlist items collection | This will hold the data from wishlist items of a customer |