# Mirakl Marketplace APIs {% partial file="/partial-content/product/mmp/rest/seller/openapi-description.md" /%} ## Servers URL to be replaced by your Mirakl instance URL ``` https://your-instance.mirakl.net ``` ## Security ### shop_api_key Type: apiKey In: header Name: Authorization ## Download OpenAPI description [Mirakl Marketplace APIs](https://developer.mirakl.com/_bundle/content/product/mmp/rest/seller/openapi3.yaml) ## Stores ### A01 - Get shop information - [GET /api/account](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores/a01.md): Call Frequency Recommended usage: Once per day Maximum usage: Once per day ### A02 - Update shop information - [PUT /api/account](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores/a02.md): Description Depending on the operator's configuration, some fields might not be editable. Call Frequency Recommended usage: At each information update Maximum usage: Once per day ### A21 - Get shop statistics - [GET /api/account/statistics](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores/a21.md): Call Frequency Recommended usage: Once per day Maximum usage: Once per day ### S30 - List shop's documents - [GET /api/shops/documents](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores/s30.md): Description You must specify at least one of the following parameters: shop_ids, updated_since Call Frequency Recommended usage: At each display of a page that includes documents from a store (for example: during the KYC process) Maximum usage: At each display of a page that includes documents from a store (for example: during the KYC process) ### S32 - Upload business documents to associate with a shop - [POST /api/shops/documents](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores/s32.md): Description Document filenames must be distinct and there can be only one file per document type.Only documents of the following types are supported: csv, doc, docx, gif, html, jpeg, latex, mp4, odp, odc, odg, ods, odt, pdf, png, pps, ppsx, ppt, pptx, quicktime, rtf, text, tiff, xls, xlsx, xml, zipYou can upload a maximum of 50 business documents for each shop. These documents are not order related documents. Call Frequency Recommended usage: At each business document upload to a shop Maximum usage: 50 business documents per call ### S31 - Download documents for one or multiple shops - [GET /api/shops/documents/download](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores/s31.md): Description It is mandatory to specify either the shop_ids or the document_ids. If a list of document identifiers is specified only these documents are downloaded. If more than one document id is specified, the documents will be wrapped in a ZIP archive If only one document id is specified the document will not be zipped If no document identifiers is specified, all the shop documents will be downloaded. Use a list of shop document type codes to retrieve specific types from your shop. In this case, the output of the API will always be a ZIP archive even if there is only one document to retrieve. When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow: documents-timestamp.zip |__ shop_id/ | |__ image.png | |__ image(1).png | |__ foo.txt Returns a 404 if at least one document id or one document type code is invalid Call Frequency Recommended usage: After each S30 call, when you want to download documents from a store Maximum usage: After each S30 call, when you want to download documents from a store ### S33 - Delete a shop document - [DELETE /api/shops/documents/{document_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/stores/s33.md): Call Frequency Recommended usage: At each document deletion from one store Maximum usage: At each document deletion from one store ## Platform Settings ### AF01 - List all custom fields - [GET /api/additional_fields](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/af01.md): Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### CH11 - List all enabled channels - [GET /api/channels](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/ch11.md): Description Results are sorted by code Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### CUR01 - List currency codes and labels - [GET /api/currencies](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/cur01.md): Description List currency codes and labels activated on the platform Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### DO01 - List all document types - [GET /api/documents](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/do01.md): Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### L01 - List locale codes and labels - [GET /api/locales](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/l01.md): Description List locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system Call Frequency Recommended usage: Once per day Maximum usage: Once per day ### OF61 - List offer conditions - [GET /api/offers/states](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/of61.md): Description Sorted by sort index, set in the back-office Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### PC01 - List platform configurations - [GET /api/platform/configuration](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/pc01.md): Description List platform configurations such as general information, modules and features activated. Note: This configuration represents modules and major features enabled during platform setup. This differs from the PC02 API which export the platform business settings configurable by the operator in the back office. ### RE01 - List reasons - [GET /api/reasons](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/re01.md): Description This API returns cancellation, refund, incident, and message reasons.Reasons are sorted by type then sort index (set in the back-office) Call Frequency Recommended usage: Each time a page must display a list of reasons Maximum usage: Each time a page must display a list of reasons Read More More contextLocalization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### SH11 - List all active shipping zones - [GET /api/shipping/zones](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/sh11.md): Description Results are sorted by index, set in the back-office Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### SH12 - List all active shipping methods - [GET /api/shipping/types](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/sh12.md): Description Results are sorted by index, set in the back-office Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### SH21 - List all carriers - [GET /api/shipping/carriers](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/sh21.md): Description Results are sorted alphabetically by carrier label Call Frequency Recommended usage: Once per day Maximum usage: Once per day Read More More context ### SH31 - List all logistic classes - [GET /api/shipping/logistic_classes](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/sh31.md): Description Results are sorted by index, set in the back-office Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### SH42 - Get shop shipping configuration - [GET /api/shipping/configuration/shop](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/sh42.md): Call Frequency Recommended usage: Every week Maximum usage: Every hour ### SH52 - Get shipping charges configured for a shop account - [GET /api/shipping/charges/shop](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/sh52.md): Description Get shipping charges and their configuration Call Frequency Recommended usage: Every week Maximum usage: Every hour ### V01 - Health Check endpoint - [GET /api/version](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/v01.md): Description Use this endpoint to check that Mirakl Platform is up.You can ignore the response body that is subject to change, checking the response code is enough. ### RE02 - List reasons by type (deprecated) - [GET /api/reasons/{reason_type}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/re02.md): Deprecated endpoint This API is going to be removed in future update. Consider using RE01. Description This API returns cancellation, refund, incident, and message reasons.Reasons are sorted by sort index (set in the back-office) Call Frequency Recommended usage: Each time a page must display a list of reasons Maximum usage: Each time a page must display a list of reasons Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### RE11 - List of reasons with type: incident open (deprecated) - [GET /api/reasons/incident_open](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/re11.md): Deprecated endpoint This API is going to be removed in future update, use RE02 with parameter reason_type='INCIDENT_OPEN' Description Note: Result returns only reasons where the user's role have the right Note: Reasons are sorted by sort index, set in the back-office Call Frequency Recommended usage: Once on incident creation page view Maximum usage: Once on incident creation page view ### RE12 - List of reasons with type: incident close (deprecated) - [GET /api/reasons/incident_close](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/re12.md): Deprecated endpoint This API is going to be removed in future update, use RE02 with parameter reason_type='INCIDENT_CLOSE' Description Note: Result returns only reasons where the user's role have the right Note: Reasons are sorted by sort index, set in the back-office Call Frequency Recommended usage: Once on incident closing page view Maximum usage: Once on incident closing page view ### RE14 - List of reasons with type: messaging (deprecated) - [GET /api/reasons/messaging](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/platform-settings/re14.md): Deprecated endpoint This API is going to be removed in future update, use RE02 with parameter reason_type='MESSAGING' Description Note: Result returns only reasons where the user's role have the right Note: Reasons are sorted by sort index, set in the back-office Call Frequency Recommended usage: Once on message creation page view Maximum usage: Once on message creation page view ## Invoicing and Accounting ### DR11 - List accounting documents requests - [GET /api/document-request/requests](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/dr11.md): Pagination 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) ### DR12 - List lines of a document request - [GET /api/document-request/{document_request_id}/lines](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/dr12.md): Pagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:dateCreated - Sort by creation date (asc by default) ### DR73 - Download accounting documents - [GET /api/document-request/documents/download](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/dr73.md): Description At least one of the following filters must be applied: document_id or entity_idIf more than one document is requested, the output of the API will be a ZIP archive.The tree structure of this archive is as follows: documents-1624624030618.zip | |__ product-logistic-order/ | |__order1-A/| |__ INV203837.pdf | |__ INV203837.cxml | |__order1-B/| |__ INV203839.pdf ### DR74 - Upload accounting documents - [POST /api/document-request/documents/upload](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/dr74.md): Description Documents filenames must be distinct.If several formats are required for a document request, they must all be uploaded at once.A maximum of 50 documents can be uploaded simultaneously. ### IV01 - List accounting documents - [GET /api/invoices](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/iv01.md): Call Frequency Recommended usage: Once per day and as many times as there are invoice pages returned Maximum usage: Once per day and as many times as there are invoice pages returned Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date (asc by default) ### IV02 - Download an accounting document - [GET /api/invoices/{accounting_document_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/iv02.md): Call Frequency Recommended usage: At each invoice download Maximum usage: At each invoice download ### TL02 - List transaction lines - [GET /api/sellerpayment/transactions_logs](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/tl02.md): Description This resource uses seek pagination. The maximum allowed value for parameter limit is 2000. Call Frequency Recommended usage: 20 times per day Maximum usage: 20 times per min, 60 times per hour Pagination 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)lastUpdated - Sort by last updated date (Recommended) (desc by default) ### TL03 - Export transaction lines JSON file asynchronously - [POST /api/sellerpayment/transactions_logs/async](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/tl03.md): Description The export is asynchronous. Export status can be retrieved by calling TL04. Call Frequency Recommended usage: once per day Maximum usage: once per day ### TL04 - Poll the status of an asynchronous transaction log export (TL03) - [GET /api/sellerpayment/transactions_logs/async/status/{tracking_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/tl04.md): Description Retrieve the status for an TL03 transaction log 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 ### TL05 - Retrieve transaction logs files once asynchronous transaction logs export is complete (TL04) - [GET /dynamic-url/The+URL+is+retrieved+from+TL04+output/TL05](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/invoicing-and-accounting/tl05.md): Description Retrieve each chunk of an transaction logs export file via the URL generated once the asynchronous transaction logs export is complete ## Products ### H11 - List Catalog categories (parents and children) related to a Catalog category - [GET /api/hierarchies](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/h11.md): Call Frequency Recommended usage: Every hour Maximum usage: Every hour Read More More context ### P31 - Get products for a list of product references - [GET /api/products](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p31.md): Description Note: this resource returns 100 products maximum Results are sorted by product sku asc, then by product identifier type asc and then by product identifier asc Call Frequency Recommended usage: At each product page display Maximum usage: At each product page display Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### P41 - Import products to the operator information system - [POST /api/products/imports](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p41.md): Description Returns the import identifier to track the status of the import Call Frequency Recommended usage: Every hour, for each seller Maximum usage: Every 15 minutes, for each seller ### P51 - Get information about product import statuses - [GET /api/products/imports](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p51.md): Description If the last_request_date param is not set the api returns all product imports. Call Frequency Recommended usage: Every 5 minutes Maximum usage: Once per minute Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date (asc by default) ### P42 - Get the import status for a product import - [GET /api/products/imports/{import}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p42.md): Call Frequency Recommended usage: Once per minute until getting the import final status Maximum usage: Once per minute Read More More context ### P44 - Get the error report file for a product import ("Non-integrated products report") - [GET /api/products/imports/{import}/error_report](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p44.md): Description This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled). Call Frequency Recommended usage: Each time an error report is needed Maximum usage: Each time an error report is needed ### P45 - Get the product integration report file for a product import ("Added products report") - [GET /api/products/imports/{import}/new_product_report](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p45.md): Description This API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled). Call Frequency Recommended usage: Each time an integration report is needed Maximum usage: Each time an integration report is needed Read More More context ### P46 - Get the transformed file for a product import ("File in operator format") - [GET /api/products/imports/{import}/transformed_file](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p46.md): Description This API returns a CSV file. Call Frequency Recommended usage: Each time a transformed file is available Maximum usage: Each time a transformed file is available Read More More context ### P47 - Get the transformation error report file for a product import ("Source file error report") - [GET /api/products/imports/{import}/transformation_error_report](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/p47.md): Description This API returns a CSV, XLSX or XML file, depending on the file format provided by the seller. Call Frequency Recommended usage: Each time an error report is needed Maximum usage: Each time an error report is needed Read More More context ### PM11 - Get the product attribute configuration - [GET /api/products/attributes](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/pm11.md): Description Retrieves all attributes for parents and children of the requested hierarchy Call Frequency Recommended usage: Every hour Maximum usage: Every hour Read More More context ### VL11 - Get information about operator's value lists - [GET /api/values_lists](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/products/vl11.md): Call Frequency Recommended usage: Every hour Maximum usage: Every hour Read More More context ## Messages ### M10 - Retrieve a thread - [GET /api/inbox/threads/{thread_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/m10.md): Call Frequency Recommended usage: Synchronous only - At each page that includes a message thread display Maximum usage: Synchronous only - At each page that includes a message thread display ### M11 - List all threads - [GET /api/inbox/threads](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/m11.md): Description You may want to retrieve the threads linked to a specific entity, using both entity_type and entity_id. For example, to retrieve threads for an order, use entity_type=MMP_ORDER&entity_id=my-order-1. Available values for entity_type are: MMP_ORDER: for threads on product orders MMP_OFFER: for threads on offers MPS_ORDER: for threads on service orders MPS_SERVICE: for threads on services SELLER_OPERATOR: for threads between sellers and operator This resource uses seek pagination. The default value for parameter limit is 50. Call Frequency Recommended usage: Synchronous only - At each page that includes an inbox display Maximum usage: Synchronous only - At each page that includes an inbox display Pagination This resource supports seek pagination (see documentation) ### M14 - Create a thread with the operator - [POST /api/inbox/threads](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/m14.md): Description Create a thread with the operator and send a first message Call Frequency Recommended usage: Synchronous only - At each thread Maximum usage: Synchronous only - At each thread answer ### M12 - Reply to a thread - [POST /api/inbox/threads/{thread_id}/message](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/m12.md): Description Maximum of 1000 messages on a thread Call Frequency Recommended usage: Synchronous only - At each thread answer Maximum usage: Synchronous only - At each thread answer ### M13 - Download an attachment - [GET /api/inbox/threads/{attachment_id}/download](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/m13.md): Call Frequency Recommended usage: Synchronous only - At each message attachment download Maximum usage: Synchronous only - At each message attachment download ### OR43 - Create a thread on an order - [POST /api/orders/{order_id}/threads](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/or43.md): Description Each message has a 30 Megabyte size limit, regardless of the number of attachments in the message. Call Frequency Recommended usage: At each new thread posted on an order Maximum usage: At each new thread posted on an order ### M01 - List messages linked to orders and offers (deprecated) - [GET /api/messages](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/m01.md): Deprecated endpoint This API is going to be removed in a future update, please use M10 and M11 instead Description Returns messages received or sent to the shop. By default, returns only messages that are received by the shop. Call Frequency Recommended usage: Synchronous only - at each message list display Maximum usage: Synchronous only - at each message list display Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date (desc by default) ### OR42 - Post a message on an order (deprecated) - [POST /api/orders/{order_id}/messages](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/messages/or42.md): Deprecated endpoint This API will be removed in a future version. Use OR43 and M12 instead. Description Maximum of 1000 messages on a thread Call Frequency Recommended usage: At each new message posted on an order Maximum usage: At each new message posted on an order Read More More context ## 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 ## Orders ### OR04 - Patch update orders - [PUT /api/orders](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or04.md): Description Update orders information field by field: unspecified fields will not be updated. To remove the value for a field, send it with the 'null' value (not allowed for the required fields).You cannot use API OR04 to update customer-related information if the customer has been anonymized via API AN01.A maximum of 100 orders can be sent at once. Call Frequency Recommended usage: At each information update of one or multiple orders (for example: to modify the billing address) Maximum usage: Once per minute, 100 orders per call Read More More context ### OR11 - List orders with pagination - [GET /api/orders](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or11.md): Description Pagination is enabled by default. For large requests, use asynchronous order export APIs OR13, OR14 and OR15 instead. Call Frequency Recommended usage: - Asynchronous: every 5 minutes - Synchronous: at each order page display Maximum usage: - Asynchronous: once per minute - Synchronous: at each order page display Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date, and then by order identifier (asc by default) Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### OR07 - Update order line shipping origin - [PUT /api/orders/shipping_from](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or07.md): Description Update shipping origin (shipping_from) information on order lines. A maximum of 100 order lines can be sent at once. Call Frequency Recommended usage: At each update of shipping origin on one or multiple order lines Maximum usage: 60 per hour, 100 order lines per call ### OR13 - Export orders asynchronously - [POST /api/orders/async-export](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or13.md): Description The API returns a tracking id to be used to query API OR14.Mirakl recommends to use API OR13 instead of API OR11 as it can handle very large volumes of data.You must give at least one date range filter: created or last updated date.API OR13 supports the chunk of the export file into multiple files in order to:respect a maximum megabyte weight using the megabytes_per_chunk parameter.respect a maximum amount of exported items using the items_per_chunk parameter.Only one export request can be created for the same shop account. Call Frequency Recommended usage: - Differential: every 15 minutes Maximum usage: - Differential: every 5 minutes - Full: every 24 hours Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### OR14 - Get the status of an asynchronous order export. - [GET /api/orders/async-export/status/{tracking_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or14.md): Description Use this API to query the order export status after an API OR13 call.Until the export via API OR13 is complete, the status returned by API OR14 is PENDING.You must call API OR14 until you get the COMPLETED status which correspond to a completed and successful export from API OR13.The URLs in API OR14 response contain all the files from API OR13 export.Browse those urls and query them using the GET method.In case of error, the status is FAILED.In case of export canceled, the status is CANCELED. ### OR15 - Retrieve order export files once asynchronous export is complete (OR13). - [GET /dynamic-url/The+URL+is+retrieved+from+OR14+output/OR15](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or15.md): Description Retrieve each chunk of an order export file via the URL generated once the asynchronous export is complete. ### OR21 - Accept or refuse order lines - [PUT /api/orders/{order_id}/accept](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or21.md): Description Accept or refuse order lines in the WAITING_ACCEPTANCE status Call Frequency Recommended usage: At each new order on the Marketplace Maximum usage: At each new order on the Marketplace Read More More context ### OR23 - Update carrier tracking information for a specific order - [PUT /api/orders/{order_id}/tracking](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or23.md): Description If the carrier is not registered, the complete tracking url can be provided. Call Frequency Recommended usage: At each order tracking information update (as soon as the seller gets the tracking number from the carrier) Maximum usage: At each order tracking information update (as soon as the seller gets the tracking number from the carrier) ### OR24 - Validate the shipment of an order - [PUT /api/orders/{order_id}/ship](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or24.md): Description Validate the shipment of an order in the SHIPPING status Call Frequency Recommended usage: Each time the tracking number is entered (OR23) Maximum usage: Each time the tracking number is entered (OR23) ### OR28 - Perform refunds on order lines - [PUT /api/orders/refund](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or28.md): Call Frequency Recommended usage: At each refund request Maximum usage: At each refund request ### OR29 - Perform a full cancelation of an order - [PUT /api/orders/{order_id}/cancel](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or29.md): Call Frequency Recommended usage: At each order cancelation Maximum usage: At each order cancelation ### OR30 - Perform cancelations on order lines - [PUT /api/orders/cancel](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or30.md): Call Frequency Recommended usage: At each order (or order line) cancelation Maximum usage: At each order (or order line) cancelation ### OR31 - Update the custom fields of an order and its order lines - [PUT /api/orders/{order_id}/additional_fields](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or31.md): Description Only specified custom field values will be updated.In order to delete an custom field's value, set it to null or an empty string. Note that you may not delete the value of a required custom field value.Output will return information on the status of the update attempt by giving: either all of the order and its order lines custom field values after the update or in case of errors, the list of errors and the body of the initial call Call Frequency Recommended usage: Each time a custom field is updated on an order or on an order line Maximum usage: 5 calls per second ### OR32 - Adjust order line - [PUT /api/orders/adjust](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or32.md): Description Update order line actual measurement either upwards or downwards, within the limit defined at the platform level. Call Frequency Recommended usage: At each adjustment of one or multiple order lines Maximum usage: Once per minute, 100 order lines per call ### OR51 - Get the evaluation of an order - [GET /api/orders/{order_id}/evaluation](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or51.md): Call Frequency Recommended usage: On each evaluation page view Maximum usage: On each evaluation page view Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### OR72 - Lists order's documents - [GET /api/orders/documents](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or72.md): Description Returns a list of all the documents available on the order Call Frequency Recommended usage: At each document list page display Maximum usage: At each document list page display ### OR73 - Download one or multiple documents attached to one or multiple orders - [GET /api/orders/documents/download](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or73.md): Description If a list of document identifiers is specified only these documents are downloaded. If more than one document id is specified, the documents will be wrapped in a ZIP archive If only one document id is specified the document will not be zipped If a list of order identifiers is specified, all documents from those orders are downloaded. Use a list of order document type codes to retrieve specific types from those orders. In this case, the output of the API will always be a ZIP archive even if there is only one document to retrieve. When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow: documents-timestamp.zip | |__ order_id_x/ | |__ foo.txt | |__ bar.txt | |__ baz.pdf | |__ order_id_y/ | |__ image.png | |__ image(1).png Call Frequency Recommended usage: At each document download Maximum usage: At each document download ### OR74 - Upload documents to attach to an order - [POST /api/orders/{order_id}/documents](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or74.md): Description Documents filenames must be distinct. Only documents of the following types are supported: csv, doc, xls, xlsx, ppt, pdf, odt, ods, odp, txt, rtf, png, jpg, gif, zpl, mov, mp4. An order can have a maximum of 50 documents. In the API output we include only documents with errors. All other documents are successfully uploaded. For system document types, there are specific restrictions : SYSTEM_DELIVERY_BILL/SYSTEM_SHIPMENT_DELIVERY_BILL : restricted to operator role. SYSTEM_MESSAGE_ATTACHMENT : cannot be directly uploaded to an order. Call Frequency Recommended usage: At each document upload on an order Maximum usage: At each document upload on an order ### OR75 - List all the order taxes available on the platform - [GET /api/orders/taxes](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or75.md): Call Frequency Recommended usage: Once per day Maximum usage: Once per day Localization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### OR76 - Delete an order document - [DELETE /api/orders/documents/{document_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or76.md): Call Frequency Recommended usage: At each order document deletion Maximum usage: At each order document deletion ### OR12 - Get information about an order (deprecated) - [GET /api/orders/{order_id}](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or12.md): Deprecated endpoint This API is going to be removed in a future update, please use OR11 with the query parameter 'order_ids' instead. Call Frequency Recommended usage: On each order page view Maximum usage: On each order page view ### OR26 - Perform a refund of order lines of an order (deprecated) - [PUT /api/orders/{order_id}/refund](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or26.md): Deprecated endpoint This API is going to be removed in a future update, please use OR28 instead. Call Frequency Recommended usage: On each new refund demand Maximum usage: On each new refund demand ### OR41 - List messages of an order (deprecated) - [GET /api/orders/{order_id}/messages](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/orders/or41.md): Deprecated endpoint This API is going to be removed in a future update, please use M10 and M11 instead Description By default, all sent, received and unarchived message are listed Call Frequency Recommended usage: On each message page view Maximum usage: On each message page view Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date (desc by default) ## Incidents ### OR64 - Mark an incident as resolved - [PUT /api/orders/{order_id}/lines/{line}/resolve_incident](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/incidents/or64.md): Call Frequency Recommended usage: At each incident resolution on an order line Maximum usage: At each incident resolution on an order line Read More More context ## Picklists ### PL11 - List picklists - [GET /api/picklists](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/picklists/pl11.md): Call Frequency Recommended usage: Every 15 minutes Maximum usage: Every 5 minutes Pagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:pickupDate (Default) - Sort by pickup date (asc by default) ## Promotions ### PR01 - List promotions - [GET /api/promotions](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/promotions/pr01.md): Call Frequency Recommended usage: At each display of a promotions list page or on-promo offer detail page. Maximum usage: At each display of a promotions list page or on-promo offer detail page. Pagination This resource supports offset pagination (see documentation) Sort fields sort field can have the following values:startDate (Default) - Sort by promotion activity start date (Newest first) (desc by default)endDate - Sort by promotion activity end date (Newest first) (desc by default)dateCreated - Sort by promotion creation date (Newest first) (desc by default) ## Users ### RO02 - List shop roles - [GET /api/users/shops/roles](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/users/ro02.md): Call Frequency Recommended usage: On each user role view Maximum usage: On each user role view Read More More context ## Returns ### RT04 - Patch update returns - [PUT /api/returns](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt04.md) ### RT11 - List returns - [GET /api/returns](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt11.md): Call Frequency Recommended usage: Every 15 minutes Maximum usage: Every 5 minutes Pagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:date_created (Default) - Sort by return date creation (asc by default) ### RT21 - Accept or refuse a return request - [PUT /api/returns/accept](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt21.md): Description Limited to 100 returns at a time Read More More context ### RT25 - Validate returns as received - [PUT /api/returns/receive](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt25.md): Description Limited to 100 returns at a time ### RT26 - Mark a return as compliant or non compliant - [PUT /api/returns/compliance](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt26.md): Description Limited to 100 returns at a time ### RT27 - Mark a return as closed - [PUT /api/returns/close](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt27.md): Description Limited to 100 returns at a time ### RT29 - Mark a return as canceled - [PUT /api/returns/cancel](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/returns/rt29.md): Description Limited to 100 returns at a time ## Multiple shipments ### ST01 - Create shipments - [POST /api/shipments](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st01.md): Description Limited to 1000 shipments at a time Call Frequency Recommended usage: On each new shipment Maximum usage: On each new shipment ### ST07 - Update shipment shipping origin - [PUT /api/shipments](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st07.md): Description Limited to 100 shipments at a time Call Frequency Recommended usage: At each update of shipments for one or multiple shipment ### ST11 - List shipments - [GET /api/shipments](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st11.md): Call Frequency Recommended usage: at each shipment page display Maximum usage: at each shipment page display Pagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:dateCreated (Default) - Sort by creation date (asc by default) ### ST06 - Delete shipments - [PUT /api/shipments/delete](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st06.md): Description Limited to 1000 shipments at a time Call Frequency Recommended usage: On each shipment deletion Maximum usage: On each shipment deletion ### ST12 - List items to ship - [GET /api/shipments/items_to_ship](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st12.md): Call Frequency Recommended usage: Every 15 minutes Maximum usage: Every 5 minutes Pagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:shippingDate (Default) - Sort by shipping date (asc by default) ### ST23 - Update carrier tracking information for shipments - [POST /api/shipments/tracking](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st23.md): Description If the carrier is not registered, the complete tracking url can be provided. Limited to 1000 shipments at a time. Call Frequency Recommended usage: On each shipment tracking info update Maximum usage: On each shipment tracking info update ### ST24 - Validate shipments as shipped - [PUT /api/shipments/ship](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st24.md): Description Limited to 1000 shipments at a time Call Frequency Recommended usage: On each shipment shipping Maximum usage: On each shipment shipping ### ST26 - Validate shipments as ready to pick up - [PUT /api/shipments/ready_for_pick_up](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st26.md): Description Limited to 1000 shipments at a time Call Frequency Recommended usage: On each shipment ready to pick up Maximum usage: On each shipment ready to pick up ### ST31 - Update shipment additional information - [PUT /api/shipments/additional_information](https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3/multiple-shipments/st31.md): Description Limited to 100 shipments at a time Call Frequency Recommended usage: At each update of shipments for one or multiple shipments