Mirakl Offers API
The Offers API from Mirakl — 16 operation(s) for offers.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mirakl-offers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Mirakl Offers API
version: ''
description: 'Operations tagged Offers across 3 of this provider''s published API definitions: mirakl-mmp-front-openapi.yaml, mirakl-mmp-operator-openapi.json, 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:
- name: Offers
paths:
/api/offers/{offer}:
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: At each offer page display</div>
<div class="max-call-frequency">Maximum usage: At each offer page display</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integrating_mirakl/integrate_price_approval.htm">If the "Price approval" option is activated, read this page</a></li><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integration_guide/adv_pricing_inte/adv_pricing_offer_apis.htm#Aboutprioritizationrulesforpricefields">Price prioritization for Advanced Pricing</a></li></ul><div class="extension-title">Localization</div>
<p>This resource supports <code>locale</code> parameter (<a href="#section/Locale">see documentation</a>)</p><p>Localized output fields will be highlighted with an icon: <span class="flag"></span></p></div>'
operationId: OF22
parameters:
- description: Offer identifier
explode: false
in: path
name: offer
required: true
schema:
type: integer
format: int64
style: simple
- description: Filter used to pick prices on a specific channel
explode: true
in: query
name: pricing_channel_code
required: false
schema:
type: string
style: form
- description: For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist.
explode: true
in: query
name: pricing_customer_organization_id
required: false
schema:
type: string
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values for single channel pricing users (application/json)
value:
active: true
all_prices:
- channel_code: null
discount_end_date: '2019-04-29T22:00:00Z'
discount_start_date: '2019-03-31T22:00:00Z'
price: 49
unit_discount_price: 49
unit_origin_price: 50
volume_prices:
- price: 49
quantity_threshold: 1
unit_discount_price: 49
unit_origin_price: 50
- price: 44
quantity_threshold: 50
unit_discount_price: 44
unit_origin_price: 45
- price: 39
quantity_threshold: 100
unit_discount_price: 39
unit_origin_price: 40
- channel_code: US
context:
channel_codes:
- US
discount_end_date: '2019-04-29T22:00:00Z'
discount_start_date: '2019-03-31T22:00:00Z'
price: 59
unit_discount_price: 59
unit_origin_price: 60
volume_prices:
- price: 59
quantity_threshold: 1
unit_discount_price: 59
unit_origin_price: 60
- price: 49
quantity_threshold: 50
unit_discount_price: 49
unit_origin_price: 50
- price: 44
quantity_threshold: 100
unit_discount_price: 44
unit_origin_price: 45
- channel_code: US
context:
channel_codes:
- US
customer_group_ids:
- Group2
- Group3
customer_organization_ids:
- Org1
end_date: '2023-12-31T23:59:59Z'
start_date: '2023-01-01T00:00:00Z'
discount_end_date: '2023-01-31T22:00:00Z'
discount_start_date: '2023-03-31T22:00:00Z'
price: 29
unit_discount_price: 29
unit_origin_price: 30
volume_prices:
- price: 29
quantity_threshold: 1
unit_discount_price: 29
unit_origin_price: 30
- price: 19
quantity_threshold: 20
unit_discount_price: 19
unit_origin_price: 20
- price: 14
quantity_threshold: 100
unit_discount_price: 14
unit_origin_price: 15
allow_quote_requests: false
applicable_pricing:
channel_code: US
context:
channel_codes:
- US
customer_group_ids:
- Group2
- Group3
customer_organization_ids:
- Org1
end_date: '2023-12-31T23:59:59Z'
start_date: '2023-01-01T00:00:00Z'
discount_end_date: '2023-01-31T22:00:00Z'
discount_start_date: '2023-03-31T22:00:00Z'
price: 29
unit_discount_price: 29
unit_origin_price: 30
volume_prices:
- price: 29
quantity_threshold: 1
unit_discount_price: 29
unit_origin_price: 30
- price: 19
quantity_threshold: 20
unit_discount_price: 19
unit_origin_price: 20
- price: 14
quantity_threshold: 100
unit_discount_price: 14
unit_origin_price: 15
available_end_date: '2019-09-29T22:00:00Z'
available_start_date: '2019-03-31T22:00:00Z'
category_code: '3016100'
category_label: Shoes
channels:
- FR
- US
currency_iso_code: USD
description: Offer for product MKP100000000154824
discount:
discount_price: null
end_date: '2019-04-29T22:00:00Z'
origin_price: 50
ranges:
- price: 49
quantity_threshold: 1
- price: 44
quantity_threshold: 50
- price: 39
quantity_threshold: 100
start_date: '2019-03-31T22:00:00Z'
eco_contributions:
- eco_contribution_amount: 3.59
epr_category_code: FR-DEA
producer_id: FR123456_89ABCD
- eco_contribution_amount: 0.99
epr_category_code: DE-WEEE
producer_id: ProducerID1
fulfillment:
center:
code: DEFAULT
inactivity_reasons:
- SHOP_NOT_OPEN
- ZERO_QUANTITY
leadtime_to_ship: 10
logistic_class:
code: M
label: Medium
max_order_quantity: 5
min_order_quantity: 1
min_quantity_alert: 1
min_shipping_price: 0
min_shipping_price_additional: 0
min_shipping_type: CLC
min_shipping_zone: DOM1
model: MARKETPLACE
offer_additional_fields:
- code: ecotax
type: NUMERIC
value: '20'
- code: gift-wrap
type: BOOLEAN
value: 'true'
- code: min-quantity-ordered
type: NUMERIC
value: '5'
offer_id: 2135
package_quantity: 1
price: 49
price_additional_info: Apply Discount prices
product_brand: Capture
product_description: 'Cobalt, fuchsia, leopard print: imitation suede upper. Synthetic lining, upper and sole. Almond toe court with cushioned sole. Heel height 9cm.'
product_references:
- reference: '9400016774345'
reference_type: EAN
product_sku: MKP100000000154824
product_title: Capture Coloured Court Shoe - 10
quantity: 1000000
shipping_deadline: '2019-09-01T23:59:59.999Z'
shop_grade: 4
shop_id: 2000
shop_name: ACME SHOP
shop_sku: S2002
state_code: '11'
total_price: 49
warehouses:
- code: WAREHOUSE_001
quantity: 750000
- code: WAREHOUSE_002
quantity: 250000
application/json-1:
summary: Example with business values for multi channel pricing users (application/json)
value:
active: true
all_prices:
- channel_code: null
discount_end_date: '2019-04-29T22:00:00Z'
discount_start_date: '2019-03-31T22:00:00Z'
price: 49
unit_discount_price: 49
unit_origin_price: 50
volume_prices:
- price: 49
quantity_threshold: 1
unit_discount_price: 49
unit_origin_price: 50
- price: 44
quantity_threshold: 50
unit_discount_price: 44
unit_origin_price: 45
- price: 39
quantity_threshold: 100
unit_discount_price: 39
unit_origin_price: 40
- channel_code: null
context:
channel_codes:
- US
discount_end_date: '2019-04-29T22:00:00Z'
discount_start_date: '2019-03-31T22:00:00Z'
price: 59
unit_discount_price: 59
unit_origin_price: 60
volume_prices:
- price: 59
quantity_threshold: 1
unit_discount_price: 59
unit_origin_price: 60
- price: 49
quantity_threshold: 50
unit_discount_price: 49
unit_origin_price: 50
- price: 44
quantity_threshold: 100
unit_discount_price: 44
unit_origin_price: 45
- channel_code: null
context:
channel_codes:
- US
- FR
customer_group_ids:
- Group2
- Group3
customer_organization_ids:
- Org1
end_date: '2023-12-31T23:59:59Z'
start_date: '2023-01-01T00:00:00Z'
discount_end_date: '2023-01-31T22:00:00Z'
discount_start_date: '2023-03-31T22:00:00Z'
price: 29
unit_discount_price: 29
unit_origin_price: 30
volume_prices:
- price: 29
quantity_threshold: 1
unit_discount_price: 29
unit_origin_price: 30
- price: 19
quantity_threshold: 20
unit_discount_price: 19
unit_origin_price: 20
- price: 14
quantity_threshold: 100
unit_discount_price: 14
unit_origin_price: 15
allow_quote_requests: false
applicable_pricing:
channel_code: null
context:
channel_codes:
- US
- FR
customer_group_ids:
- Group2
- Group3
customer_organization_ids:
- Org1
end_date: '2023-12-31T23:59:59Z'
start_date: '2023-01-01T00:00:00Z'
discount_end_date: '2023-01-31T22:00:00Z'
discount_start_date: '2023-03-31T22:00:00Z'
price: 29
unit_discount_price: 29
unit_origin_price: 30
volume_prices:
- price: 29
quantity_threshold: 1
unit_discount_price: 29
unit_origin_price: 30
- price: 19
quantity_threshold: 20
unit_discount_price: 19
unit_origin_price: 20
- price: 14
quantity_threshold: 100
unit_discount_price: 14
unit_origin_price: 15
available_end_date: '2019-09-29T22:00:00Z'
available_start_date: '2019-03-31T22:00:00Z'
category_code: '3016100'
category_label: Shoes
channels:
- FR
- US
currency_iso_code: USD
description: Offer for product MKP100000000154824
discount:
discount_price: null
end_date: '2019-04-29T22:00:00Z'
origin_price: 50
ranges:
- price: 49
quantity_threshold: 1
- price: 44
quantity_threshold: 50
- price: 39
quantity_threshold: 100
start_date: '2019-03-31T22:00:00Z'
eco_contributions:
- eco_contribution_amount: 3.59
epr_category_code: FR-DEA
producer_id: FR123456_89ABCD
- eco_contribution_amount: 0.99
epr_category_code: DE-WEEE
producer_id: ProducerID1
fulfillment:
center:
code: DEFAULT
inactivity_reasons:
- SHOP_NOT_OPEN
- ZERO_QUANTITY
leadtime_to_ship: 10
logistic_class:
code: M
label: Medium
max_order_quantity: 5
min_order_quantity: 1
min_quantity_alert: 1
min_shipping_price: 0
min_shipping_price_additional: 0
min_shipping_type: CLC
min_shipping_zone: DOM1
model: MARKETPLACE
offer_additional_fields:
- code: ecotax
type: NUMERIC
value: '20'
- code: gift-wrap
type: BOOLEAN
value: 'true'
- code: min-quantity-ordered
type: NUMERIC
value: '5'
offer_id: 2135
package_quantity: 1
price: 49
price_additional_info: Apply Discount prices
product_brand: Capture
product_description: 'Cobalt, fuchsia, leopard print: imitation suede upper. Synthetic lining, upper and sole. Almond toe court with cushioned sole. Heel height 9cm.'
product_references:
- reference: '9400016774345'
reference_type: EAN
product_sku: MKP100000000154824
product_title: Capture Coloured Court Shoe - 10
quantity: 1000000
shipping_deadline: '2019-09-01T23:59:59.999Z'
shop_grade: 4
shop_id: 2000
shop_name: ACME SHOP
shop_sku: S2002
state_code: '11'
total_price: 49
warehouses:
- code: WAREHOUSE_001
quantity: 750000
- code: WAREHOUSE_002
quantity: 250000
application/json-auto:
summary: Complete example with value types (application/json)
value:
active: true
all_prices:
- channel_code: string
context:
channel_codes:
- string
customer_group_ids:
- string
customer_organization_ids:
- string
end_date: '2023-03-28T09:34:42Z'
start_date: '2023-03-28T09:34:42Z'
discount_end_date: '2023-03-28T09:34:42Z'
discount_start_date: '2023-03-28T09:34:42Z'
price: 0
unit_discount_price: 0
unit_origin_price: 0
volume_prices:
- price: 0
quantity_threshold: 0
unit_discount_price: 0
unit_origin_price: 0
allow_quote_requests: true
applicable_pricing:
channel_code: string
context:
channel_codes:
- string
customer_group_ids:
- string
customer_organization_ids:
- string
end_date: '2023-03-28T09:34:42Z'
start_date: '2023-03-28T09:34:42Z'
discount_end_date: '2023-03-28T09:34:42Z'
discount_start_date: '2023-03-28T09:34:42Z'
price: 0
unit_discount_price: 0
unit_origin_price: 0
volume_prices:
- price: 0
quantity_threshold: 0
unit_discount_price: 0
unit_origin_price: 0
available_end_date: '2023-03-28T09:34:42Z'
available_start_date: '2023-03-28T09:34:42Z'
category_code: string
category_label: string
channels:
- string
currency_iso_code: AED
description: string
discount:
discount_price: 0
end_date: '2023-03-28T09:34:42Z'
origin_price: 0
ranges:
- price: 0
quantity_threshold: 0
start_date: '2023-03-28T09:34:42Z'
eco_contributions:
- eco_contribution_amount: 0
epr_category_code: FR-AGROPACK
producer_id: string
favorite_rank: 0
fulfillment:
center:
code: string
inactivity_reasons:
- PRODUCT_STATUS_NEW
leadtime_to_ship: 0
logistic_class:
code: string
label: string
max_order_quantity: 0
min_order_quantity: 0
min_quantity_alert: 0
min_shipping_price: 0
min_shipping_price_additional: 0
min_shipping_type: string
min_shipping_zone: string
model: MARKETPLACE
msrp: 0
offer_additional_fields:
- code: string
type: STRING
offer_id: 0
package_quantity: 0
price: 0
price_additional_info: string
product_brand: string
product_description: string
product_references:
- reference: string
reference_type: string
product_sku: string
product_tax_code: string
product_title: string
quantity: 0
retail_prices:
- discount_end_date: '2023-03-28T09:34:42Z'
discount_start_date: '2023-03-28T09:34:42Z'
price: 0
unit_discount_price: 0
unit_origin_price: 0
shipping_deadline: '2023-03-28T09:34:42Z'
shop_grade: 0
shop_id: 0
shop_name: string
shop_sku: string
state_code: string
total_price: 0
warehouses:
- code: string
quantity: 0
schema:
type: object
$ref: '#/components/schemas/OF22_Response_200'
description: OK
security:
- Front-Bearer-Token: []
- OAuth-2: []
summary: OF22 - Get information about an offer
tags:
- Offers
servers:
- description: URL to be replaced by your Mirakl instance URL
url: https://your-instance.mirakl.net
/api/offers/{offer}/quantity:
get:
deprecated: true
description: '<div class="extension-title">Description</div>
<p>Quantity return rules:<ul><li> 0: if quantity = 0 or the offer is not available</li><li> x: quantity available</li></ul></p>
<div class="api-description-extension">
</div>'
operationId: OF26
parameters:
- description: Offer ID
explode: false
in: path
name: offer
required: true
schema:
type: integer
format: int64
style: simple
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
offer_id: 2087
quantity: 7
application/json-auto:
summary: Complete example with value types (application/json)
value:
offer_id: 0
quantity: 0
schema:
type: object
$ref: '#/components/schemas/OF26_Response_200'
description: OK
security:
- Front-Bearer-Token: []
- OAuth-2: []
summary: OF26 - Get the quantity of stock available for an offer.
tags:
- Offers
x-badges:
- color: noIntegrationBadge
name: ⚠️ No Integration Allowed ⚠️
position: after
servers:
- description: URL to be replaced by your Mirakl instance URL
url: https://your-instance.mirakl.net
/api/offers/export:
get:
deprecated: true
description: '<div class="extension-title">Deprecated endpoint</div>
This API is going to be removed in a future update, please use APIs OF52, OF53, and OF54 instead.
<div class="extension-title">Description</div>
Get a CSV file that includes the offers updated and deleted since the last request date.<br/>For deleted offers, only offer-id, product-sku, shop-id, shop-sku, active and deleted columns are returned. <br/>If the last_request_date param is not set the api returns all the active offers (inactive offers can be included with include_inactive_offers parameter).<br/>If offers have custom fields, a column is added for each existing custom field with as header the code of the custom field.<br/><br/>Results are sorted by offer identifier.
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: <br/>- Differential: every 5 minutes <br/>- Full: once per day</div>
<div class="max-call-frequency">Maximum usage: <br/>- Differential: once per minute <br/>- Full: once per day</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integrating_mirakl/export_offers.html">More context about exporting offers (synchronous)</a></li><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integration_guide/integrate_offers_from_sellers_in_system.html">More context about integrating offers from sellers</a></li></ul></div>'
operationId: OF51
parameters:
- description: Date and time of your last request.<br/>If provided, retrieves all offers updated since this date and time, including deleted and inactive offers.<br/>If not provided, retrieves all active offers only, unless otherwise specified in the <i>include_inactive_offers</i> field.
explode: true
in: query
name: last_request_date
required: false
schema:
type: string
format: date-time
style: form
- description: List of the channel codes to filter with, using a comma (,) as a separator. If specified, only offers that can be sold on the specified channel(s) will be returned. If not, offers will be returned regardless of their channels.
explode: true
in: query
name: channel_codes
required: false
schema:
type: string
style: form
- description: List of the shipping zones codes to filter with, URL-encoded and using a comma (,) as a separator. If specified, only shipping information linked to the given zones will be returned. Otherwise, all shipping information for all zones will be returned.
explode: true
in: query
name: shipping_zones
required: false
schema:
type: string
style: form
- description: When calling the API in full mode (i.e. when no <i>last_request_date</i> is provided), inactive offers are not returned. To retrieve both active and inactive offers, set this field to true.<br />When calling the API in differential mode (i.e. when the <i>last_request_date</i> is provided), both active and inactive offers are returned. This field cannot be used in differential mode otherwise the call fails.
explode: true
in: query
name: include_inactive_offers
required: false
schema:
type: boolean
default: false
style: form
- description: List of the fields to include, URL-encoded and using a comma (,) as a separator. If specified, only listed fields will be returned.
explode: true
in: query
name: include_fields
required: false
schema:
type: string
style: form
- description: A comma separated list of platform models to filter with. Accepted values are <code>MARKETPLACE</code>, <code>DROPSHIP</code>, <code>ONE_CREDITOR</code>
explode: true
in: query
name: models
required: false
schema:
type: string
style: form
responses:
'200':
content:
text/csv:
examples:
text/csv-0:
summary: Example with business values (text/csv)
value: 'offer-id;product-sku;min-shipping-price;min-shipping-price-additional;min-shipping-zone;min-shipping-type;price;total-price;price-additional-info;quantity;description;state-code;shop-id;shop-name;professional;premium;logistic-class;active;favorite-rank;channels;deleted;origin-price;discount-start-date;discount-end-date;available-start-date;available-end-date;discount-price;currency-iso-code;discount-ranges;leadtime-to-ship;allow-quote-requests;price-ranges;fulfillment-center-code;shop-sku;date-created;last-updated;model;min-order-quantity;max-order-quantity;package-quantity;price[channel=CA];origin-price[channel=CA];discount-start-date[channel=CA];discount-end-date[channel=CA];discount-price[channel=CA];discount-ranges[channel=CA];price-ranges[channel=CA];price[channel=FR];origin-price[channel=FR];discount-start-date[channel=FR];discount-end-date[channel=FR];discount-price[channel=FR];discount-ranges[channel=FR];price-ranges[channel=FR];price[channel=BFR];origin-price[channel=BFR];discount-start-date[channel=BFR];discount-end-date[channel=BFR];discount-price[channel=BFR];discount-ranges[channel=BFR];price-ranges[channel=BFR];price[channel=CHR];origin-price[channel=CHR];discount-start-date[channel=CHR];discount-end-date[channel=CHR];discount-price[channel=CHR];discount-ranges[channel=CHR];price-ranges[channel=CHR];price[channel=US];origin-price[channel=US];discount-start-date[channel=US];discount-end-date[channel=US];discount-price[channel=US];discount-ranges[channel=US];price-ranges[channel=US];ecotax;gift-wrap;min-quantity-ordered;measurement-units;producer-id[FR-DEA];eco-contribution-amount[FR-DEA];producer-id[DE-WEEE];eco-contribution-amount[DE-WEEE]
2130;MKP100000000037254;0.00;0.00;DOM1;CLC;50.00;50.00;;40;;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;;;;;;USD;;;false;1|50.00;DEFAULT;sku-2130;2019-01-31T22:00:00Z;2024-01-07T08:52:10Z;MARKETPLACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kg|1.00000000,L|1.00000000;FR123456_89ABCD;3.59;ProducerID1;0.99
2131;MKP100000000025008;0.00;0.00;DOM1;CLC;50.00;50.00;;20;;11;2000;ACME SHOP;true;true;M;true;;FR|US;false;50.00;;;;;;USD;;;false;1|50.00;DEFAULT;sku-2130;2019-03-31T22:00:00Z;2024-01-07T08:52:10Z;MARKETPLACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;FR123456_89ABCD;3.59;ProducerID1;0.99
2135;MKP100000000154824;0.00;0.00;DOM1;CLC;49.00;49.00;Apply Discount prices;10
# --- truncated at 32 KB (384 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-offers-api-openapi.yml