# Mirakl Marketplace APIs

{% partial file="/partial-content/product/mmp/rest/operator/openapi-description.md" /%}


## Servers

URL to be replaced by your Mirakl instance URL
```
https://your-instance.mirakl.net
```

## Security

### OAuth-2

[object Object]

Type: oauth2
Authorization URL: https://auth.mirakl.net/authorize
Token URL: https://auth.mirakl.net/oauth/token
Scopes:

### Operator-Bearer-Token

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

 - [Mirakl Marketplace APIs](https://developer.mirakl.com/_bundle/content/product/mmp/rest/operator/openapi3.yaml)

## Platform Settings

 - [GET /api/additional_fields](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/af01.md): Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayRead MoreMore contextLocalizationThis resource supports locale parameter (see documentation)Localized output fields will be high
 - [GET /api/channels](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/ch11.md): DescriptionResults are sorted by code Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis resource supports locale parameter (see documentation)Localized output fi
 - [GET /api/currencies](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/cur01.md): DescriptionList currency codes and labels activated on the platform Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis resource supports locale parameter (see doc
 - [GET /api/documents](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/do01.md): Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayRead MoreMore contextLocalizationThis resource supports locale parameter (see documentation)Localized output fields will be high
 - [GET /api/locales](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/l01.md): DescriptionList locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM system Call FrequencyRecommended usage: Once per dayMaximum usage: Onc
 - [GET /api/offers/states](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/of61.md): DescriptionSorted by sort index, set in the back-office Call FrequencyRecommended usage: Once per dayMaximum usage: 20 per dayLocalizationThis resource supports locale parameter (see documentation)Loc
 - [GET /api/platform/configuration](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/pc01.md): DescriptionList platform configurations such as general information, modules and features activated. Note: This configuration represents modules and major features enabled during platform setup. This
 - [GET /api/reasons](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/re01.md): DescriptionThis API returns cancellation, refund, incident, and message reasons.Reasons are sorted by type then sort index (set in the back-office) Call FrequencyRecommended usage: Each time a page mu
 - [GET /api/shipping/zones](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/sh11.md): DescriptionResults are sorted by index, set in the back-office Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis resource supports locale parameter (see document
 - [GET /api/shipping/types](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/sh12.md): DescriptionResults are sorted by index, set in the back-office Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis resource supports locale parameter (see document
 - [GET /api/shipping/carriers](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/sh21.md): DescriptionResults are sorted alphabetically by carrier label Call FrequencyRecommended usage: Once per dayMaximum usage: Once per day
 - [GET /api/shipping/logistic_classes](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/sh31.md): DescriptionResults are sorted by index, set in the back-office Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis resource supports locale parameter (see document
 - [GET /api/reasons/{reason_type}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/re02.md): Deprecated endpointThis API is going to be removed in future update. Consider using RE01. DescriptionThis API returns cancellation, refund, incident, and message reasons.Reasons are sorted by sort ind
 - [GET /api/reasons/incident_open](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/re11.md): Deprecated endpointThis API is going to be removed in future update, use RE02 with parameter reason_type='INCIDENT_OPEN' DescriptionNote: Result returns only reasons where the user's role have the rig
 - [GET /api/reasons/incident_close](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/re12.md): Deprecated endpointThis API is going to be removed in future update, use RE02 with parameter reason_type='INCIDENT_CLOSE' DescriptionNote: Result returns only reasons where the user's role have the ri
 - [GET /api/reasons/messaging](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/platform-settings/re14.md): Deprecated endpointThis API is going to be removed in future update, use RE02 with parameter reason_type='MESSAGING' DescriptionNote: Result returns only reasons where the user's role have the right N
## Customers

## Products

 - [GET /api/hierarchies](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/h11.md): Call FrequencyRecommended usage: Every hourMaximum usage: Every hour
 - [GET /api/products](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p31.md): DescriptionNote: 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 FrequencyRecommended usa
 - [POST /api/products/imports](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p41.md): DescriptionReturns the import identifier to track the status of the import Call FrequencyRecommended usage: Every hour, for each sellerMaximum usage: Every 15 minutes, for each sellerRead MoreMore con
 - [GET /api/products/imports](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p51.md): DescriptionIf the last_request_date param is not set the api returns all product imports. Call FrequencyRecommended usage: Every 5 minutesMaximum usage: Once per minuteRead MoreMore contextPaginationT
 - [GET /api/products/imports/{import}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p42.md): Call FrequencyRecommended usage: Once per minute until getting the import final statusMaximum usage: Once per minute
 - [GET /api/products/imports/{import}/error_report](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p44.md): DescriptionThis API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled). Call FrequencyRecommended usage: Each time an error report is neededMaximum us
 - [GET /api/products/imports/{import}/new_product_report](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p45.md): DescriptionThis API returns either a CSV file (MCM enabled) or a file in a format defined by the operator (MCM disabled). Call FrequencyRecommended usage: Each time an integration report is neededMaxi
 - [GET /api/products/imports/{import}/transformed_file](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p46.md): DescriptionThis API returns a CSV file. Call FrequencyRecommended usage: Each time a transformed file is availableMaximum usage: Each time a transformed file is available
 - [GET /api/products/imports/{import}/transformation_error_report](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/p47.md): DescriptionThis API returns a CSV, XLSX or XML file, depending on the file format provided by the seller. Call FrequencyRecommended usage: Each time an error report is neededMaximum usage: Each time a
 - [GET /api/products/attributes](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/pm11.md): DescriptionRetrieves all attributes for parents and children of the requested hierarchy Call FrequencyRecommended usage: Every hourMaximum usage: Every hour
 - [GET /api/values_lists](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/products/vl11.md): Call FrequencyRecommended usage: Every hourMaximum usage: Every hour
## Commissions

## Invoicing and Accounting

 - [GET /api/document-request/requests](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/dr11.md): PaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have the following values:dateCreated (Default) - Sort by creation date (desc by default)
 - [GET /api/document-request/{document_request_id}/lines](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/dr12.md): PaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have the following values:dateCreated - Sort by creation date (asc by default)
 - [GET /api/document-request/documents/download](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/dr73.md): DescriptionAt least one of the following filters must be applied: `document_id` or `entity_id` If more than one document is requested, the output of the API will be a ZIP archive. The tree structure o
 - [POST /api/document-request/documents/upload](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/dr74.md): DescriptionDocuments 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.*
 - [POST /api/document-request/documents/confirm-issuance](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/dr75.md): DescriptionFor fees documents (`FEES`, `ONE_OFF_FEES`) issued externally, confirms the issuance details without uploading a document. **A maximum of 100 requests can be confirmed simultaneously.**
 - [GET /api/invoices](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/iv01.md): Description⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, IV01 will contain no new data. Use the SBC11 and DR11 APIs instead. Call FrequencyRecommended usage: Once per day and as many
 - [GET /api/invoices/{accounting_document_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/iv02.md): Description⚠️ Note: When the Enhanced Seller Invoicing toggle is enabled, the DR73 API should be used. Only documents created prior to the toggle activation remain downloadable via this API. Call Freq
 - [GET /api/seller-billing-cycles](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/invoicing-and-accounting/sbc11.md): DescriptionThis resource uses seek pagination. The maximum allowed value for parameter limit is 1000. Call FrequencyRecommended usage: Once per day and as many times as there are billing cycle pages r
## Messages

 - [GET /api/inbox/threads/{thread_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/m10.md): Call FrequencyRecommended usage: Synchronous only - At each page that includes a message thread displayMaximum usage: Synchronous only - At each page that includes a message thread displayRead MoreMor
 - [GET /api/inbox/threads](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/m11.md): DescriptionYou 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
 - [POST /api/inbox/threads](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/m14.md): DescriptionCreate a thread with a seller and send a first message Call FrequencyRecommended usage: Synchronous only - At each threadMaximum usage: Synchronous only - At each thread answerRead MoreMore
 - [POST /api/inbox/threads/{thread_id}/message](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/m12.md): DescriptionMaximum of 1000 messages on a thread Call FrequencyRecommended usage: Synchronous only - At each thread answerMaximum usage: Synchronous only - At each thread answerRead MoreMore context (P
 - [GET /api/inbox/threads/{attachment_id}/download](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/m13.md): Call FrequencyRecommended usage: Synchronous only - At each message attachment downloadMaximum usage: Synchronous only - At each message attachment downloadRead MoreMore context (Products Marketplace)
 - [POST /api/orders/{order_id}/threads](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/or43.md): DescriptionEach message has a 30 Megabyte size limit, regardless of the number of attachments in the message.Call FrequencyRecommended usage: At each new thread posted on an orderMaximum usage: At eac
 - [GET /api/messages](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/m01.md): Deprecated endpointThis API is going to be permanently removed **on April 5 2027**, please use M10 and M11 instead. DescriptionReturns messages received or sent to the operator. By default, returns on
 - [POST /api/orders/{order_id}/messages](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/messages/or42.md): Deprecated endpointThis API will be removed in a future version. Use OR43 and M12 instead. DescriptionMaximum of 1000 messages on a thread Call FrequencyRecommended usage: At each new message posted o
## Offers

 - [POST /api/offers/imports](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of01.md): DescriptionReturns the import identifier to track the status of the import. Call FrequencyRecommended usage: Every 5 minutes with offers only, every hour with offers and products, for each sellerMaxim
 - [GET /api/offers/imports](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of04.md): Call FrequencyRecommended usage: Every 5 minutesMaximum usage: Once per minutePaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have the following values:da
 - [GET /api/offers/imports/{import}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of02.md): Call FrequencyRecommended usage: After each OF01 call, every 5 minutesMaximum usage: Once per minute
 - [GET /api/offers/imports/{import}/error_report](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of03.md): DescriptionThis API returns a CSV, XLSX or XML file, depending on the file format provided by the seller. Call FrequencyRecommended usage: After each OF02 call, every 5 minutesMaximum usage: Once per
 - [GET /api/offers/{offer}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of22.md): Call FrequencyRecommended usage: At each offer page displayMaximum usage: At each offer page displayRead MoreIf the "Price approval" option is activated, read this pagePrice prioritization for Advance
 - [POST /api/offers](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of24.md): DescriptionReturns 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 FrequencyRecommended usa
 - [POST /api/offers/export/async](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of52.md): DescriptionExport 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, t
 - [GET /api/offers/export/async/status/{tracking_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of53.md): DescriptionRetrieve the status for an OF52 offer export. When the export is complete, the URLs to retrieve the files are returned. Call FrequencyRecommended usage: Once per minute until you get an err
 - [GET /dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of54.md): DescriptionRetrieve each chunk of an offer export file via the URL generated once the asynchronous offer export is complete Read MoreExporting offers with advanced pricesExporting offers asynchronousl
 - [GET /api/products/offers](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/p11.md): DescriptionList offers for each given product By default, users calling this API with a Seller API key can retrieve both their own offers and some of their competitors’ data. If you want to prevent t
 - [POST /api/offers/pricing/imports](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/pri01.md): DescriptionImport 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 enable
 - [GET /api/offers/pricing/imports](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/pri02.md): Call FrequencyRecommended usage: After each PRI01 call, every 5 minutesMaximum usage: Once per minuteRead MoreImporting pricesPaginationThis resource supports seek pagination (see documentation)Sort f
 - [GET /api/offers/pricing/imports/{import_id}/error_report](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/pri03.md): DescriptionOnly 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 re
 - [POST /api/offers/stock/imports](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/sto01.md): DescriptionImport 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. C
 - [GET /api/offers/stock/imports/{import_id}/status](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/sto02.md): Call FrequencyRecommended usage: After each STO01 call, every 5 minutesMaximum usage: Once every 15 secondsRead MoreMore context
 - [GET /api/offers/stock/imports/{import_id}/error_report](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/sto03.md): DescriptionOnly returns the lines 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 value
 - [GET /api/offers/{offer}/quantity](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of26.md): DescriptionQuantity return rules: 0: if quantity = 0 or the offer is not available x: quantity available
 - [GET /api/offers/export](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/offers/of51.md): Deprecated endpointThis API is going to be removed in a future update, please use APIs OF52, OF53, and OF54 instead. DescriptionGet a CSV file that includes the offers updated and deleted since the la
## Orders

 - [PUT /api/orders](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or04.md): DescriptionUpdate 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 ca
 - [GET /api/orders](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or11.md): DescriptionReturns a 400 Bad Request response if the limit of commercialIds, customerIds, offerIds or productSkus is exceeded.Pagination is enabled by default. For large requests, use asynchronous ord
 - [GET /api/orders/taxes](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or75.md): Call FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon:
 - [PUT /api/orders/shipping_from](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or07.md): DescriptionUpdate shipping origin (shipping_from) information on order lines.A maximum of 100 order lines can be sent at once.Call FrequencyRecommended usage: At each update of shipping origin on one
 - [POST /api/orders/async-export](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or13.md): DescriptionThe 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
 - [GET /api/orders/async-export/status/{tracking_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or14.md): DescriptionUse 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 g
 - [GET /dynamic-url/The+URL+is+retrieved+from+OR14+output/OR15](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or15.md): DescriptionRetrieve each chunk of an order export file via the URL generated once the asynchronous export is complete. Call FrequencyRecommended usage: Once per file URL returned by OR14, after COMPLE
 - [PUT /api/orders/{order_id}/accept](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or21.md): DescriptionAccept or refuse order lines in the WAITING_ACCEPTANCE status Error Codes| Code | Description | | --- | --- | | ORDER_FULFILLED_UNAUTHORIZED | An unauthorized action has been requested on
 - [PUT /api/orders/{order_id}/tracking](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or23.md): DescriptionIf the carrier is not registered, the complete tracking url can be provided. Call FrequencyRecommended usage: At each order tracking information update (as soon as the seller gets the track
 - [PUT /api/orders/{order_id}/ship](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or24.md): > ⚠️ **Content-length header** The Content-Length header must be present with value 0, even when there is no request body. DescriptionValidate the shipment of an order in the SHIPPING status Call Fre
 - [PUT /api/orders/refund](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or28.md): Call FrequencyRecommended usage: At each refund requestMaximum usage: At each refund request
 - [PUT /api/orders/{order_id}/cancel](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or29.md): > ⚠️ **Content-length header** The Content-Length header must be present with value 0, even when there is no request body. Descriptionfor PAY_ON_DELIVERY, PAY_ON_DUE_DATE or PAY_ON_SHIPMENT workflow
 - [PUT /api/orders/cancel](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or30.md): DescriptionIf the Shop partial cancelation feature is enabled by Mirakl Support Team: for PAY_ON_DELIVERY, PAY_ON_DUE_DATE or PAY_ON_SHIPMENT workflows: shop can only cancel a non-debited order.
 - [PUT /api/orders/{order_id}/additional_fields](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or31.md): DescriptionOnly 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
 - [PUT /api/orders/adjust](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or32.md): DescriptionUpdate order line actual measurement either upwards or downwards, within the limit defined at the platform level.Error Codes| Code | Description | | --- | --- | | ORDER_ADJUSTMENT_FEATURE_
 - [PUT /api/orders/{order_id}/cancel-order-lines](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or33.md): DescriptionIf the Shop partial cancelation feature is enabled by Mirakl Support Team: for PAY_ON_DELIVERY, PAY_ON_DUE_DATE or PAY_ON_SHIPMENT workflows: shop can only cancel a non-debited order.
 - [GET /api/orders/{order_id}/evaluation](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or51.md): Call FrequencyRecommended usage: On each evaluation page viewMaximum usage: On each evaluation page viewRead MoreMore contextLocalizationThis resource supports locale parameter (see documentation)Loca
 - [GET /api/orders/documents](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or72.md): DescriptionReturns a list of all the documents available on the order Call FrequencyRecommended usage: At each document list page displayMaximum usage: At each document list page displayRead MoreMore
 - [GET /api/orders/documents/download](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or73.md): DescriptionIf 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 archiveIf only on
 - [POST /api/orders/{order_id}/documents](https://developer.mirakl.com/content/product/mmp/rest/operator/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
 - [DELETE /api/orders/documents/{document_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or76.md): Call FrequencyRecommended usage: At each order document deletionMaximum usage: At each order document deletionRead MoreMore context
 - [GET /api/orders/{order_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or12.md): Deprecated endpointThis API is going to be removed in a future update, please use OR11 with the query parameter 'order_ids' instead. Call FrequencyRecommended usage: On each order page viewMaximum usa
 - [PUT /api/orders/{order_id}/refund](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or26.md): Deprecated endpointThis API is going to be removed in a future update, please use OR28 instead. Call FrequencyRecommended usage: On each new refund demandMaximum usage: On each new refund demand
 - [GET /api/orders/{order_id}/messages](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/orders/or41.md): Deprecated endpointThis API is going to be permanently removed **on April 5 2027**, please use M10 and M11 instead. DescriptionBy default, all sent and received messages are listed Call FrequencyRecom
## Incidents

## Payment

## Picklists

 - [GET /api/picklists](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/picklists/pl11.md): Call FrequencyRecommended usage: Every 15 minutesMaximum usage: Every 5 minutesRead MoreMore contextPaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have t
## Promotions

 - [GET /api/promotions](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/promotions/pr01.md): Call FrequencyRecommended 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.Read Mor
 - [POST /api/promotions](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/promotions/pr03.md): Call FrequencyMaximum usage: Once per minuteRead MoreMore context
 - [PUT /api/promotions/{promotion_internal_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/promotions/pr04.md): Call FrequencyMaximum usage: Once per minuteRead MoreMore context
## Users

 - [GET /api/users/shops/roles](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/users/ro02.md): Call FrequencyRecommended usage: On each user role viewMaximum usage: On each user role viewRead MoreMore context
## Returns

 - [POST /api/returns](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt01.md): DescriptionLimited to 200 returns at a time Call FrequencyRecommended usage: At each customer return requestMaximum usage: At each customer return requestRead MoreMore context
 - [PUT /api/returns](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt04.md): Call FrequencyRecommended usage: At each update of one or multiple returnsMaximum usage: At each update of one or multiple returnsRead MoreMore context
 - [GET /api/returns](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt11.md): Call FrequencyRecommended usage: Every 15 minutesMaximum usage: Every 5 minutesRead MoreMore contextPaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have t
 - [GET /api/returns/items_to_return](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt12.md): Call FrequencyRecommended usage: At each customer return requestMaximum usage: At each customer return requestRead MoreMore contextPaginationThis resource supports seek pagination (see documentation)S
 - [PUT /api/returns/accept](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt21.md): DescriptionLimited to 100 returns at a time Call FrequencyRecommended usage: At each acceptance or refusal decision for one or multiple returnsMaximum usage: At each acceptance or refusal decision for
 - [PUT /api/returns/receive](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt25.md): DescriptionLimited to 100 returns at a time Error Codes| Code | Description | | --- | --- | | RETURN_DUPLICATE_ID | The returns list contains duplicate return IDs | | RETURN_HANDLED_BY_OPERATOR | Thi
 - [PUT /api/returns/compliance](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt26.md): DescriptionLimited to 100 returns at a time Call FrequencyRecommended usage: At each compliance decision for one or multiple returnsMaximum usage: At each compliance decision for one or multiple retur
 - [PUT /api/returns/close](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt27.md): DescriptionLimited to 100 returns at a time Error Codes| Code | Description | | --- | --- | | RETURN_DUPLICATE_ID | The returns list contains duplicate return IDs | | RETURN_HANDLED_BY_OPERATOR | Thi
 - [PUT /api/returns/cancel](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt29.md): DescriptionLimited to 100 returns at a time Call FrequencyRecommended usage: At each cancellation of one or multiple returnsMaximum usage: At each cancellation of one or multiple returns
 - [POST /api/returns/return-labels](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt51.md): DescriptionGenerate return labels for a given list of return IDs Call FrequencyRecommended usage: At each customer return label requestMaximum usage: At each customer return label request
 - [GET /api/returns/return-labels](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/returns/rt52.md): DescriptionRetrieve the list of the return label requests along with their details and states Call FrequencyRecommended usage: At each customer return label requestMaximum usage: At each customer retu
## Stores

 - [GET /api/shops/documents](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/stores/s30.md): DescriptionYou must specify at least one of the following parameters: shop_ids, updated_since Call FrequencyRecommended usage: At each display of a page that includes documents from a store (for examp
 - [POST /api/shops/documents](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/stores/s32.md): DescriptionDocument 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, o
 - [GET /api/shops/documents/download](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/stores/s31.md): DescriptionIt 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 spe
 - [DELETE /api/shops/documents/{document_id}](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/stores/s33.md): Call FrequencyRecommended usage: At each document deletion from one storeMaximum usage: At each document deletion from one storeRead MoreMore context
## Multiple shipments

 - [POST /api/shipments](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st01.md): DescriptionLimited to 1000 shipments at a time Call FrequencyRecommended usage: On each new shipmentMaximum usage: On each new shipmentRead MoreMore context
 - [PUT /api/shipments](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st07.md): DescriptionLimited to 100 shipments at a time Call FrequencyRecommended usage: At each update of shipments for one or multiple shipmentsMaximum usage: At each update of shipments for one or multiple s
 - [GET /api/shipments](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st11.md): Call FrequencyRecommended usage: at each shipment page displayMaximum usage: at each shipment page displayRead MoreMore contextPaginationThis resource supports seek pagination (see documentation)Sort
 - [PUT /api/shipments/delete](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st06.md): DescriptionLimited to 1000 shipments at a time Call FrequencyRecommended usage: On each shipment deletionMaximum usage: On each shipment deletionRead MoreMore context
 - [GET /api/shipments/items_to_ship](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st12.md): Call FrequencyRecommended usage: Every 15 minutesMaximum usage: Every 5 minutesRead MoreMore contextPaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have t
 - [POST /api/shipments/tracking](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st23.md): DescriptionIf the carrier is not registered, the complete tracking url can be provided. Limited to 1000 shipments at a time. Call FrequencyRecommended usage: On each shipment tracking info updateMaxim
 - [PUT /api/shipments/ship](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st24.md): DescriptionLimited to 1000 shipments at a time Call FrequencyRecommended usage: On each shipment shippingMaximum usage: On each shipment shippingRead MoreMore context
 - [PUT /api/shipments/ready_for_pick_up](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st26.md): DescriptionLimited to 1000 shipments at a time Call FrequencyRecommended usage: On each shipment ready to pick upMaximum usage: On each shipment ready to pick up
 - [PUT /api/shipments/additional_information](https://developer.mirakl.com/content/product/mmp/rest/operator/openapi3/multiple-shipments/st31.md): DescriptionLimited to 100 shipments at a time Call FrequencyRecommended usage: At each update of shipments for one or multiple shipmentsMaximum usage: At each update of shipments for one or multiple s
## Warehouses