# Mirakl Catalog Manager APIs

{% partial file="/partial-content/product/mcm/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 Catalog Manager APIs](https://developer.mirakl.com/_bundle/content/product/mcm/rest/operator/openapi3.yaml)

## Platform Settings

 - [GET /api/additional_fields](https://developer.mirakl.com/content/product/mcm/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/mcm/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/mcm/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/mcm/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/mcm/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/mcm/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
## Products

 - [GET /api/mcm/products/sources/status/export](https://developer.mirakl.com/content/product/mcm/rest/operator/openapi3/products/cm11.md): DescriptionDelta export of the source product data sheet status in JSON format. Define a cron job in your system that periodically calls this API and sets the previous request date as the `updated_sin
 - [GET /api/hierarchies](https://developer.mirakl.com/content/product/mcm/rest/operator/openapi3/products/h11.md): Call FrequencyRecommended usage: Every hourMaximum usage: Every hour
 - [POST /api/products/imports](https://developer.mirakl.com/content/product/mcm/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/mcm/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/mcm/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/mcm/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/mcm/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/mcm/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/mcm/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/mcm/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/mcm/rest/operator/openapi3/products/vl11.md): Call FrequencyRecommended usage: Every hourMaximum usage: Every hour
## Users

 - [GET /api/users/shops/roles](https://developer.mirakl.com/content/product/mcm/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/mcm/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/mcm/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/mcm/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/mcm/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