# Mirakl Platform for Services APIs

{% partial file="/partial-content/product/mms/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

### operator_api_key

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

 - [Mirakl Platform for Services APIs](https://developer.mirakl.com/_bundle/content/product/mms/rest/operator/openapi3.yaml)

## Platform Settings

 - [GET /api/additional_fields](https://developer.mirakl.com/content/product/mms/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/mms/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/mms/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/mms/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/mms/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/platform/configuration](https://developer.mirakl.com/content/product/mms/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/mms/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/reasons/{reason_type}](https://developer.mirakl.com/content/product/mms/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
## Customers

## Invoicing and Accounting

 - [GET /api/invoices](https://developer.mirakl.com/content/product/mms/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/mms/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/mms/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
## Users

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

 - [GET /api/shops/documents](https://developer.mirakl.com/content/product/mms/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/mms/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/mms/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/mms/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
## Services

 - [POST /api/mms/locations](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/services/sl01.md): Call FrequencyRecommended usage: 30 per minuteMaximum usage: 30 per minute
 - [GET /api/mms/locations](https://developer.mirakl.com/content/product/mms/rest/operator/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
 - [DELETE /api/mms/locations/{location_id}](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/services/sl06.md): Call FrequencyRecommended usage: 20 per secondMaximum usage: 60 per second
 - [GET /api/mms/models](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/services/sm11.md): Call FrequencyRecommended usage: - Asynchronous: once per day - Synchronous: at each faceting displayMaximum usage: - Asynchronous: every hour - Synchronous: at each faceting displayRead MoreMore cont
 - [POST /api/mms/services](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/services/sof25.md): Call FrequencyRecommended usage: 60 per minuteMaximum usage: 60 per minute
 - [PUT /api/mms/services/{service_code}](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/services/sof26.md): Call FrequencyRecommended usage: 60 per minuteMaximum usage: 60 per minute
 - [DELETE /api/mms/services/{service_code}](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/services/sof27.md): Call FrequencyRecommended usage: 30 per minuteMaximum usage: 30 per minute
## Messages

 - [POST /api/mms/services/{service_code}/threads](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/messages/sof43.md): Call FrequencyRecommended usage: At every message threadMaximum usage: At every message threadRead MoreMore context
 - [POST /api/mms/orders/{order_id}/threads](https://developer.mirakl.com/content/product/mms/rest/operator/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 orderRead MoreMore context
## Orders

 - [PUT /api/mms/orders/{order_id}](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/orders/sor04.md): DescriptionNote: closed or cancelled order cannot be updated. Read MoreMore context
 - [PUT /api/mms/orders/{order_id}/accept](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/orders/sor21.md): > ⚠️ **Content-length header** The Content-Length header must be present with value 0, even when there is no request body. DescriptionAccept an order in WAITING_ACCEPTANCE state Call FrequencyRecomme
 - [PUT /api/mms/orders/{order_id}/refuse](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/orders/sor22.md): > ⚠️ **Content-length header** The Content-Length header must be present with value 0, even when there is no request body. DescriptionRefuse an order in WAITING_ACCEPTANCE state Call FrequencyRecomme
 - [PUT /api/mms/orders/{order_id}/consume](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/orders/sor25.md): DescriptionConsumer an order in ORDER_PENDING state Call FrequencyRecommended usage: At each customer service consumption confirmationMaximum usage: At each customer service consumption confirmationRe
 - [PUT /api/mms/orders/{order_id}/refund](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/orders/sor28.md): Call FrequencyRecommended usage: At each service refund requestMaximum usage: At each service refund requestRead MoreMore context
 - [GET /api/mms/orders/{order_id}/evaluation](https://developer.mirakl.com/content/product/mms/rest/operator/openapi3/orders/sor51.md): Call FrequencyRecommended usage: At each order evaluation page displayMaximum usage: At each order evaluation page displayRead MoreMore contextLocalizationThis resource supports locale parameter (see
## Payment

