# Mirakl Platform for Services APIs {% partial file="/partial-content/product/mms/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 Platform for Services APIs](https://developer.mirakl.com/_spec/content/product/mms/rest/seller/openapi3.yaml) ## Stores ### A01 - Get shop information - [GET /api/account](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/stores/a01.md): Call FrequencyRecommended usage: Once per dayMaximum usage: Once per day ### A02 - Update shop information - [PUT /api/account](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/stores/a02.md): Depending on the operator's configuration, some fields might not be editable.Call FrequencyRecommended usage: At each information updateMaximum usage: Once per day ### S30 - List shop's documents - [GET /api/shops/documents](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/stores/s30.md): You must specify at least one of the following parameters: shop_ids, updated_sinceCall FrequencyRecommended 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/seller/openapi3/stores/s32.md): 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 FrequencyRecommended usage: At each business document upload to a shopMaximum 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/mms/rest/seller/openapi3/stores/s31.md): 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 invalidCall FrequencyRecommended usage: After each S30 call, when you want to download documents from a storeMaximum 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/mms/rest/seller/openapi3/stores/s33.md): Call FrequencyRecommended usage: At each document deletion from one storeMaximum 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/mms/rest/seller/openapi3/platform-settings/af01.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: ### CH11 - List all enabled channels - [GET /api/channels](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/platform-settings/ch11.md): Results are sorted by codeCall FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis 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/seller/openapi3/platform-settings/cur01.md): List currency codes and labels activated on the platformCall FrequencyRecommended usage: Once per dayMaximum usage: Once per dayLocalizationThis 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/seller/openapi3/platform-settings/do01.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: ### L01 - List locale codes and labels - [GET /api/locales](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/platform-settings/l01.md): List locale codes and labels from your platform to automate product format exports (API H01, PM01, VL01) from your PIM systemCall FrequencyRecommended usage: Once per dayMaximum usage: Once per day ### PC01 - List platform configurations - [GET /api/platform/configuration](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/platform-settings/pc01.md): 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/seller/openapi3/platform-settings/re01.md): This 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 must display a list of reasonsMaximum usage: Each time a page must display a list of reasonsRead MoreMore contextLocalizationThis resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: ### V01 - Health Check endpoint - [GET /api/version](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/platform-settings/v01.md): 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/mms/rest/seller/openapi3/platform-settings/re02.md): This API returns cancellation, refund, incident, and message reasons.Reasons are sorted by sort index (set in the back-office)Call FrequencyRecommended usage: Each time a page must display a list of reasonsMaximum usage: Each time a page must display a list of reasonsLocalizationThis 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/seller/openapi3/invoicing-and-accounting/iv01.md): Call FrequencyRecommended usage: Once per day and as many times as there are invoice pages returnedMaximum usage: Once per day and as many times as there are invoice pages returnedPaginationThis resource supports offset pagination (see documentation)Sort fieldssort 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/mms/rest/seller/openapi3/invoicing-and-accounting/iv02.md): Call FrequencyRecommended usage: At each invoice downloadMaximum usage: At each invoice download ### TL02 - List transaction lines - [GET /api/sellerpayment/transactions_logs](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/invoicing-and-accounting/tl02.md): This resource uses seek pagination. The maximum allowed value for parameter limit is 2000.Call FrequencyRecommended usage: 20 times per dayMaximum usage: 20 times per min, 60 times per hourPaginationThis resource supports seek pagination (see documentation)Sort fieldssort 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/mms/rest/seller/openapi3/invoicing-and-accounting/tl03.md): The export is asynchronous. Export status can be retrieved by calling TL04.Call FrequencyRecommended usage: once per dayMaximum 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/mms/rest/seller/openapi3/invoicing-and-accounting/tl04.md): Retrieve the status for an TL03 transaction log export. When the export is complete, the URLs to retrieve the files are returned. Call FrequencyRecommended usage: Once per minute until you get an error or a successMaximum 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/mms/rest/seller/openapi3/invoicing-and-accounting/tl05.md): Retrieve each chunk of an transaction logs export file via the URL generated once the asynchronous transaction logs export is complete ## Users ### RO02 - List shop roles - [GET /api/users/shops/roles](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/users/ro02.md): Call FrequencyRecommended usage: On each user role viewMaximum usage: On each user role viewRead MoreMore context ## Services ### SL01 - Create a location - [POST /api/mms/locations](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sl01.md): Call FrequencyRecommended usage: 30 per minuteMaximum usage: 30 per minute ### SL12 - List locations - [GET /api/mms/locations](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sl12.md): Call FrequencyRecommended usage: - Asynchronous: once per day - Synchronous: each time you need to create a serviceMaximum usage: - Asynchronous: every hour - Synchronous: each time you need to create a servicePaginationThis resource supports seek pagination (see documentation) ### SL06 - Delete a location - [DELETE /api/mms/locations/{location_id}](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sl06.md): Call FrequencyRecommended usage: 20 per secondMaximum usage: 60 per second ### SM11 - List service models - [GET /api/mms/models](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sm11.md): Call FrequencyRecommended usage: Once per hourMaximum usage: Once per hourPaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have the following values:title - Sort by title (asc by default)code (Default) - Sort by code (asc by default) ### SOF11 - List services - [GET /api/mms/services](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sof11.md): Call FrequencyRecommended usage: Once per hourMaximum usage: Once per hourPaginationThis resource supports seek pagination (see documentation)Sort fieldssort field can have the following values:date_created - Sort by last created date (asc by default)date_updated - Sort by last updated date (asc by default)title (Default) - Sort by title (asc by default) ### SOF25 - Create a service - [POST /api/mms/services](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sof25.md): Call FrequencyRecommended usage: 60 per minuteMaximum usage: 60 per minute ### SOF26 - Update a service - [PUT /api/mms/services/{service_code}](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sof26.md): Call FrequencyRecommended usage: 60 per minuteMaximum usage: 60 per minute ### SOF27 - Delete a service - [DELETE /api/mms/services/{service_code}](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/services/sof27.md): Call FrequencyRecommended usage: 30 per minuteMaximum usage: 30 per minute ## Messages ### SOF43 - Create a thread on a service - [POST /api/mms/services/{service_code}/threads](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/messages/sof43.md): Call FrequencyRecommended usage: At every message threadMaximum usage: At every message thread ### SOR43 - Create a thread on a service order - [POST /api/mms/orders/{order_id}/threads](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/messages/sor43.md): Call FrequencyRecommended usage: At each new message posted on a service orderMaximum usage: At each new message posted on a service order ## Orders ### SOR04 - Update an order - [PUT /api/mms/orders/{order_id}](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/orders/sor04.md): Note: closed or cancelled order cannot be updated. ### SOR11 - List orders - [GET /api/mms/orders](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/orders/sor11.md): Call FrequencyRecommended usage: At each service order page displayMaximum usage: At each service order page displayPaginationThis resource supports seek pagination (see documentation) ### SOR21 - Accept an order in WAITING_ACCEPTANCE state - [PUT /api/mms/orders/{order_id}/accept](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/orders/sor21.md): Call FrequencyRecommended usage: For each new service orderMaximum usage: For each new service order ### SOR22 - Refuse an order in WAITING_ACCEPTANCE state - [PUT /api/mms/orders/{order_id}/refuse](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/orders/sor22.md): Call FrequencyRecommended usage: For each new service orderMaximum usage: For each new service order ### SOR25 - Consume an order in ORDER_PENDING state - [PUT /api/mms/orders/{order_id}/consume](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/orders/sor25.md): Call FrequencyRecommended usage: At each customer service consumption confirmationMaximum usage: At each customer service consumption confirmation ### SOR28 - Request refund on order - [PUT /api/mms/orders/{order_id}/refund](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/orders/sor28.md): Call FrequencyRecommended usage: At each service refund requestMaximum usage: At each service refund request ### SOR51 - Get the evaluation of an order - [GET /api/mms/orders/{order_id}/evaluation](https://developer.mirakl.com/content/product/mms/rest/seller/openapi3/orders/sor51.md): Call FrequencyRecommended usage: At each order evaluation page displayMaximum usage: At each order evaluation page displayLocalizationThis resource supports locale parameter (see documentation)Localized output fields will be highlighted with an icon: