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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Mirakl

Mirakl Settings API

The Settings API from Mirakl — 1 operation(s) for settings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Mirakl 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 Settings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 1 path, and defines 69 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://operator-shpy.mirakl.net.

2 operations 1 paths 69 schemas 1 GET1 PATCH

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
Resource Areas
1

Authentication & Security 1

Mirakl Settings API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer).

Paths & Operations 2

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

Settings 2
GET
/api/settings
ListSettings - List connector settings
ListSettings → 200
PATCH
/api/settings
UpdateSettings - Update connector settings
UpdateSettings body → 200

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are UpdateSettings_Request (31 properties), ListSettings_Response_200 (31 properties), UpdateSettings_Response_200 (31 properties), UpdateSettings_Request_Payment (9 properties). Each schema is shown below with its type and property counts.

UpdateSettings_Response_200_ShippingZoneMapping_Countries_Zips
object
2 properties
UpdateSettings_Request_Jobs
object
The job settings
1 property
ListSettings_Response_200_Order
object
Order sync settings response
2 properties
UpdateSettings_Response_200_Shop
object
Shop settings response
1 property
UpdateSettings_Request_Offer
object
Request object to update offer sync settings
3 properties
ListSettings_Response_200_Shop
object
Shop settings response
1 property
ListSettings_Response_200_Offer
object
Offer metafield mapping response
3 properties
UpdateSettings_Request_ImageAttributes
object
Request object to update image attribute
3 properties
ListSettings_Response_200_ShippingZoneMapping_Countries
object
4 properties
UpdateSettings_Request_MiraklMasterMode
object
Request object to update Mirakl master mode settings
UpdateSettings_Request_Shop
object
Request object to update shop settings
1 property
UpdateSettings_Request_ShippingZoneMapping_Countries_Provinces
object
List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: K2 and K2P will match the customer zip code K2…
2 properties
UpdateSettings_Response_200_Categories
object
Response object for category configuration during taxonomy export
2 properties
UpdateSettings_Request_FraudCheck
object
Fraud check
2 properties
ListSettings_Response_200_MiraklPayout
object
Payment settings response
1 property
ListSettings_Response_200_Payment
object
Payment settings response
9 properties
UpdateSettings_Request_AdditionalLocales
object
Configuration of an additional locale, aside the primary language of the store
1 property
UpdateSettings_Response_200_Product_SkuGenerations
object
SKU generation settings response
1 property
UpdateSettings_Response_200_ImageAttributes
object
Image attribute response
3 properties
ListSettings_Response_200
object
Environment settings response
31 properties
UpdateSettings_Response_200_Order_MiraklExportCustomerOrganization
object
Mirakl export customer organization response
1 property
UpdateSettings_Request_Categories
object
Configuration for category filtering during taxonomy export
2 properties
UpdateSettings_Response_200_Payment
object
Payment settings response
9 properties
UpdateSettings_Request_Shop_ShopMiraklCustomFields
object
Request object to update Mirakl shop custom field
1 property
UpdateSettings_Request
object
Request object to update environment settings
31 properties
ListSettings_Response_200_AdditionalLocales
object
Configuration of an additional locale, aside the primary language of the store
1 property
UpdateSettings_Response_200_Product
object
Product settings response
1 property
UpdateSettings_Response_200_ShippingZoneMapping
object
Shipping zone mapping response
2 properties
UpdateSettings_Response_200_Shop_ShopMiraklCustomFields
object
Mirakl shop custom field response
1 property
UpdateSettings_Response_200_ShippingZoneMapping_Countries
object
4 properties
ListSettings_Response_200_ShippingZoneMapping
object
Shipping zone mapping response
2 properties
UpdateSettings_Request_Product
object
Request object to update product settings
1 property
ListSettings_Response_200_Order_OrderMetafields
object
Order metafield mapping response
3 properties
ListSettings_Response_200_RootAttributes
object
Response object for Shopify root attribute
1 property
UpdateSettings_Request_MiraklPayout
object
Mirakl Payout settings
1 property
UpdateSettings_Response_200
object
Environment settings response
31 properties
UpdateSettings_Response_200_ShippingZoneMapping_Countries_Provinces
object
2 properties
UpdateSettings_Response_200_Order_OrderMetafields
object
Order metafield mapping response
3 properties
UpdateSettings_Response_200_TaxonomyMetafields
object
Taxonomy metafield response
4 properties
UpdateSettings_Response_200_Order
object
Order sync settings response
2 properties
UpdateSettings_Response_200_MiraklMasterMode
object
2 properties
UpdateSettings_Request_Order
object
Request object to update order sync settings
2 properties
UpdateSettings_Request_ShippingZoneMapping
object
Request object to update shipping zone mapping
2 properties
UpdateSettings_Response_200_Offer
object
Offer metafield mapping response
3 properties
ListSettings_Response_200_TaxonomyMetafields
object
Taxonomy metafield response
4 properties
UpdateSettings_Response_200_FraudCheck
object
2 properties
UpdateSettings_Request_Order_MiraklExportCustomerOrganization
object
Request object to exporting customer organization data to Mirakl
1 property
UpdateSettings_Request_Product_SkuGenerations
object
Request object to define a SKU generation strategy
1 property
ListSettings_Response_200_ShippingZoneMapping_Countries_Zips
object
2 properties
ListSettings_Response_200_Order_MiraklExportCustomerOrganization
object
Mirakl export customer organization response
1 property
ListSettings_Response_200_FraudCheck
object
2 properties
UpdateSettings_Request_TaxonomyMetafields
object
Request object to update taxonomy metafield
4 properties
UpdateSettings_Response_200_MiraklPayout
object
Payment settings response
1 property
UpdateSettings_Response_200_AdditionalLocales
object
Configuration of an additional locale, aside the primary language of the store
1 property
UpdateSettings_Response_200_RootAttributes
object
Response object for Shopify root attribute
1 property
UpdateSettings_Request_Payment
object
Payment settings request
9 properties
UpdateSettings_Request_ShippingZoneMapping_Countries_Zips
object
List of zip who override the shipping zone code. The code must match the beginning of customer the zip code (ex: K2 and K2P will match the customer zip code K2…
2 properties
ListSettings_Response_200_Jobs
object
1 property
UpdateSettings_Request_Order_OrderMetafields
object
Request object to update order metafield mapping
3 properties 3 required
ListSettings_Response_200_Shop_ShopMiraklCustomFields
object
Mirakl shop custom field response
1 property
ListSettings_Response_200_Product_SkuGenerations
object
SKU generation settings response
1 property
ListSettings_Response_200_ShippingZoneMapping_Countries_Provinces
object
2 properties
UpdateSettings_Response_200_Jobs
object
1 property
UpdateSettings_Request_RootAttributes
object
Request object to update Shopify root attribute
1 property
ListSettings_Response_200_ImageAttributes
object
Image attribute response
3 properties
ListSettings_Response_200_Categories
object
Response object for category configuration during taxonomy export
2 properties
ListSettings_Response_200_Product
object
Product settings response
1 property
ListSettings_Response_200_MiraklMasterMode
object
2 properties
UpdateSettings_Request_ShippingZoneMapping_Countries
object
List of countries who override the default shipping zone code
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-settings-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
AE Profile APIs.io
Mirakl Catalog Configuration API
AE Profile APIs.io
Mirakl Incidents API
AE Profile APIs.io
Mirakl Invoicing and Accounting API
AE Profile APIs.io
Mirakl Messages API
AE Profile APIs.io
Mirakl Multiple shipments API
AE Profile APIs.io
Mirakl Offers API
AE Profile APIs.io
Mirakl Orders API
AE Profile APIs.io
Mirakl Picklists API
AE Profile APIs.io
Mirakl Platform Settings API
AE Profile APIs.io
Mirakl Product Feedback API
AE Profile APIs.io
Mirakl Products API
AE Profile APIs.io
#Settings
← Back to M APIs
API Details
ID
mirakl:mirakl-settings-api
Base URL
https://your-instance.mirakl.net
Docs
https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3
Provider
Mirakl
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mirakl-settings-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mirakl-settings-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Mirakl 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.