How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Mirakl

Mirakl Offers API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Mirakl Offers API is one of 34 APIs that Mirakl publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Offers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 19 operations across 16 paths, and defines 110 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://your-instance.mirakl.net.

19 operations 16 paths 110 schemas 14 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://your-instance.mirakl.net
Authentication
HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 6

Mirakl Offers API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token). It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token). It accepts HTTP bearer tokens (JWT) (operator_bearer_token). An API key is passed in the header as Authorization (Shop-API-Key). An API key is passed in the header as Authorization (shop_api_key).

  • OAuth-2 — For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…

Paths & Operations 19

Across 16 paths, the API surfaces 19 operations — 14 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Offers 19
GET
/api/offers/{offer}
OF22 - Get information about an offer
OF22 3 params → 200
GET
/api/offers/{offer}/quantitydeprecated
OF26 - Get the quantity of stock available for an offer.
OF26 1 param → 200
GET
/api/offers/exportdeprecated
OF51 - Get offers CSV file
OF51 6 params → 200
POST
/api/offers/export/async
OF52 - Export offers CSV or JSON file asynchronously
OF52 body → 200
GET
/api/offers/export/async/status/{tracking_id}
OF53 - Poll the status of an asynchronous offer export (OF52)
OF53 1 param → 200
GET
/dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54
OF54 - Retrieve offer files once asynchronous offer export is complete (OF52)
OF54 1 param → 200
GET
/api/products/offers
P11 - List offers for each given product
P11 13 params → 200
POST
/api/offers/imports
OF01 - Import a file to create, update or delete offers
OF01 body → 201
GET
/api/offers/imports
OF04 - Get information and statistics about offer imports
OF04 6 params → 200
GET
/api/offers/imports/{import}
OF02 - Get information and statistics about an offer import
OF02 1 param → 200
GET
/api/offers/imports/{import}/error_report
OF03 - Get the error report file for an offer import
OF03 1 param → 200
POST
/api/offers
OF24 - Create, update, or delete offers
OF24 1 param body → 201
GET
/api/offers
OF21 - List offers of a shop
OF21 7 params → 200
POST
/api/offers/pricing/imports
PRI01 - Import a price file
PRI01 body → 201
GET
/api/offers/pricing/imports
PRI02 - Get information and statistics about an offer pricing import
PRI02 6 params → 200
GET
/api/offers/pricing/imports/{import_id}/error_report
PRI03 - Get the error report for a price import in CSV format
PRI03 1 param → 200
POST
/api/offers/stock/imports
STO01 - Import a stock file
STO01 body → 201
GET
/api/offers/stock/imports/{import_id}/status
STO02 - Get information and statistics about an offer stock import
STO02 1 param → 200
GET
/api/offers/stock/imports/{import_id}/error_report
STO03 - Get the error report for a stock import in CSV format
STO03 1 param → 200

Schemas 110

The contract defines 110 schemas that model the data the API accepts and returns. The most detailed are OF54_Response_200_TextCsv_Ext_FileStructure (63 properties), OF54_Response_200_TextCsv_Ext_FileStructure_2 (62 properties), OF51_Response_200_TextCsv_Ext_FileStructure (62 properties), OF51_Response_200_TextCsv_Ext_FileStructure_2 (61 properties). Each schema is shown below with its type and property counts.

P11_Response_200_Products_ProductReferences
object
2 properties 2 required
OF22_Response_200_Discount
object
5 properties
OF54_Response_200_Ext_FileStructure_Prices
object
6 properties
P11_Response_200_Products_Offers_Fulfillment
object
1 property 1 required
OF22_Response_200_Discount_Ranges
object
2 properties 2 required
OF52_Response_200
object
1 property
OF22_Response_200_ApplicablePricing
object
8 properties 3 required
OF22_Response_200_AllPrices
object
8 properties 3 required
OF54_Response_200_Ext_FileStructure_Warehouses
object
2 properties
OF22_Response_200
object
48 properties 29 required
OF22_Response_200_ProductReferences
object
2 properties 2 required
OF54_Response_200_Ext_FileStructure_ShippingTypes
object
6 properties
P11_Response_200_Products_Offers_AllPrices_Context
object
5 properties
OF22_Response_200_EcoContributions
object
3 properties 1 required
OF22_Response_200_AllPrices_VolumePrices
object
4 properties 4 required
P11_Response_200_Products_Offers_ApplicablePricing
object
8 properties 3 required
OF22_Response_200_LogisticClass
object
2 properties 2 required
P11_Response_200_Products_Measurement
object
2 properties 1 required
P11_Response_200_Products_Offers_EcoContributions
object
3 properties 1 required
OF54_Response_200_Ext_FileStructure_Fulfillment
object
1 property
OF54_Response_200_TextCsv_Ext_FileStructure
object
Offer CSV output
63 properties
OF54_Response_200_Ext_FileStructure_EcoContributions
object
3 properties 1 required
OF54_Response_200_Ext_FileStructure_Measurement
object
2 properties
OF54_Response_200_Ext_FileStructure_RetailPrices
object
4 properties
OF26_Response_200
object
2 properties 2 required
P11_Response_200_Products_Offers_ShippingTypes
object
11 properties 6 required
P11_Response_200_Products_Offers_Discount
object
5 properties
P11_Response_200_Products_Offers_ApplicablePricing_VolumePrices
object
4 properties 4 required
P11_Response_200_Products
object
11 properties 6 required
P11_Response_200_Products_Offers_RetailPrices
object
5 properties 2 required
P11_Response_200_Products_Offers_LogisticClass
object
2 properties 2 required
OF54_Response_200_Ext_FileStructure_OfferAdditionalFields
object
3 properties
P11_Response_200_Products_Offers
object
45 properties 27 required
P11_Response_200_Products_Offers_ApplicablePricing_Context
object
5 properties
OF53_Response_200
object
4 properties
OF52_Request
object
12 properties
OF54_Response_200_Ext_FileStructure_LogisticClass
object
1 property
P11_Response_200_Products_Offers_OfferAdditionalFields
object
2 properties 1 required
OF22_Response_200_ApplicablePricing_VolumePrices
object
4 properties 4 required
OF22_Response_200_Fulfillment_Center
object
1 property 1 required
OF51_Response_200_TextCsv_Ext_FileStructure
object
Offer CSV output
62 properties
OF22_Response_200_RetailPrices
object
5 properties 2 required
P11_Response_200_Products_ProductMedia
object
3 properties 3 required
P11_Response_200_Products_Offers_AllPrices_VolumePrices
object
4 properties 4 required
P11_Response_200_Products_Offers_Discount_Ranges
object
2 properties 2 required
OF54_Response_200_Ext_FileStructure_Prices_VolumePrices
object
3 properties
P11_Response_200_Products_Offers_Warehouses
object
2 properties 2 required
P11_Response_200_Products_Offers_ShippingTypes_DeliveryTime
object
4 properties 4 required
OF22_Response_200_Warehouses
object
2 properties 2 required
OF22_Response_200_AllPrices_Context
object
5 properties
OF54_Response_200_Ext_FileStructure_ShippingTypes_DeliveryTime
object
2 properties
OF22_Response_200_ApplicablePricing_Context
object
5 properties
OF22_Response_200_Fulfillment
object
1 property 1 required
OF54_Response_200_Ext_FileStructure_Fulfillment_Center
object
1 property
P11_Response_200
object
1 property
OF54_Response_200_Ext_FileStructure_OngoingDiscountCampaigns
object
Ongoing discount campaign associated with the offer
1 property
OF53_Response_200_Error
object
2 properties
P11_Response_200_Products_Offers_AllPrices
object
8 properties 3 required
P11_Response_200_Products_Offers_Fulfillment_Center
object
1 property 1 required
OF22_Response_200_OfferAdditionalFields
object
2 properties 1 required
OF54_Response_200_Ext_FileStructure_Prices_Context
object
5 properties
OF54_Response_200_Ext_FileStructure
object
Offer JSON output
42 properties
OF24_Request_Offers_Discount_Ranges
object
Discount ranges. Offer update: if not provided, existing data will be deleted.
2 properties 2 required
STO02_Response_200
object
7 properties 5 required
OF24_Request
object
1 property 1 required
OF24_Request_Offers_RetailPrices
object
The retail prices of the offer, also referred to as selling prices. Applicable only for Dropship offers.
4 properties
PRI02_Response_200_Data
object
11 properties 11 required
STO01_Response_201
object
1 property
OF24_Request_Offers
object
Offers list
27 properties 6 required
OF24_Request_Offers_AllPrices_VolumePrices
object
The volume prices applicable for the offer.
3 properties 2 required
OF24_Request_Offers_OfferAdditionalFields
object
Custom fields of the offer
2 properties 1 required
OF24_Response_201
object
1 property 1 required
PRI01_Response_201
object
2 properties
PRI02_Response_200
object
3 properties 1 required
OF01_Response_201
object
2 properties 1 required
OF02_Response_200
object
14 properties 14 required
OF04_Response_200_Data
object
15 properties 14 required
OF24_Request_Offers_AllPrices
object
The volume and channel prices.
6 properties
OF24_Request_Offers_Discount
object
Discount of an offer. Offer update: if not provided, existing data will be deleted.
4 properties
OF24_Request_Offers_EcoContributions
object
3 properties 1 required
OF04_Response_200
object
3 properties 1 required
OF22_Response_200_2
object
45 properties 26 required
P11_Response_200_Products_Offers_2
object
37 properties 22 required
P11_Response_200_Products_Offers_OfferAdditionalFields_2
object
2 properties 1 required
OF21_Response_200_Offers
object
45 properties 26 required
OF21_Response_200_Offers_Fulfillment
object
1 property 1 required
OF22_Response_200_EcoContributions_2
object
3 properties 1 required
OF54_Response_200_Ext_FileStructure_EcoContributions_2
object
3 properties 1 required
OF21_Response_200_Offers_RetailPrices
object
5 properties 2 required
OF52_Request_2
object
10 properties
OF21_Response_200_Offers_Discount_Ranges
object
2 properties 2 required
OF21_Response_200_Offers_Warehouses
object
2 properties 2 required
OF21_Response_200_Offers_ApplicablePricing_VolumePrices
object
4 properties 4 required
OF21_Response_200_Offers_AllPrices_Context
object
5 properties
OF21_Response_200_Offers_EcoContributions
object
3 properties 1 required
P11_Response_200_Products_Offers_EcoContributions_2
object
3 properties 1 required
OF21_Response_200
object
2 properties 2 required
OF21_Response_200_Offers_ApplicablePricing
object
8 properties 3 required
OF21_Response_200_Offers_AllPrices
object
8 properties 3 required
OF21_Response_200_Offers_Fulfillment_Center
object
1 property 1 required
OF21_Response_200_Offers_LogisticClass
object
2 properties 2 required
OF21_Response_200_Offers_Discount
object
5 properties
OF21_Response_200_Offers_AllPrices_VolumePrices
object
4 properties 4 required
OF54_Response_200_TextCsv_Ext_FileStructure_2
object
Offer CSV output
62 properties
OF21_Response_200_Offers_ApplicablePricing_Context
object
5 properties
P11_Response_200_Products_Offers_LogisticClass_2
object
2 properties 2 required
OF51_Response_200_TextCsv_Ext_FileStructure_2
object
Offer CSV output
61 properties
OF21_Response_200_Offers_ProductReferences
object
2 properties 2 required
OF21_Response_200_Offers_OfferAdditionalFields
object
2 properties 1 required
OF54_Response_200_Ext_FileStructure_2
object
Offer JSON output
41 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-offers-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
AE Profile APIs.io
Mirakl Catalog Configuration API
AE Profile APIs.io
Mirakl Incidents API
AE Profile APIs.io
Mirakl Invoicing and Accounting API
AE Profile APIs.io
Mirakl Messages API
AE Profile APIs.io
Mirakl Multiple shipments API
AE Profile APIs.io
Mirakl Orders API
AE Profile APIs.io
Mirakl Picklists API
AE Profile APIs.io
Mirakl Platform Settings API
AE Profile APIs.io
Mirakl Product Feedback API
AE Profile APIs.io
Mirakl Products API
AE Profile APIs.io
Mirakl Promotions API
AE Profile APIs.io
#Offers
← Back to M APIs
API Details
ID
mirakl:mirakl-offers-api
Base URL
https://your-instance.mirakl.net
Docs
https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3
Provider
Mirakl
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mirakl-offers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mirakl-offers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Mirakl Offers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.