Step 1: Generate your API credentials in your fonQ account
The fonQ API uses the Mirakl platform, which means you will need a Mirakl- account to start sending your product listings to fonQ.
When you have a Mirakl fonQ account login and navigate to My user settings by clicking on your email address in the top right corner. After that, go to "API key" tab and click "generate API key" if there is no key available yet. If there is an API key available, you can use that one, you don't have to create a new one. Copy the API key as you will need this for the next step.
Next, you will need to find you Shop ID in your seller central. First select the shop you want to send products to in the top right corner. Next, go to My Account > Settings to find your Shop ID. Copy your Shop ID as well, you will need this for the next step.
Step 2: Create a new fonQ API in Channable
Go to Channable, open your project and go to APIs > Add new API. A new screen will open with the API Settings where you can click on the "+ Add new connection" button.
You will be forwarded to an overview in which you can select "fonQ" to create a new connection. Fill in a name for the connection under "Label", we recommend naming your connection "fonQ API". Fill in the API key and Shop ID you copied in step 1, and click the "Create" button to save your connection.
You will then be redirected back to the API Settings step where you can name your API. After choosing a name click on the "Continue" button to create your new fonQ API.
Difference between an Offer and a Product in the fonQ API
Before creating your products listings it is important to understand the difference between sending an Offer and a Product through the fonQ API.
- Offer: An offer only includes the fields in the build step of the API
- Product: A product has more information than an offer such as a filled out categorisation and attributes step and is needed when items are unknown to fonQ
If you do not have an NL shop and your products are not known to fonQ you will need to create an NL shop and set up a Product API for these unknown products. You will need to categorize these products and push them to the NL shop to make these products known. Once this is done you will then be able to set up a second API to create BE offers, but this will result in offers being created in the NL store as well. Therefore to avoid this you will need to clear the NL API once the products have been accepted.
Step 3: Create your product listings in Channable
Once you have created the fonQ API you can setup your product data by following the steps of the API.
- Categories
We advise to first try to send your products without doing the categories. If fonQ is already familiar with the EAN codes of your products, you will not need to do this step. If the products are not yet known, you will see the following error in the Preview step of the API: "mirakl_unknown_error_code". - Rules
Create different rules to optimize your products listings. For examples take a look at our common rules support article. - Build
Here you can find our preset template for the product listings. All you have to do is to fill it out by clicking on the field itself and selecting what you would like it to be filled with. For example, the field 'Title' should display the title of your product and so on. When you have finished setting up the product listings, just click 'save' on the bottom of the screen.
Tip! Notice the question mark behind every field; if you hover over the question mark you will see the description of the field and suggestions for possible values.
- Attributes
Just as with the Categories step, we advise to first try to send your products without doing the attributes. If fonQ is already familiar with the EAN codes of your products, you will not need to do this step.
Step 4: Send your product data to fonQ
Almost there, your product listings are ready to be sent. If you have not activated your project go to setup > Project settings on the left hand side of the screen and click "activate project". After, go back to the APIs overview and go to "Your fonQ API Name" > Settings where you activate the API by selecting "Activate API". After you have completed this step navigate back to the APIs overview and select the blue "Run now" button to sent your product listings to fonQ.
Step 5: Check your product listings for errors
If you have sent you product listings to fonQ go to the Preview tab of your fonQ API. Click on 'Errors'. Now you can see which product listings have errors and are not created. Click on a specific error to see more information on what is causing the error and check out our error solutions section on how to correct errors. If you see the "mirakle_unkown_error_code" for products, follow this guide on how to solve this error.