- Mirakl Platform
- Rest Front APIs
- OF51 - Get offers CSV file
This API is going to be removed in a future update, please use APIs OF52, OF53, and OF54 instead.
Get a CSV file that includes the offers updated and deleted since the last request date.
For deleted offers, only offer-id, product-sku, shop-id, shop-sku, active and deleted columns are returned.
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).
If offers have custom fields, a column is added for each existing custom field with as header the code of the custom field.
Results are sorted by offer identifier.
- Differential: every 5 minutes
- Full: once per day
- Differential: once per minute
- Full: once per day
When calling the API in full mode (i.e. when no last_request_date is provided), inactive offers are not returned. To retrieve both active and inactive offers, set this field to true.
When calling the API in differential mode (i.e. when the last_request_date is provided), both active and inactive offers are returned. This field cannot be used in differential mode otherwise the call fails.
- URL to be replaced by your Mirakl instance URLhttps://your-instance.mirakl.net/api/offers/export
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/export?last_request_date=2019-08-24T14%3A15%3A22Z&channel_codes=string&shipping_zones=string&include_inactive_offers=false&include_fields=string&models=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'OK
text/csv
The offer custom fields are not listed here. Each custom field will have its own column in the CSV file, with the custom field code as the column name.
ISO code of the currency
Enum: "AED", "ARS", "AUD", "BAM", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "GEL", "GTQ", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "JOD", "JPY", "KES", "KRW", "KWD", "LKR", "MAD", "MGA", "MXN", "MYR", "NGN", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "TND", "TRY", "THB", "TWD", "UAH", "USD", "UYU", "UZS", "VND", "ZAR"
Minimum delivery time.
Returned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.
Maximum delivery time.
Returned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.
The end date of the discount period.
For Dropship specifically: the end date of the discount period on the purchasing price
The end date of the discount period for the indicated channel, when the Channel Pricing feature is activated.
Can be empty. In this case, the discount price applies from the start date and is then always available for the indicated channel.
The discount price of the offer
For Dropship specifically: the discount purchasing price of the offer, also referred to as cost or wholesale price
The discount price of an offer for the indicated channel, when the Channel Pricing feature is activated.
Can be empty when no discount price is defined for a given channel. In this case, the default discount price of the offer applies to the indicated channel.
The ranges of the discount prices when the Volume Pricing feature is activated.
The ranges of the discount prices for the indicated channel, when the Channel Pricing and Volume Discount features are activated.
The discount retail price of the offer.
Applicable only for Dropship offers.
The end date of the discount period for the retail price.
Applicable only for Dropship offers.
The start date of the discount period for the retail price.
Applicable only for Dropship offers.
The start date of the discount period.
For Dropship specifically: the start date of the discount period on the purchasing price
The start date of the discount period for the indicated channel, when the Channel Pricing feature is activated.
Can be empty. In this case, the discount price applies from the start date and is then always available for the indicated channel.
Amount of the eco-contribution for the EPR category. Returned if Data collection related to circular economy regulations is enabled.
The maximum order quantity customers must select to be able to place an order for that offer
The product measurement and the product unit
This option is only available if the operator creates a product with a measurement unit.
The minimum order quantity customers must select to be able to place an order for that offer
Shipping method with the minimum shipping charges (code referenced by the operator)
Shipping zone with the minimum shipping charges (code referenced by the operator)
The platform model of the seller account providing the offer.
Used for Hybrid platforms.
One of MARKETPLACE, DROPSHIP, ONE_CREDITOR
The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).
Applicable only for Dropship offers.
Ongoing discount campaigns the offer is currently participating in.
Not returned if the offer is not currently participating in any discount campaign or if Discount Campaign feature is disabled.
The original price of the offer
For Dropship specifically: the original purchasing price of the offer, also referred to as cost or wholesale price
The original price granted for an offer for the indicated channel
The original retail price of the offer, also referred to as original selling price.
Applicable only for Dropship offers.
For one order, customers can only add packages of product items.
The number of items per package is the increment number of that product in an order.
Offer current price (original price or discount price if in discount period) For Dropship specifically: the purchasing price of the offer (original price or discount price if in discount period), also referred to as cost or wholesale price
The price ranges for the indicated channel when the Channel Pricing and the Volume Pricing features are activated.
Can be empty when no specific price range is defined for a given channel.
The unit price of an offer for the indicated channel, when the Channel Pricing feature is activated.
Can be empty when no specific price is defined for a given channel. In this case, the base price of the offer applies to the indicated channel.
Producer identifier of the eco-contribution for the EPR category. Returned if Data collection related to circular economy regulations is enabled.
Offer current retail price (original retail price or discount retail price if in discount period). Also referred to as selling price.
Applicable only for Dropship offers.
Shipping charges type for the offer, for each combination of shipping zone and method.
Returned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.
Shipping charges for the offer, for each combination of shipping zone and method.
Returned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.
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];disc…