Mirakl

Mirakl Offers API

The Offers API from Mirakl — 16 operation(s) for offers.

GitHub OpenAPI

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/offers/{offer} Get an offer's details · OF22 - Get information about an offer #
Ask an LLM
“How do I look up the details of a single offer?”
“Can I see the price an offer would have for a specific channel or customer organization?”
Tell an agent
Get offer {offer}.
Show offer {offer} priced for channel {pricing_channel_code}.
GET /api/offers/{offer}/quantity Get available stock for an offer · OF26 - Get the quantity of stock available for an offer #
Ask an LLM
“How much stock is left on a given offer?”
“Why does an offer show a quantity of zero even though it exists?”
Tell an agent
Get the available quantity for offer {offer}.
Check whether offer {offer} still has stock.
GET /api/offers/export Download changed offers as CSV (deprecated) · OF51 - Get offers CSV file #
Ask an LLM
“Can I still pull a synchronous CSV of offers changed since my last request?”
“Which offers were deleted since my last export, using the old CSV export?”
Tell an agent
Download the offers CSV of changes since {last_request_date}.
Export offers for channels {channel_codes} with the deprecated CSV endpoint.
POST /api/offers/export/async Start an asynchronous offer export · OF52 - Export offers CSV or JSON file asynchronously #
Ask an LLM
“What's the recommended way to export a large offer catalogue as CSV or JSON?”
“Can I split an offer export into chunks by size or item count?”
Tell an agent
Start an async offer export of offers updated since {last_request_date}.
Export offers as {export_type} in chunks of {items_per_chunk} items.
GET /api/offers/export/async/status/{tracking_id} Check an offer export's status · OF53 - Poll the status of an asynchronous offer export (OF52) #
Ask an LLM
“Is my asynchronous offer export finished yet?”
“Where do I get the file links once an offer export completes?”
Tell an agent
Check the status of offer export {tracking_id}.
Get the download URLs for completed offer export {tracking_id}.
GET /dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54 Download an offer export file chunk · OF54 - Retrieve offer files once asynchronous offer export is complete (OF52) #
Ask an LLM
“How do I fetch each chunk of a completed offer export?”
“Can I retrieve the actual offer file after the export is done?”
Tell an agent
Download the offer export chunk for {tracking_id}.
Retrieve the offer files produced by export {tracking_id}.
GET /api/products/offers List offers for given products · P11 - List offers for each given product #
Ask an LLM
“Which sellers have offers on a given product and at what price?”
“Can I compare competing offers for a product within a shipping zone?”
Tell an agent
List offers for products {product_ids}.
Show offers on products {product_ids} from shops {shop_ids}.
POST /api/offers/imports Import an offer file · OF01 - Import a file to create, update or delete offers #
Ask an LLM
“How do I bulk create, update or delete offers by uploading a file?”
“Can an offer file import also create the products?”
Tell an agent
Import offer file {file} in {import_mode} mode.
Upload {file} to update offers for shop {shop_id} in {import_mode} mode.
GET /api/offers/imports List offer file imports · OF04 - Get information and statistics about offer imports #
Ask an LLM
“What offer imports have I run recently and did they succeed?”
“Can I filter offer imports by status or date range?”
Tell an agent
List offer imports between {start_date} and {end_date}.
Show offer imports with status {status}.
GET /api/offers/imports/{import} Get an offer import's statistics · OF02 - Get information and statistics about an offer import #
Ask an LLM
“How many lines of my offer import succeeded or failed?”
“What's the status of a specific offer import?”
Tell an agent
Get the status and statistics of offer import {import}.
Check how offer import {import} went for shop {shop_id}.
GET /api/offers/imports/{import}/error_report Download an offer import error report · OF03 - Get the error report file for an offer import #
Ask an LLM
“Where can I see which lines failed in my offer import?”
“What file format is the offer import error report returned in?”
Tell an agent
Download the error report for offer import {import}.
Get the failed lines of offer import {import}.
GET /api/offers List a shop's offers · OF21 - List offers of a shop #
Ask an LLM
“What offers does my shop currently have?”
“Can I list only my favorite offers or those for a specific SKU?”
Tell an agent
List the offers of shop {shop_id}.
Show my offers for SKU {sku}.
POST /api/offers Create, update or delete offers via JSON · OF24 - Create, update, or delete offers #
Ask an LLM
“How do I update offers directly with a JSON payload instead of a file?”
“Do fields I leave out get reset when I update offers?”
Tell an agent
Send these offers {offers} to create or update them.
Update offers {offers} for shop {shop_id}.
POST /api/offers/pricing/imports Import an offer price file · PRI01 - Import a price file #
Ask an LLM
“How do I upload all prices for my offers from a CSV?”
“Are existing prices I don't include in the price file deleted?”
Tell an agent
Import price file {file}.
Upload price file {file} for shop {shop_id}.
GET /api/offers/pricing/imports List offer price imports · PRI02 - Get information and statistics about an offer pricing import #
Ask an LLM
“Did my last price file import finish without errors?”
“Can I list price imports by status or date?”
Tell an agent
Get the price import {import_id}.
List price imports with status {status} since {start_date}.
GET /api/offers/pricing/imports/{import_id}/error_report Download a price import error report · PRI03 - Get the error report for a price import in CSV format #
Ask an LLM
“Which offer prices failed in my price import and why?”
“Can I get a price error file that's ready to fix and reimport?”
Tell an agent
Download the error report for price import {import_id}.
Get the rejected price lines of import {import_id}.
POST /api/offers/stock/imports Import an offer stock file · STO01 - Import a stock file #
Ask an LLM
“How do I update stock levels for my offers from a CSV file?”
“Can I update stock per warehouse instead of globally?”
Tell an agent
Import stock file {file}.
Upload stock file {file} for shop {shop_id}.
GET /api/offers/stock/imports/{import_id}/status Get a stock import's status · STO02 - Get information and statistics about an offer stock import #
Ask an LLM
“Did my stock file import complete?”
“How many stock lines were processed in an import?”
Tell an agent
Get the status of stock import {import_id}.
Show statistics for stock import {import_id}.
GET /api/offers/stock/imports/{import_id}/error_report Download a stock import error report · STO03 - Get the error report for a stock import in CSV format #
Ask an LLM
“Which stock lines were rejected in my stock import?”
“Where do I get the stock errors as a CSV to fix and reupload?”
Tell an agent
Download the error report for stock import {import_id}.
Get the failed stock lines of import {import_id}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-offers-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/_original/mirakl-connect-channel-webhooks-openapi.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mirakl:mirakl-offers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mirakl-offers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mirakl Offers API
  version: ''
  description: 'Operations tagged Offers across 2 of this provider''s published API definitions: mirakl-mmp-front-openapi.yaml, mirakl-mmp-seller-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: URL to be replaced by your Mirakl instance URL
  url: https://your-instance.mirakl.net
tags:


# --- truncated at 32 KB (378 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-offers-api-openapi.yml