How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mirakl Platform Settings API

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

Mirakl Platform Settings API is one of 34 APIs that Mirakl publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Platform Settings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 20 paths, and defines 75 schemas. It is described by OpenAPI 3.2.0.

Requests are made against 2 base URLs: https://your-instance.mirakl.net, https://operator-shpy.mirakl.net.

20 operations 20 paths 75 schemas 20 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://your-instance.mirakl.net
Authentication
HTTP Bearer, OAuth 2.0, HTTP Bearer, API Key, HTTP Bearer, API Key, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 9

Mirakl Platform Settings API declares 9 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token). It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token). An API key is passed in the header as Authorization (Shop-API-Key). It accepts HTTP bearer tokens (JWT) (operator_bearer_token). An API key is passed in the header as Authorization (shop_api_key). An API key is passed in the header as Authorization (front_api_key). An API key is passed in the header as Authorization (operator_api_key). It accepts HTTP bearer tokens (JWT) (Bearer).

  • OAuth-2 — For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…

Paths & Operations 20

Across 20 paths, the API surfaces 20 operations — 20 GET. Each is listed below with its method, path, parameters, and response codes.

Platform Settings 20
GET
/api/additional_fields
AF01 - List all custom fields
AF01 1 param → 200
GET
/api/channels
CH11 - List all enabled channels
CH11 → 200
GET
/api/currencies
CUR01 - List currency codes and labels
CUR01 → 200
GET
/api/documents
DO01 - List all document types
DO01 1 param → 200
GET
/api/locales
L01 - List locale codes and labels
L01 → 200
GET
/api/platform/configuration
PC01 - List platform configurations
PC01 → 200
GET
/api/version
V01 - Health Check endpoint
V01 1 param → 200
GET
/api/offers/states
OF61 - List offer conditions
OF61 1 param → 200
GET
/api/reasons
RE01 - List reasons
RE01 → 200
GET
/api/reasons/{reason_type}deprecated
RE02 - List reasons by type
RE02 1 param → 200
GET
/api/reasons/incident_opendeprecated
RE11 - List of reasons with type: incident open
RE11 → 200
GET
/api/reasons/incident_closedeprecated
RE12 - List of reasons with type: incident close
RE12 → 200
GET
/api/reasons/messagingdeprecated
RE14 - List of reasons with type: messaging
RE14 → 200
GET
/api/shipping/zones
SH11 - List all active shipping zones
SH11 → 200
GET
/api/shipping/types
SH12 - List all active shipping methods
SH12 → 200
GET
/api/shipping/carriers
SH21 - List all carriers
SH21 → 200
GET
/api/shipping/logistic_classes
SH31 - List all logistic classes
SH31 → 200
GET
/api/shipping/configuration/shop
SH42 - Get shop shipping configuration
SH42 1 param → 200
GET
/api/shipping/charges/shop
SH52 - Get shipping charges configured for a shop account
SH52 2 params → 200
GET
/api/platform-settings/operator-return-configurations
GetOperatorReturnConfigurations - Get return configurations for shops
GetOperatorReturnConfigurations → 200

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are PC01_Response_200_Features (26 properties), AF01_Response_200_AdditionalFields (12 properties), PC01_Response_200_Modules (11 properties), GetOperatorReturnConfigurations_Response_200_Configurations (11 properties). Each schema is shown below with its type and property counts.

PC01_Response_200_Features_ShopTaxOptions_LocalTaxNumber
object
2 properties 1 required
PC01_Response_200_Features_Promotion
object
3 properties 3 required
PC01_Response_200_Features_TaxCollection
object
3 properties 3 required
PC01_Response_200_PlatformConfiguration_PlatformModel
object
3 properties 3 required
PC01_Response_200_Features_DirectPaymentCustomerStore
object
2 properties 2 required
DO01_Response_200
object
1 property 1 required
PC01_Response_200_Features_Dropship
object
2 properties
CH11_Response_200_Channels
object
3 properties 3 required
PC01_Response_200_Features
object
26 properties 26 required
PC01_Response_200_Features_ShopTaxOptions
object
2 properties 1 required
PC01_Response_200_PlatformConfiguration_EnhancedSellerInvoicing
object
1 property 1 required
PC01_Response_200_Modules_TaxManager_TaxProvider
object
2 properties 2 required
PC01_Response_200_Features_Catalog
object
6 properties 6 required
PC01_Response_200_Features_Pricing
object
6 properties 6 required
PC01_Response_200_Features_Warehouses
object
2 properties 2 required
PC01_Response_200_Features_OrderConditions
object
4 properties 4 required
L01_Response_200
object
1 property 1 required
AF01_Response_200
object
2 properties 2 required
AF01_Response_200_AdditionalFields
object
12 properties 5 required
PC01_Response_200_Features_Returns
object
3 properties
CUR01_Response_200_Currencies
object
3 properties 2 required
CH11_Response_200
object
1 property
L01_Response_200_Locales
object
3 properties 2 required
PC01_Response_200_Features_ShopTaxOptions_TaxIdentificationNumber
object
2 properties 1 required
PC01_Response_200_Modules
object
11 properties 9 required
PC01_Response_200
object
6 properties 6 required
PC01_Response_200_Features_Shipment
object
2 properties 2 required
PC01_Response_200_Modules_TaxManager
object
2 properties 2 required
DO01_Response_200_Documents
object
6 properties 4 required
PC01_Response_200_Features_OrderWorkflows
object
7 properties 7 required
PC01_Response_200_PlatformConfiguration_CustomerModel
object
2 properties 2 required
CUR01_Response_200
object
1 property 1 required
PC01_Response_200_PlatformConfiguration
object
3 properties 3 required
PC01_Response_200_Features_TaxIdNumber
object
2 properties 1 required
AF01_Response_200_AdditionalFields_2
object
10 properties 5 required
DO01_Response_200_Documents_2
object
5 properties 4 required
RE01_Response_200
object
2 properties 2 required
RE11_Response_200_Reasons
object
2 properties 2 required
RE12_Response_200_Reasons
object
2 properties 2 required
SH11_Response_200
object
1 property 1 required
RE01_Response_200_Reasons
object
6 properties 6 required
RE02_Response_200
object
2 properties 2 required
RE14_Response_200
object
2 properties 2 required
SH11_Response_200_ShippingZones
object
3 properties 3 required
OF61_Response_200
object
2 properties 2 required
OF61_Response_200_OfferStates
object
3 properties 3 required
SH21_Response_200_Carriers
object
4 properties 2 required
SH31_Response_200
object
1 property 1 required
SH31_Response_200_LogisticClasses
object
3 properties 3 required
SH12_Response_200_ShippingTypes
object
8 properties 6 required
RE02_Response_200_Reasons
object
2 properties 2 required
RE12_Response_200
object
2 properties 2 required
RE11_Response_200
object
2 properties 2 required
RE14_Response_200_Reasons
object
2 properties 2 required
SH12_Response_200
object
1 property
SH21_Response_200
object
1 property 1 required
SH42_Response_200_DeliveryTimes_DeliveryTime
object
Delivery time range configuration
2 properties 2 required
RE01_Response_200_Reasons_2
object
4 properties 4 required
OF61_Response_200_OfferStates_2
object
2 properties 2 required
SH52_Response_200_Configuration
object
5 properties 5 required
AF01_Response_200_AdditionalFields_3
object
10 properties 5 required
SH42_Response_200_OrderCutOffTimes
object
Seller order cut-off time entry for a shipping type
4 properties 4 required
SH42_Response_200
object
Seller shop shipping configuration
7 properties 6 required
SH52_Response_200_Configuration_Prices_Ranges
object
2 properties 2 required
SH52_Response_200
object
Shop shipping configuration
4 properties 4 required
SH52_Response_200_Configuration_Prices
object
5 properties 1 required
SH42_Response_200_DeliveryTimes
object
Delivery time entry for a shipping type and zone
4 properties 3 required
DO01_Response_200_Documents_3
object
5 properties 4 required
SH42_Response_200_LeadTimeToShip
object
Lead time to ship configuration
2 properties 2 required
RE01_Response_200_Reasons_3
object
4 properties 4 required
AF01_Response_200_AdditionalFields_4
object
10 properties 5 required
DO01_Response_200_Documents_4
object
5 properties 4 required
GetOperatorReturnConfigurations_Response_200_Configurations
object
Configuration for returns for an operator
11 properties
GetOperatorReturnConfigurations_Response_200
object
Configuration for returns for an operator
1 property 1 required
GetOperatorReturnConfigurations_Response_200_Configurations_ReturnAddress
object
Return address
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-platform-settings-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
Mirakl Catalog Configuration API
Mirakl Incidents API
Mirakl Invoicing and Accounting API
Mirakl Messages API
Mirakl Multiple shipments API
Mirakl Offers API
Mirakl Orders API
Mirakl Picklists API
Mirakl Product Feedback API
Mirakl Products API
Mirakl Promotions API
Where this information came from

This is an independent, third-party profile of Mirakl Platform Settings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.