Mirakl · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Shopify Operator Connector Synchronization API
12 actions
12 updates
phrasing
extends
openapi/mirakl-synchronization-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Mirakl's API. It is a proposal applied on top of the contract, not a document Mirakl publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/api/sync/taxonomy'].post
$.paths['/api/sync/deleted-mirakl-products'].post
$.paths['/api/sync/product-shopify-to-mirakl'].post
$.paths['/api/sync/offer-conditions'].post
$.paths['/api/sync/offers'].post
$.paths['/api/sync/orders'].post
$.paths['/api/sync/promotions'].post
$.paths['/api/sync/returns'].post
$.paths['/api/sync/shipment-mirakl-to-shopify'].post
$.paths['/api/sync/shops'].post
$.paths['/api/sync/product-mirakl-to-shopify'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Shopify Operator Connector Synchronization API
version: 1.0.0
extends: openapi/mirakl-synchronization-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 11
- target: $.paths['/api/sync/taxonomy'].post
update:
x-apievangelist-phrasing:
intent: Sync Shopify categories and attributes to Mirakl
effect: write
questions:
- How do I push my Shopify category structure and attributes into Mirakl?
- Is catalog structure sync to Mirakl asynchronous?
instructions:
- text: Sync my Shopify catalog structure to Mirakl.
- text: Push Shopify categories and attributes into Mirakl now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/deleted-mirakl-products'].post
update:
x-apievangelist-phrasing:
intent: Remove products deleted in Mirakl from Shopify
effect: destructive
questions:
- How do I remove third-party products from Shopify that were deleted in Mirakl?
- Does syncing deleted products also clean up product bindings?
instructions:
- text: Remove products deleted in Mirakl since {deletedSince} from Shopify.
slots:
deletedSince: requestBody.deletedSince
- text: Run the deleted-products cleanup now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/product-shopify-to-mirakl'].post
update:
x-apievangelist-phrasing:
intent: Sync first-party products from Shopify to Mirakl
effect: write
questions:
- How do I send my own Shopify products to Mirakl?
- Can I sync only first-party products changed after a certain date?
instructions:
- text: Sync first-party Shopify products changed since {sinceDate} to Mirakl.
slots:
sinceDate: requestBody.sinceDate
- text: Push my Shopify products into Mirakl.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/offer-conditions'].post
update:
x-apievangelist-phrasing:
intent: Sync offer conditions from Mirakl to Shopify
effect: write
questions:
- How do I bring Mirakl offer conditions into Shopify?
- Can I trigger an offer condition sync manually?
instructions:
- text: Sync offer conditions from Mirakl to Shopify.
- text: Refresh offer conditions in Shopify now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/offers'].post
update:
x-apievangelist-phrasing:
intent: Import Mirakl offers into Shopify
effect: write
questions:
- How do I import seller offers from Mirakl into Shopify?
- Do I need to trigger offer sync manually or does it run on a schedule?
instructions:
- text: Sync Mirakl offers changed since {sinceDate} into Shopify.
slots:
sinceDate: requestBody.sinceDate
- text: Run an offer import from Mirakl now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/orders'].post
update:
x-apievangelist-phrasing:
intent: Sync orders between Mirakl and Shopify
effect: write
questions:
- How do I force an order sync between Mirakl and Shopify?
- Can I resync orders from a specific date?
instructions:
- text: Sync orders since {sinceDate} between Mirakl and Shopify.
slots:
sinceDate: requestBody.sinceDate
- text: Run an order synchronization now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/promotions'].post
update:
x-apievangelist-phrasing:
intent: Sync Mirakl promotions into Shopify discounts
effect: write
questions:
- How do Mirakl promotions become Shopify code discounts?
- Can I resync promotions changed since a given date?
instructions:
- text: Sync promotions changed since {sinceDate} into Shopify.
slots:
sinceDate: requestBody.sinceDate
- text: Push Mirakl promotions to Shopify now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/returns'].post
update:
x-apievangelist-phrasing:
intent: Sync returns from Mirakl to Shopify
effect: write
questions:
- How do I bring Mirakl returns into Shopify?
- Can I resync returns from a given date?
instructions:
- text: Sync returns since {sinceDate} from Mirakl to Shopify.
slots:
sinceDate: requestBody.sinceDate
- text: Run a return synchronization now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/shipment-mirakl-to-shopify'].post
update:
x-apievangelist-phrasing:
intent: Sync shipments from Mirakl to Shopify
effect: write
questions:
- How do I update Shopify with shipments made by Mirakl sellers?
- Can I resync shipments created after a certain date?
instructions:
- text: Sync shipments since {sinceDate} from Mirakl to Shopify.
slots:
sinceDate: requestBody.sinceDate
- text: Run a shipment synchronization now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/shops'].post
update:
x-apievangelist-phrasing:
intent: Sync Mirakl shops into Shopify
effect: write
questions:
- How do I get Mirakl seller shops into Shopify?
- Can I resync only shops changed since a date?
instructions:
- text: Sync shops changed since {sinceDate} into Shopify.
slots:
sinceDate: requestBody.sinceDate
- text: Run a shop synchronization now.
method: generated
generated: '2026-09-26'
- target: $.paths['/api/sync/product-mirakl-to-shopify'].post
update:
x-apievangelist-phrasing:
intent: Import third-party products from Mirakl into Shopify
effect: write
questions:
- How do I import seller (third-party) products from Mirakl into Shopify?
- Does third-party product import run automatically on a schedule?
instructions:
- text: Import third-party products changed since {sinceDate} into Shopify.
slots:
sinceDate: requestBody.sinceDate
- text: Pull seller products from Mirakl into Shopify now.
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay 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 openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/mirakl-synchronization-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.