# Offers ## OF01 - Import a file to create, update or delete offers - [POST /api/offers/imports](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of01.md): Description Returns the import identifier to track the status of the import. Call Frequency Recommended usage: Every 5 minutes Maximum usage: Once per minute Read More More context ## OF04 - Get information and statistics about offer imports - [GET /api/offers/imports](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of04.md): Call Frequency Recommended usage: Every 5 minutes Maximum usage: Once per minute Read More More contextPagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date (desc by default) ## OF02 - Get information and statistics about an offer import - [GET /api/offers/imports/{import}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of02.md): Call Frequency Recommended usage: After each OF01 call, every 5 minutes Maximum usage: Once per minute Read More More context ## OF03 - Get the error report file for an offer import - [GET /api/offers/imports/{import}/error_report](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of03.md): Description This API returns a CSV, XLSX or XML file, depending on the file format provided by the seller. Call Frequency Recommended usage: After each OF02 call, every 5 minutes Maximum usage: Once per minute Read More More context ## OF21 - List offers of a shop - [GET /api/offers](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of21.md): Call Frequency Recommended usage: On each shop's offers page view Maximum usage: On each shop's offers page view Read More If the "Price approval" option is activated, read this pagePrice prioritization for Advanced PricingPagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:totalPrice (Default) - Sort by total price (asc by default)price - Sort by price, total price (asc by default)productTitle - Sort by product title, total price (asc by default) Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ## OF24 - Create, update, or delete offers - [POST /api/offers](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of24.md): Description Returns the import identifier to track the status of the update.You must send all offer fields. Offer fields that are not sent are reset to their default value. Call Frequency Recommended usage: Every 5 minutes Maximum usage: Once per minute ## OF22 - Get information about an offer - [GET /api/offers/{offer}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of22.md): Call Frequency Recommended usage: At each offer page display Maximum usage: At each offer page display Read More If the "Price approval" option is activated, read this pagePrice prioritization for Advanced PricingLocalization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ## OF52 - Export offers CSV or JSON file asynchronously - [POST /api/offers/export/async](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of52.md): Description Export status and files links can be retrieved by calling OF53.Get a CSV or JSON file that includes the offers updated and deleted since the last request date. To ease testing processes, the minimum values for "megabytes_per_chunk" and "items_per_chunk" have been lowered on TEST and DEV environments. Please adapt these values on PROD environments. Call Frequency Recommended usage: - Differential: every 5 minutes - Full: once per day Maximum usage: - Differential: once per minute - Full: once per day ## OF53 - Poll the status of an asynchronous offer export (OF52) - [GET /api/offers/export/async/status/{tracking_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of53.md): Description Retrieve the status for an OF52 offer export. When the export is complete, the URLs to retrieve the files are returned. Call Frequency Recommended usage: Once per minute until you get an error or a success Maximum usage: Every 10 seconds ## OF54 - Retrieve offer files once asynchronous offer export is complete (OF52) - [GET /dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of54.md): Description Retrieve each chunk of an offer export file via the URL generated once the asynchronous offer export is complete ## P11 - List offers for each given product - [GET /api/products/offers](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/p11.md): Call Frequency Recommended usage: At each product page display Maximum usage: At each product page display Read More If the "Price approval" option is activated, read this pagePrice prioritization for Advanced PricingAdvanced Pricing in P11Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:bestPrice (Default) - Sorts by product sku and then by total price, premium information, shop grade (asc by default)bestEvaluation - Sorts by product sku and then by shop grade, total price, premium information (asc by default) Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ## PRI01 - Import a price file - [POST /api/offers/pricing/imports](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/pri01.md): Description Import a .csv file to submit all applicable prices for an offer. The import mode is delete and replace: any existing price that is not submitted will be deleted. If Price Approval is enabled, this API creates and updates pending prices; ongoing prices will remain. Returns an import identifier to track the status of the import and retrieve an error report if applicable. Call Frequency Recommended usage: Every 5 minutes Maximum usage: Once per minute Read More Importing pricesAbout the price file format ## PRI02 - Get information and statistics about an offer pricing import - [GET /api/offers/pricing/imports](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/pri02.md): Call Frequency Recommended usage: After each PRI01 call, every 5 minutes Maximum usage: Once per minute Read More Importing pricesPagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date (desc by default) ## PRI03 - Get the error report for a price import in CSV format - [GET /api/offers/pricing/imports/{import_id}/error_report](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/pri03.md): Description Only returns lines of offers with at least one offer price in error. The first column contains the line number in error. The second column contains the error reason. The returned file is ready to be reimported after the values have been fixed. Offer prices that were submitted in the price import but don't appear in the error report were successfully imported. Call Frequency Recommended usage: After each PRI02 call, every 5 minutes Maximum usage: Once per minute Read More Importing prices ## STO01 - Import a stock file - [POST /api/offers/stock/imports](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/sto01.md): Description Import a .csv file to update stock for offers, either globally or per warehouse. Returns an import identifier to track the status of the import and retrieve an error report if applicable. Call Frequency Recommended usage: Every 5 minutes when stock needs updating Maximum usage: Once per minute Read More More contextAbout the stock import file format ## STO02 - Get information and statistics about an offer stock import - [GET /api/offers/stock/imports/{import_id}/status](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/sto02.md): Call Frequency Recommended usage: After each STO01 call, every 5 minutes Maximum usage: Once every 15 seconds Read More More context ## STO03 - Get the error report for a stock import in CSV format - [GET /api/offers/stock/imports/{import_id}/error_report](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/sto03.md): Description Only returns lines of offers with at least one offer price in error. The first column contains the line number in error. The second column contains the error reason. The returned file is ready to be reimported after the values have been fixed. Offer prices that were submitted in the price import but don't appear in the error report were successfully imported. Call Frequency Recommended usage: After each STO02 call, every 5 minutes Maximum usage: Once per minute Read More More context ## OF26 - Get the quantity of stock available for an offer. (deprecated) - [GET /api/offers/{offer}/quantity](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of26.md): Description Quantity return rules: 0: if quantity = 0 or the offer is not available x: quantity available ## OF51 - Get offers CSV file (deprecated) - [GET /api/offers/export](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/offers/of51.md): Deprecated endpoint This API is going to be removed in a future update, please use APIs OF52, OF53, and OF54 instead. Description 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. Call Frequency Recommended usage: - Differential: every 5 minutes - Full: once per day Maximum usage: - Differential: once per minute - Full: once per day