# Mirakl Platform for Services APIs {% partial file="/partial-content/product/mms/rest/front/openapi-description.md" /%} ## Servers URL to be replaced by your Mirakl instance URL ``` https://your-instance.mirakl.net ``` ## Security ### front_api_key Type: apiKey In: header Name: Authorization ### front_bearer_token Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Mirakl Platform for Services APIs](https://developer.mirakl.com/_bundle/content/product/mms/rest/front/openapi3.yaml) ## Platform Settings ### AF01 - List all custom fields - [GET /api/additional_fields](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/platform-settings/af01.md): Call Frequency Recommended usage: Once per day Maximum usage: Once per day Read More More contextLocalization 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/mms/rest/front/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/mms/rest/front/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/mms/rest/front/openapi3/platform-settings/do01.md): Call Frequency Recommended usage: Once per day Maximum usage: Once per day Read More More contextLocalization 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/mms/rest/front/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 ### PC01 - List platform configurations - [GET /api/platform/configuration](https://developer.mirakl.com/content/product/mms/rest/front/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/mms/rest/front/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: ### RE02 - List reasons by type (deprecated) - [GET /api/reasons/{reason_type}](https://developer.mirakl.com/content/product/mms/rest/front/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: ## Invoicing and Accounting ### IV01 - List accounting documents - [GET /api/invoices](https://developer.mirakl.com/content/product/mms/rest/front/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) ## Users ### RO02 - List shop roles - [GET /api/users/shops/roles](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/users/ro02.md): Call Frequency Recommended usage: On each user role view Maximum usage: On each user role view Read More More context ## Stores ### S30 - List shop's documents - [GET /api/shops/documents](https://developer.mirakl.com/content/product/mms/rest/front/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/mms/rest/front/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 Read More More context ### S31 - Download documents for one or multiple shops - [GET /api/shops/documents/download](https://developer.mirakl.com/content/product/mms/rest/front/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 a list of shop identifiers is specified, all documents from those shops are downloaded. Use a list of shop document type codes to retrieve specific types from those shops. 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_x/ | |__ foo.txt | |__ bar.txt | |__ baz.pdf | |__ shop_id_y/ | |__ image.png | |__ image(1).png Returns a 404 if at least one document id, one shop 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 Read More More context ### S33 - Delete a shop document - [DELETE /api/shops/documents/{document_id}](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/stores/s33.md): Call Frequency Recommended usage: At each document deletion from one store Maximum usage: At each document deletion from one store Read More More context ## Services ### SM11 - List service models - [GET /api/mms/models](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/services/sm11.md): Call Frequency Recommended usage: - Asynchronous: once per day - Synchronous: at each faceting display Maximum usage: - Asynchronous: every hour - Synchronous: at each faceting display Read More More contextPagination This resource supports seek pagination (see documentation) Sort fields sort field can have the following values:title - Sort by title (asc by default)code (Default) - Sort by code (asc by default) ## Messages ### SOF43 - Create a thread on a service - [POST /api/mms/services/{service_code}/threads](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/messages/sof43.md): Call Frequency Recommended usage: At every message thread Maximum usage: At every message thread Read More More context ### SOR43 - Create a thread on a service order - [POST /api/mms/orders/{order_id}/threads](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/messages/sor43.md): Call Frequency Recommended usage: At each new message posted on a service order Maximum usage: At each new message posted on a service order Read More More context ## Orders ### SOR04 - Update an order - [PUT /api/mms/orders/{order_id}](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/orders/sor04.md): Description Note: closed or cancelled order cannot be updated. Read More More context ### SOR21 - Accept an order - [PUT /api/mms/orders/{order_id}/accept](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/orders/sor21.md): Description Accept an order in WAITING_ACCEPTANCE state Call Frequency Recommended usage: For each new service order Maximum usage: For each new service order Read More More context ### SOR22 - Refuse an order - [PUT /api/mms/orders/{order_id}/refuse](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/orders/sor22.md): Description Refuse an order in WAITING_ACCEPTANCE state Call Frequency Recommended usage: For each new service order Maximum usage: For each new service order Read More More context ### SOR25 - Consume an order - [PUT /api/mms/orders/{order_id}/consume](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/orders/sor25.md): Description Consumer an order in ORDER_PENDING state Call Frequency Recommended usage: At each customer service consumption confirmation Maximum usage: At each customer service consumption confirmation Read More More context ### SOR51 - Get the evaluation of an order - [GET /api/mms/orders/{order_id}/evaluation](https://developer.mirakl.com/content/product/mms/rest/front/openapi3/orders/sor51.md): Call Frequency Recommended usage: At each order evaluation page display Maximum usage: At each order evaluation page display Read More More contextLocalization This resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: