Mirakl

Mirakl Orders API

The Orders API from Mirakl — 34 operation(s) for orders.

GitHub OpenAPI

Operations 47

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /v1/orders/documents/{channel_document_id} Delete a channel order document from Connect · deleteOrderDocument - Delete order document #
Ask an LLM
“Can I remove a document I previously pushed to Mirakl Connect for a channel order?”
“What do I need to send to delete a channel order document from Connect?”
Tell an agent destructive · confirm first
Delete Connect channel document {channel_document_id} sent from origin {origin}.
Remove the channel-side order document {channel_document_id} from Mirakl Connect.
PUT /v1/orders/actions/{action_id} Report the final outcome of an async order action · updateActionStatus - Update asynchronous action status #
Ask an LLM
“How do I tell Mirakl Connect that an asynchronous command event action succeeded or failed?”
“Can I attach error details when reporting a failed asynchronous action back to Connect?”
Tell an agent
Mark asynchronous action {action_id} as {status}.
Report action {action_id} as FAILURE with errors {errors}.
PUT /v1/orders/anonymize-after Set when Connect should anonymize orders · updateAnonymizeAfterDate - Update anonymization date for orders #
Ask an LLM
“How do I tell Mirakl Connect after which date my orders should be anonymized?”
“Is order anonymization in Connect reversible once the date passes?”
Tell an agent destructive · confirm first
Set the anonymize-after date for these orders: {orders}.
Schedule customer data anonymization in Connect for orders {orders}.
POST /v1/orders/{channel_order_id}/documents Upload a document to a channel order in Connect · uploadOrderDocument - Upload order document #
Ask an LLM
“How do I attach a document to a channel order using its channel order ID in Mirakl Connect?”
“Can I upload a document for a return linked to a channel order?”
Tell an agent
Upload {file} with metadata {metadata} to channel order {channel_order_id} from origin {origin}.
Attach a document to channel order {channel_order_id} in Connect.
POST /v1/orders Push channel orders into Mirakl Connect · upsertOrders - Upsert orders #
Ask an LLM
“How do I synchronize orders from my sales channel into Mirakl Connect?”
“What happens if one order in an order upsert batch is invalid?”
Tell an agent
Upsert these channel orders into Connect from origin {origin}: {orders}.
Sync the latest full versions of orders {orders} to Mirakl Connect.
PUT /orders/{order_id}/accept Accept or refuse Connect order lines (original) · acceptOrderLines - Accept or refuse order lines #
Ask an LLM
“Which endpoint do I use to accept or refuse Connect order lines synchronously, the original non-v2 one?”
“Can I refuse some lines of a Connect order that is awaiting acceptance using the first-version accept call?”
Tell an agent
Using the original accept endpoint, accept or refuse lines {order_lines} on Connect order {order_id}.
Synchronously accept all awaiting lines of Connect order {order_id} with the v1 call.
GET /orders List Mirakl Connect orders (original version) · listOrders - List Mirakl Connect orders #
Ask an LLM
“How do I pull Connect orders updated since my last sync using the original orders list?”
“Can I filter the first-version Connect order list by fulfillment type?”
Tell an agent
With the original Connect orders list, fetch orders updated since {updated_from}.
List v1 Connect orders with statuses {statuses}.
PUT /v2/orders/{order_id}/accept Accept or refuse Connect order lines (v2) · v2-acceptOrderLines - Accept or refuse order lines #
Ask an LLM
“How do I accept or refuse Connect order lines with the v2 asynchronous accept endpoint?”
“Does the v2 accept call also sync the line status back to the sales channel?”
Tell an agent
Using v2, accept or refuse order lines {order_lines} on Connect order {order_id}.
Send a v2 acceptance decision for every awaiting line of Connect order {order_id}.
POST /v2/orders/{order_id}/cancel Cancel lines of a Connect order · v2-cancelOrderLines - Cancel order lines #
Ask an LLM
“Can I cancel only part of a Mirakl Connect order rather than all of it?”
“What is the v2 call for cancelling Connect order lines?”
Tell an agent destructive · confirm first
Cancel lines {cancelations} of Connect order {order_id}.
Cancel every line on Connect order {order_id} via v2.
GET /v2/orders/{order_id}/documents Download documents from one Connect order · v2-downloadOrderDocuments - Download documents from an order #
Ask an LLM
“How do I download the documents attached to a single Connect order?”
“Can I download only certain document types, like return labels, from one Connect order?”
Tell an agent
Download the documents of Connect order {order_id}.
Download documents of type {types} from Connect order {order_id}.
POST /v2/orders/{order_id}/documents Upload a return label or invoice to a Connect order · v2-uploadOrderDocument - Upload a document for an order #
Ask an LLM
“How do I upload a customer invoice to a Connect order by its Mirakl order ID?”
“Which document types does the v2 Connect order document upload accept?”
Tell an agent
Upload {file} as a v2 document with metadata {metadata} to Connect order {order_id}.
Attach a return label to Connect order {order_id} using v2.
GET /v2/orders/actions/{action_id} Check the status of an async Connect order action · v2-getActionStatus - Track an asynchronous action request #
Ask an LLM
“How can I tell whether my asynchronous accept request on a Connect order finished?”
“Where do I see errors raised while Connect processed an order action request?”
Tell an agent
Check the status of Connect action request {action_id}.
Show any processing errors for action {action_id}.
GET /v2/orders/tracking/{tracking_id} Get a Connect action result by tracking ID (deprecated) · v2-getOrderTracking - Retrieve tracking information #
Ask an LLM
“Is the Connect order tracking-ID lookup still supported or deprecated?”
“Can I still look up an old order request result using its tracking ID?”
Tell an agent
Look up deprecated tracking result {tracking_id} for a Connect order request.
Use the legacy tracking endpoint to fetch request {tracking_id}.
GET /v2/orders/documents List documents across Connect orders · v2-listOrderDocuments - List documents #
Ask an LLM
“How do I list documents across all my Connect orders, newest first?”
“Can I list only Connect order documents updated after a certain date?”
Tell an agent
List Connect order documents updated since {updated_from}.
List documents of type {types} for Connect orders {order_ids}.
GET /v2/orders List Mirakl Connect orders (v2) · v2-listOrders - List Mirakl Connect orders #
Ask an LLM
“What is the v2 way to list Mirakl Connect orders for syncing into my system?”
“Can I page through v2 Connect orders by status and last update time?”
Tell an agent
With the v2 orders list, fetch Connect orders updated since {updated_from}.
List v2 Connect orders {order_ids}.
POST /v2/orders/{order_id}/refund Refund lines of a Connect order · v2-refundOrderLines - Refund order lines #
Ask an LLM
“How do I refund some or all lines of a Mirakl Connect order?”
“Is there a v2 Connect call for issuing order line refunds?”
Tell an agent
Refund lines {refunds} on Connect order {order_id}.
Issue a v2 refund for every line of Connect order {order_id}.
POST /v2/orders/actions Log order action results and errors to Connect · v2-reportOrderActions - Log order action results and errors #
Ask an LLM
“How does my connector report back-order sync results and errors to Mirakl Connect?”
“Can I get a centralized view in Connect of errors from actions my system ran on orders?”
Tell an agent
Log these order action results in Connect: {actions}.
Report the failed order sync actions {actions} to Connect.
PUT /api/orders Update order fields in bulk · OR04 - Patch update orders #
Ask an LLM
“Can I update just a few fields on marketplace orders without resending everything?”
“How many orders can I patch in one OR04 call?”
Tell an agent
Patch these marketplace orders field by field: {orders}.
Clear a field on orders {orders} by sending it as null.
GET /api/orders List marketplace orders with filters · OR11 - List orders with pagination #
Ask an LLM
“How do I list marketplace orders by state and creation date through OR11?”
“Can I filter marketplace orders to those with an open incident or awaiting tax confirmation?”
Tell an agent
List marketplace orders in states {order_state_codes}.
List orders for shop {shop_ids} created between {start_date} and {end_date}.
PUT /api/orders/shipping_from Update the ship-from origin of order lines · OR07 - Update order line shipping origin #
Ask an LLM
“How do I change where marketplace order lines ship from?”
“How many order lines can I update shipping origin for at once?”
Tell an agent
Set the shipping origin on order lines {order_lines}.
Update shipping_from details for these lines: {order_lines}.
GET /api/orders/{order_id} Get one marketplace order (deprecated) · OR12 - Get information about an order #
Ask an LLM
“Is the single marketplace order lookup by ID deprecated?”
“Can I still fetch one order's details directly by its order ID with OR12?”
Tell an agent
Get marketplace order {order_id} using the deprecated single-order call.
Show the details of order {order_id} via OR12.
POST /api/orders/async-export Start an asynchronous bulk order export · OR13 - Export orders asynchronously #
Ask an LLM
“How do I export a very large number of marketplace orders without paginating?”
“Can I split an asynchronous order export into chunked files?”
Tell an agent
Start an async export of orders created between {start_date} and {end_date}.
Export orders updated since {start_update_date} in chunks of {items_per_chunk} items.
GET /api/orders/async-export/status/{tracking_id} Check the status of an order export · OR14 - Get the status of an asynchronous order export #
Ask an LLM
“How do I know when my asynchronous order export has completed?”
“Where do I get the file URLs for a finished order export?”
Tell an agent
Check the status of order export {tracking_id}.
Get the download URLs for completed export {tracking_id}.
GET /dynamic-url/The+URL+is+retrieved+from+OR14+output/OR15 Download an order export file chunk · OR15 - Retrieve order export files once asynchronous export is complete (OR13) #
Ask an LLM
“How do I retrieve the actual order export files once the export is done?”
“Can I download each chunk of a completed order export separately?”
Tell an agent
Download the order export chunk from the URL the export status returned.
Fetch each file of my completed order export.
PUT /api/orders/{order_id}/accept Accept or refuse marketplace order lines as seller · OR21 - Accept or refuse order lines #
Ask an LLM
“As a seller, how do I accept or refuse order lines that are waiting for acceptance in OR21?”
“What error do I get if the marketplace order is not in the right state to accept?”
Tell an agent
As the shop, accept or refuse lines {order_lines} on marketplace order {order_id}.
Accept all waiting lines of seller order {order_id} with OR21.
PUT /api/orders/{order_id}/tracking Set carrier tracking for an order · OR23 - Update carrier tracking information for a specific order #
Ask an LLM
“How do I add a tracking number and carrier to a marketplace order?”
“Can I give a full tracking URL when the carrier isn't registered on the platform?”
Tell an agent
Set tracking number {tracking_number} with carrier {carrier_code} on order {order_id}.
Add tracking URL {carrier_url} for carrier {carrier_name} to order {order_id}.
PUT /api/orders/{order_id}/ship Confirm an order has shipped · OR24 - Validate the shipment of an order #
Ask an LLM
“How do I mark a marketplace order in SHIPPING status as shipped?”
“Does validating an order shipment need a request body?”
Tell an agent
Validate the shipment of order {order_id}.
Mark marketplace order {order_id} as shipped.
PUT /api/orders/{order_id}/cancel Cancel an entire marketplace order · OR29 - Perform a full cancelation of an order #
Ask an LLM
“How do I cancel a whole marketplace order at once?”
“Is there a single call to fully cancel an order rather than line by line?”
Tell an agent destructive · confirm first
Fully cancel marketplace order {order_id}.
Cancel every line of order {order_id} in one go with OR29.
PUT /api/orders/cancel Cancel specific marketplace order lines · OR30 - Perform cancelations on order lines #
Ask an LLM
“Can a shop cancel individual lines across marketplace orders?”
“When is a seller allowed to cancel an order line under pay-on-delivery workflows?”
Tell an agent destructive · confirm first
Cancel these marketplace order lines: {cancelations}.
Cancel lines {cancelations} using tax mode {order_tax_mode}.
PUT /api/orders/{order_id}/additional_fields Update custom fields on an order · OR31 - Update the custom fields of an order and its order lines #
Ask an LLM
“How do I set custom field values on a marketplace order and its lines?”
“Can I clear a custom field on an order, and what about required ones?”
Tell an agent
Update custom fields {order_additional_fields} on order {order_id}.
Set order line custom fields {order_lines} on order {order_id}.
GET /api/orders/{order_id}/messages List messages on an order (deprecated) · OR41 - List messages of an order #
Ask an LLM
“How do I see the messages exchanged on a marketplace order?”
“Can I list only the messages I received on an order?”
Tell an agent
List messages on order {order_id}.
Show only received messages ({received}) for order {order_id}.
GET /api/orders/{order_id}/evaluation Get the customer evaluation of an order · OR51 - Get the evaluation of an order #
Ask an LLM
“How do I see the rating a customer left on a product marketplace order?”
“Where can I read the evaluation for an order I shipped?”
Tell an agent
Get the evaluation for marketplace order {order_id}.
Show the customer rating on product order {order_id}.
GET /api/orders/documents List documents attached to marketplace orders · OR72 - Lists order's documents #
Ask an LLM
“Which documents are attached to a given marketplace order?”
“Can I list the documents for several seller orders in one call?”
Tell an agent
List the documents on marketplace orders {order_ids}.
Show what documents seller order {order_ids} has.
GET /api/orders/documents/download Download marketplace order documents · OR73 - Download one or multiple documents attached to one or multiple orders #
Ask an LLM
“How do I download all documents from several marketplace orders as a ZIP?”
“Can I download a single order document without it being zipped?”
Tell an agent
Download documents {document_ids} from marketplace orders.
Download all documents from seller orders {order_ids}.
POST /api/orders/{order_id}/documents Upload documents to a marketplace order · OR74 - Upload documents to attach to an order #
Ask an LLM
“Which file types can I attach to a marketplace order, and how many?”
“Can I upload several documents to one seller order in one request?”
Tell an agent
Upload files {files} described by {order_documents} to marketplace order {order_id}.
Attach a PDF invoice to seller order {order_id}.
GET /api/orders/taxes List the order taxes on the platform · OR75 - List all the order taxes available on the platform #
Ask an LLM
“What order taxes are configured on the marketplace?”
“Where can I get the list of tax codes I can use on orders?”
Tell an agent
List all order taxes available on the platform.
Show me the order tax codes.
DELETE /api/orders/documents/{document_id} Delete a marketplace order document · OR76 - Delete an order document #
Ask an LLM
“How do I remove a document I attached to a marketplace order?”
“Can I delete a single seller order document by its ID?”
Tell an agent destructive · confirm first
Delete marketplace order document {document_id}.
Remove attached order document {document_id}.
PUT /api/orders/{order_id}/refund Refund lines of one order (deprecated) · OR26 - Perform a refund of order lines of an order #
Ask an LLM
“Is the per-order refund endpoint for marketplace orders deprecated?”
“Can I still refund lines of a single order with the older OR26 call?”
Tell an agent
Using the deprecated per-order refund, refund lines {order_lines} of order {order_id}.
Refund order {order_id} lines for shop {shop_id} via OR26.
PUT /api/orders/refund Refund marketplace order lines · OR28 - Perform refunds on order lines #
Ask an LLM
“How do I refund order lines across marketplace orders as a seller?”
“Can I choose the tax mode when refunding order lines?”
Tell an agent
Refund these marketplace order lines: {refunds}.
Issue refunds {refunds} for shop {shop_id} with tax mode {order_tax_mode}.
PUT /api/orders/adjust Adjust the measured quantity of an order line · OR32 - Adjust order line #
Ask an LLM
“Can I adjust an order line's actual weight or measurement after picking?”
“What happens if the adjusted measurement equals what was ordered?”
Tell an agent
Adjust the actual measurement on order lines {order_lines}.
Adjust order lines {order_lines} for shop {shop_id}.
PUT /api/mms/orders/{order_id} Update a service order · SOR04 - Update an order #
Ask an LLM
“How do I change the price or booking on a service order?”
“Can I update a service order that is already closed or cancelled?”
Tell an agent
Update the price of service order {order_id} to {price}.
Change the booking on service order {order_id} to {booking}.
GET /api/mms/orders List service orders · SOR11 - List orders #
Ask an LLM
“How do I list service orders by state or service code?”
“Can I find refunded service orders or ones with an open incident?”
Tell an agent
List service orders in state {state}.
List service orders for service {service_code} created after {date_created_start}.
PUT /api/mms/orders/{order_id}/accept Accept a service order · SOR21 - Accept an order #
Ask an LLM
“How do I accept a service order that is waiting for acceptance?”
“Can a shop accept a whole service order in one call?”
Tell an agent
Accept service order {order_id}.
Accept service order {order_id} for shop {shop_id}.
PUT /api/mms/orders/{order_id}/refuse Refuse a service order · SOR22 - Refuse an order #
Ask an LLM
“How do I decline a service order waiting for my acceptance?”
“Can a shop refuse a service order it cannot fulfil?”
Tell an agent destructive · confirm first
Refuse service order {order_id}.
Decline service order {order_id} for shop {shop_id}.
PUT /api/mms/orders/{order_id}/consume Mark a service order as consumed · SOR25 - Consume an order #
Ask an LLM
“How do I record that a customer used their service order?”
“Can I pass a voucher code when consuming a pending service order?”
Tell an agent
Consume service order {order_id} with voucher {voucher_code}.
Mark service order {order_id} consumed on {date_consumed}.
PUT /api/mms/orders/{order_id}/refund Request a refund on a service order · SOR28 - Request refund on order #
Ask an LLM
“How do I refund an amount on a service order?”
“Does a service order refund need a reason code and currency?”
Tell an agent
Refund {amount} {currency_code} on service order {order_id} for reason {reason_code}.
Request a refund on service order {order_id}.
GET /api/mms/orders/{order_id}/evaluation Get the evaluation of a service order · SOR51 - Get the evaluation of an order #
Ask an LLM
“Where can I see the customer's evaluation of a service order?”
“Did the customer rate the service they booked?”
Tell an agent
Get the evaluation of service order {order_id}.
Show the rating on service order {order_id} for shop {shop_id}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-orders-api-openapi.yml

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/_original/mirakl-connect-channel-webhooks-openapi.yaml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mirakl:mirakl-orders-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

mirakl-orders-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mirakl Orders API
  version: ''
  description: 'Operations tagged Orders across 5 of this provider''s published API definitions: mirakl-connect-channel-openapi.json, mirakl-connect-openapi.yaml, mirakl-mmp-front-openapi.yaml, mirakl-mmp-seller-openapi.json, mirakl-mms-seller-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: Connect Channel Platform API
  url: https://miraklconnect.com/api/channel-platform
- description: Connect Production endpoint
  url: https://miraklconnect.com/api
- description: URL to be replaced by your Mirakl instance URL
  url: https://your-instance.mirakl.net
tags:


# --- truncated at 32 KB (916 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-orders-api-openapi.yml