Mirakl Connect connector

Updated May 26, 20262 min read

Use this connector if you're a seller selling on Mirakl marketplaces and want to fulfill those orders through Carriyo. Carriyo polls the Mirakl Connect aggregator every five minutes for FULFILLED_BY_SELLER orders and brings them in as Orders. Carriyo auto-accepts or refuses items based on your inventory, and pushes labels and cancellations back to Mirakl Connect.

If you operate a Mirakl-powered marketplace and want to manage shipping on behalf of your sellers, use the Mirakl connector instead.

Capabilities

  • Order ingestion. Polls every five minutes for orders updated since the last sync.
  • Auto-accept on inventory. AWAITING_ACCEPTANCE lines are auto-accepted when Carriyo holds enough inventory at a mapped warehouse, or refused otherwise. Configurable per tenant.
  • Outbound label. On Carriyo's default_label_update webhook, the connector posts the shipment and uploads the label PDF (DELIVERY_SLIP) and the optional commercial invoice (CUSTOMER_INVOICE).
  • Outbound cancellation. On Carriyo's order- or fulfillment-order-line cancellation webhooks, the connector sends the cancellation to Mirakl Connect.
  • On-demand inventory sync. A Dashboard "Sync Inventory Now" button kicks off an async inventory sync per warehouse mapping.

Setup

Configure in the Carriyo Dashboard under Connectors → Mirakl Connect.

  • Base URL: defaults to https://miraklconnect.com/api.
  • Client ID and Client Secret: Mirakl Connect OAuth credentials. The connector uses the client_credentials grant with the Seller Company ID as the audience claim.
  • Seller Company ID: your Mirakl Connect seller company identifier.
  • Auto Accept AWAITING_ACCEPTANCE: default on.
  • Auto Detect Item Origin Country: optional.
  • Warehouse Mapping: Mirakl warehouse codes to Carriyo locations. Used by the inventory sync.

Data mapping

Mirakl ConnectCarriyo
order.idreferences.partner_order_reference
order_lines (keyed by line.id)order line_items
product.id or channel_order_line_idsku
product.titledescription
shipping_info.addressshipping_address and customer
billing_info.addressbilling_address

The connector stamps mirakl_connect_order_id, channel_order_id, mirakl_connect_channel_id, and mirakl_connect_channel_store_id into carriyo_metadata so later updates from Mirakl Connect can be reconciled.

Cancellation reason mapping: Carriyo's CUSTOMER_CANCELLATION becomes Mirakl Connect's CUSTOMER_CANCELATION; INVENTORY_OUT_OF_STOCK becomes OUT_OF_STOCK; everything else collapses to AGREEMENT.

Limits and cadence

  • Cadence. Order sync runs every five minutes. Inventory sync runs only on demand (the Dashboard button). Outbound calls fire on Carriyo webhook triggers.
  • Per-run cap. 1000 orders per run, 100 per page.
  • Overlap window. Each run overlaps the previous by two minutes to avoid missing late updates.
  • Async actions. Outbound posts use Mirakl Connect's async action API. The connector polls the action up to 12 times at one-second intervals. If the action does not complete in that window, the post is marked failed.
  • Skipped scope. Orders with FULFILLED_BY_PARTNER are skipped. They belong to a different fulfillment path.