Mirakl

Mirakl Platform Settings API

The Platform Settings API from Mirakl — 19 operation(s) for platform settings.

GitHub OpenAPI

Operations 20

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/additional_fields List the platform's custom fields · AF01 - List all custom fields #
Ask an LLM
“Which custom fields has the operator defined on the marketplace?”
“Can I see only the custom fields that apply to offers or to shops?”
Tell an agent
List all custom fields configured on the platform.
Show the custom fields defined for {entities}.
GET /api/channels List enabled sales channels · CH11 - List all enabled channels #
Ask an LLM
“Which sales channels are enabled on my Mirakl marketplace?”
“What channel codes can I use when pricing offers per channel?”
Tell an agent
List every enabled channel sorted by code.
Show the channels enabled for shop {shop_id}.
GET /api/currencies List activated currencies · CUR01 - List currency codes and labels #
Ask an LLM
“Which currencies are activated on the marketplace platform?”
“What are the currency codes and labels I can use for prices?”
Tell an agent
List the currency codes and labels active on the platform.
Show the currencies available to shop {shop_id}.
GET /api/documents List document types · DO01 - List all document types #
Ask an LLM
“What kinds of documents can be attached to orders or shops on the marketplace?”
“Which document types are defined for a given entity?”
Tell an agent
List all document types configured on the platform.
Show the document types available for {entities}.
GET /api/locales List platform locales · L01 - List locale codes and labels #
Ask an LLM
“Which locales and languages does the marketplace support?”
“What locale codes should my PIM use when exporting product formats?”
Tell an agent
List the locale codes and labels of the platform.
Show the locales available to shop {shop_id}.
GET /api/platform/configuration Get platform modules and features · PC01 - List platform configurations #
Ask an LLM
“Which modules and major features were activated when the platform was set up?”
“Is a given feature enabled on our marketplace platform configuration?”
Tell an agent
Show the platform configuration with its activated modules and features.
Get the general platform information and feature flags as seen by shop {shop_id}.
GET /api/version Check the platform is up · V01 - Health Check endpoint #
Ask an LLM
“Is the Mirakl platform up right now?”
“What endpoint can I ping as a health check before running my sync jobs?”
Tell an agent
Run a health check against the marketplace platform.
Check whether the platform responds for shop {shop_id}.
GET /api/offers/states List offer conditions · OF61 - List offer conditions #
Ask an LLM
“What offer conditions like new or refurbished can sellers choose from?”
“Can I list only the active offer states?”
Tell an agent
List all offer conditions in back-office order.
Show offer conditions filtered by active status {active}.
GET /api/reasons List all reason types at once · RE01 - List reasons #
Ask an LLM
“Where do I get every cancellation, refund, incident and message reason in one call?”
“What reasons can a customer or seller pick when refunding or cancelling?”
Tell an agent
List all reasons of every type sorted by type then index.
Fetch the full set of cancellation, refund, incident and messaging reasons.
GET /api/reasons/{reason_type} List reasons of a single type (deprecated) · RE02 - List reasons by type #
Ask an LLM
“Can I fetch only the reasons for one reason type using the older per-type endpoint?”
“Is the list-reasons-by-type endpoint still supported or being removed?”
Tell an agent
List the reasons of type {reason_type} using the deprecated per-type endpoint.
Get only {reason_type} reasons sorted by index.
GET /api/reasons/incident_open List incident-opening reasons (deprecated) · RE11 - List of reasons with type: incident open #
Ask an LLM
“What reasons can be used to open an incident on an order line?”
“Which incident open reasons is my role allowed to use?”
Tell an agent
List the reasons for opening an incident.
Show incident-open reasons from the legacy dedicated endpoint.
GET /api/reasons/incident_close List incident-closing reasons (deprecated) · RE12 - List of reasons with type: incident close #
Ask an LLM
“What reasons can be given when closing an incident?”
“Which incident close reasons does my role have access to?”
Tell an agent
List the reasons for closing an incident.
Show incident-close reasons from the legacy dedicated endpoint.
GET /api/reasons/messaging List messaging reasons (deprecated) · RE14 - List of reasons with type: messaging #
Ask an LLM
“What subjects or reasons can be chosen when sending a message?”
“Which messaging reasons are available to my user role?”
Tell an agent
List the messaging reasons.
Show message reasons from the legacy messaging-reasons endpoint.
GET /api/shipping/zones List active shipping zones · SH11 - List all active shipping zones #
Ask an LLM
“Which shipping zones are active on the marketplace?”
“What zone codes can I use when filtering offers by shipping destination?”
Tell an agent
List all active shipping zones.
Show the shipping zones in back-office order.
GET /api/shipping/types List active shipping methods · SH12 - List all active shipping methods #
Ask an LLM
“What shipping methods like standard or express are active?”
“Which shipping type codes can sellers configure for delivery?”
Tell an agent
List all active shipping methods.
Show the shipping types available on the platform.
GET /api/shipping/carriers List carriers on the platform · SH21 - List all carriers #
Ask an LLM
“Which carriers can sellers pick when adding tracking to a shipment?”
“What carrier codes are configured on the marketplace?”
Tell an agent
List all carriers sorted alphabetically by label.
Show every carrier code and label the platform knows.
GET /api/shipping/logistic_classes List logistic classes · SH31 - List all logistic classes #
Ask an LLM
“What logistic classes are defined for pricing shipping by parcel size?”
“Which logistic class codes can I assign to an offer?”
Tell an agent
List all logistic classes.
Show the logistic classes in back-office order.
GET /api/shipping/configuration/shop Get a shop's shipping configuration · SH42 - Get shop shipping configuration #
Ask an LLM
“What shipping settings are configured for my shop?”
“Can I see a seller's shipping configuration before editing their shipping fees?”
Tell an agent
Get the shipping configuration of shop {shop_id}.
Show my shop's shipping configuration.
GET /api/shipping/charges/shop Get a shop's shipping charges · SH52 - Get shipping charges configured for a shop account #
Ask an LLM
“What shipping fees are configured for my shop account?”
“Can I see only the shipping charges a shop has overridden?”
Tell an agent
Get the shipping charges configured for shop {shop_id}.
Show shipping charges where overridden by shop is {overridden_by_shop}.
GET /api/platform-settings/operator-return-configurations Get operator return configurations · GetOperatorReturnConfigurations - Get return configurations for shops #
Ask an LLM
“What return policies has the operator set up for shops?”
“Where can I read the return configuration the marketplace applies to sellers?”
Tell an agent
Get the operator's return configurations for shops.
Show the return settings configured by the operator.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-platform-settings-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/_original/mirakl-connect-channel-webhooks-openapi.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mirakl:mirakl-platform-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mirakl-platform-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mirakl Platform Settings API
  version: ''
  description: 'Operations tagged Platform Settings across 5 of this provider''s published API definitions: mirakl-mcm-seller-openapi.json, mirakl-mmp-front-openapi.yaml, mirakl-mmp-seller-openapi.json, mirakl-mms-seller-openapi.json, mirakl-shopify-operator-connector-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: URL to be replaced by your Mirakl instance URL
  url: https://your-instance.mirakl.net
- description: Shopify production endpoint.
  url: https://operator-shpy.mirakl.net
tags:


# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-platform-settings-api-openapi.yml