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 Synchronization API

The Synchronization API from Mirakl — 11 operation(s) for synchronization.

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

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

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

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

11 operations 11 paths 9 schemas 11 POST

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 Synchronization API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer).

Paths & Operations 11

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

Synchronization 11
POST
/api/sync/taxonomy
SyncCatalogStructure - Synchronize your Shopify catalog structure to Mirakl
SyncCatalogStructure → 202425
POST
/api/sync/deleted-mirakl-products
SyncDeletedMiraklProducts - Synchronize deleted products from Mirakl to Shopify
SyncDeletedMiraklProducts body → 202425
POST
/api/sync/product-shopify-to-mirakl
SyncFirstPartyProducts - Synchronize first-party products from Shopify to Mirakl
SyncFirstPartyProducts body → 202425
POST
/api/sync/offer-conditions
SyncOfferConditions - Synchronize offer conditions from Mirakl to Shopify
SyncOfferConditions → 200400
POST
/api/sync/offers
SyncOffers - Sync Offers
SyncOffers body → 202425
POST
/api/sync/orders
SyncOrders - Synchronize orders between Mirakl and Shopify
SyncOrders body → 202425
POST
/api/sync/promotions
SyncPromotions - Synchronize promotions from Mirakl to Shopify
SyncPromotions body → 202425
POST
/api/sync/returns
SyncReturns - Synchronize returns from Mirakl to Shopify
SyncReturns body → 202425
POST
/api/sync/shipment-mirakl-to-shopify
SyncShipments - Synchronize shipments from Mirakl to Shopify
SyncShipments body → 202425
POST
/api/sync/shops
SyncShops - Synchronize shops from Mirakl to Shopify
SyncShops body → 202425
POST
/api/sync/product-mirakl-to-shopify
SyncThirdPartyProducts - Synchronize third-party products from Mirakl to Shopify
SyncThirdPartyProducts body → 202425

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SyncFirstPartyProducts_Request (1 property), SyncReturns_Request (1 property), SyncShipments_Request (1 property), SyncPromotions_Request (1 property). Each schema is shown below with its type and property counts.

SyncFirstPartyProducts_Request
object
Request object to update Shopify to Mirakl product synchronization since date
1 property
SyncShops_Request
object
Request object for shop synchronization from Shopify to Mirakl
1 property
SyncThirdPartyProducts_Request
object
Request object holding the parameters for the product import
1 property
SyncOrders_Request
object
Request object to update order synchronization since date
1 property
SyncDeletedMiraklProducts_Request
object
Request object holding the parameters for the deleted Mirakl product synchronization request
1 property
SyncPromotions_Request
object
Request object to update promotion synchronization since date
1 property
SyncShipments_Request
object
Request object to update Mirakl to Shopify shipment synchronization since date
1 property
SyncReturns_Request
object
Request object for return synchronization from Shopify to Mirakl
1 property
SyncOffers_Request
object
Request object holding the parameters for the offer import
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-synchronization-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 Platform Settings API
Mirakl Product Feedback API
Mirakl Products API
Where this information came from

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