Mirakl

Mirakl Storefront API

The Storefront API from Mirakl — 13 operation(s) for storefront.

GitHub OpenAPI

Operations 13

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

POST /api/storefront/return Create a return from the storefront · CreateReturn - Create a return for an order #
Ask an LLM
“How can a shopper start a return for an order from my storefront?”
“Can a customer attach photos when requesting a return on the storefront?”
Tell an agent
Create a storefront return with request {returnRequest}.
Submit return request {returnRequest} with files {files}.
GET /api/storefront/evaluations/assessments Get seller evaluation criteria · GetEvaluationsAssessments - Get evaluations assessments #
Ask an LLM
“What criteria do customers rate sellers on in the storefront?”
“Can I get the evaluation assessments translated for a locale?”
Tell an agent
Get the evaluation assessments.
Show evaluation assessments in locale {locale}.
GET /api/storefront/returns/items-to-return Get returnable items for orders · GetItemsToReturn - Get items to return for a list of orders #
Ask an LLM
“Which items can a shopper still return from their orders?”
“Can I check return eligibility for several orders at once on the storefront?”
Tell an agent
Get items to return for orders {orderCommercialIds}.
Show what the customer can return from order {orderCommercialIds}.
GET /api/storefront/promotions Get promotions for offers · GetPromotions - Get promotions #
Ask an LLM
“Which promotions apply when a shopper buys a given offer?”
“Can the storefront show Mirakl promotions triggered by specific offers?”
Tell an agent
Get promotions triggered by offers {triggerOfferIds}.
List current storefront promotions.
GET /api/storefront/returns List a shopper's returns · GetReturns - List returns #
Ask an LLM
“Where can a customer see the status of returns they've started?”
“Can I list storefront returns for particular orders?”
Tell an agent
List storefront returns for orders {orderCommercialIds}.
Show the customer's existing returns.
GET /api/storefront/shipment Get shipment by Shopify fulfillment · GetShipment - Get shipment details by Shopify fulfillment ID #
Ask an LLM
“How do I get Mirakl shipment details from a Shopify fulfillment ID?”
“Where's the tracking for a marketplace shipment tied to a Shopify fulfillment?”
Tell an agent
Get the shipment for fulfillment {fulfillmentId}.
Show shipment details behind Shopify fulfillment {fulfillmentId}.
GET /api/storefront/orders/accounting-documents List accounting documents for orders · ListAccountingOrdersDocuments - List accounting orders documents #
Ask an LLM
“Where can a shopper download invoices for their marketplace orders?”
“Can I get secure download links for accounting documents on several orders?”
Tell an agent
List accounting documents for orders {orderIds}.
Get invoice download links for order {orderIds}.
GET /api/storefront/orders/documents List general documents for orders · ListOrdersDocuments - List orders documents #
Ask an LLM
“What non-accounting documents are attached to my marketplace orders?”
“Can a customer download general order documents like delivery notes?”
Tell an agent
List general order documents for orders {orderIds}.
Get download links for the non-invoice documents of order {orderIds}.
GET /api/storefront/products/offers List offers for product pages · ListProductOffers - List offers for each given product #
Ask an LLM
“How do I show all seller offers on a product detail page?”
“Can the product page offers be filtered by shipping zone?”
Tell an agent
List offers for products {productIds}.
Show PDP offers for {productIds} in locale {locale}.
GET /api/storefront/shop-ratings/{shopId} List a shop's customer ratings · ListShopEvaluations - List evaluations of a shop #
Ask an LLM
“What ratings and reviews have customers left for a seller?”
“Can I show a shop's evaluations on the storefront?”
Tell an agent
List evaluations for shop {shopId}.
Show customer ratings of seller {shopId}.
POST /api/storefront/graphql Send a GraphQL request to Mirakl · MiraklGraphQL - Forward request to Mirakl GraphQL API #
Ask an LLM
“Can my storefront query Mirakl through a GraphQL proxy?”
“Why can't I query additional fields through the storefront GraphQL endpoint?”
Tell an agent
Forward this GraphQL request to Mirakl.
Run the GraphQL request for a customer in country {X-Customer-Country}.
PUT /api/storefront/graphql/upload Upload a file via Mirakl GraphQL · MiraklGraphQLUpload - Forward file upload request to Mirakl GraphQL Upload API #
Ask an LLM
“How do I upload a file through the storefront GraphQL proxy?”
“Is there a separate endpoint for GraphQL file uploads?”
Tell an agent
Forward this file upload to the Mirakl GraphQL upload API.
Upload the attached file through GraphQL.
PUT /api/storefront/fulfillments/receive Confirm a fulfillment was received · ReceiveFulfillment - Confirm the reception of a fulfillment #
Ask an LLM
“How does a shopper confirm they received a marketplace delivery?”
“Can I mark a Shopify fulfillment as received on the Mirakl side?”
Tell an agent
Confirm reception of fulfillment {fulfillmentId}.
Mark fulfillment {fulfillmentId} as received by the customer.

Specifications

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

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-storefront-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-storefront-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '{% partial file="/partial-content/connector/operator/shopify/app-operator-shopify/rest/public/openapi-description.md" /%}'
  title: Shopify Operator Connector Storefront API
  version: ''
servers:
- description: Shopify production endpoint.
  url: https://operator-shpy.mirakl.net
tags:


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