How to find your Mirakl shop API key and API host for Zendesk

By Jake Marsh · Updated November 13, 2026

Your Mirakl shop API key is in each marketplace's seller back office: open your user menu (top right) and choose API Key, then generate one if there is none. The API host is the host name of that marketplace's Mirakl API, such as yourmarketplace-prod.mirakl.net; it's in the marketplace's seller API documentation, or its seller support can give it to you. In Zendesk, enter both in Wharfwell's settings under Marketplace 1.

What you need per marketplace

Setting	Where to find it
API host	The marketplace's seller API documentation or seller support. Host name only: no `https://`, no path, lowercase
Shop API key	Seller back office > your user menu > API Key
Shop id (optional)	Only if your key reaches several shops on that marketplace

Each marketplace that runs on Mirakl has its own host and its own key. The API host is not the address of the back office you sign in to.

Steps

Sign in to the seller back office of the marketplace.
Open your user menu at the top right and choose API Key. Generate one if there is none and copy it.
Find the API host in the marketplace's seller API documentation, or ask its seller support.
Install Wharfwell from the Zendesk Marketplace and choose the Standard plan.
Fill in Marketplace 1. A Name your agents recognize (shown in the sidebar and in ticket notes), the API host and the Shop API key.
Add the optional settings for that marketplace: Shop id, a Back office link for "Open in back office" (an https:// link with {order_id} where the order id goes) and Brands whose tickets list this marketplace first (every marketplace is searched either way).
Repeat for up to four more marketplaces.
Open a ticket about an order to test. The order appears in the sidebar.

Use the right back office user

The key acts with the rights of the back office user it belongs to. Use a user who may manage orders and messages. If that user can't do something, Wharfwell shows the marketplace's refusal instead of guessing.

Generating a new key replaces the old one

When you generate a key in the back office, the old key stops working. If you ever do, paste the new one into Wharfwell straight away.

Error messages and fixes

The sidebar says	Fix
"did not accept the shop API key"	Paste the current key from that marketplace's back office (user menu > API Key)
"Nothing at ... answers like the Mirakl Seller API" or "answered with a web page"	The API host is wrong. Use the host from the seller API documentation, not the back office address
"is not set up yet"	The API host has `https://`, a path or capital letters. Enter the host name only
"is rate limiting requests"	The marketplace limits how often shops may call it. Wait a minute
"No order ... on your marketplaces"	The order belongs to a marketplace you haven't connected, or to another shop: set the Shop id

How the key is protected

Zendesk stores each key as a secure setting. Agents' browsers never receive it, and Zendesk only sends it to the API host you entered for that marketplace. Wharfwell has no server of its own.

What it costs

Wharfwell is $5 per agent per month, with every feature and up to five marketplaces, billed monthly by Zendesk with a 14-day trial. Mirakl's own Seller API reference is at developer.mirakl.com; our Wharfwell documentation covers every setting.

Wharfwell for Mirakl marketplaces

Mirakl marketplace orders on the ticket: refunds, cancels, tracking and replies, all logged. $5 a month per agent.

Install Wharfwell for Mirakl marketplaces About Wharfwell for Mirakl marketplaces Documentation

Questions

Is the Mirakl API URL the same for every marketplace?

No. Each marketplace has its own Mirakl instance and host name. Enter each one separately.

Do I need a Mirakl developer account?

No. The shop API key comes from your seller back office on each marketplace.

What is the Shop id for?

Only for keys that reach several shops on one marketplace. It tells the marketplace which shop's orders to return.