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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Mirakl

Mirakl Storefront API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

13 operations 13 paths 37 schemas 9 GET2 POST2 PUT

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

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 9 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Storefront 13
POST
/api/storefront/return
CreateReturn - Create a return for an order
CreateReturn body → 200
GET
/api/storefront/evaluations/assessments
GetEvaluationsAssessments - Get evaluations assessments
GetEvaluationsAssessments 1 param → 200
GET
/api/storefront/returns/items-to-return
GetItemsToReturn - Get items to return for a list of orders
GetItemsToReturn 1 param → 200
GET
/api/storefront/promotions
GetPromotions - Get promotions
GetPromotions 1 param → 200
GET
/api/storefront/returns
GetReturns - List returns
GetReturns 1 param → 200
GET
/api/storefront/shipment
GetShipment - Get shipment details by Shopify fulfillment ID
GetShipment 1 param → 200
GET
/api/storefront/orders/accounting-documents
ListAccountingOrdersDocuments - List accounting orders documents
ListAccountingOrdersDocuments 1 param → 200
GET
/api/storefront/orders/documents
ListOrdersDocuments - List orders documents
ListOrdersDocuments 1 param → 200
GET
/api/storefront/products/offers
ListProductOffers - List offers for each given product
ListProductOffers 3 params → 200
GET
/api/storefront/shop-ratings/{shopId}
ListShopEvaluations - List evaluations of a shop
ListShopEvaluations 1 param → 200
POST
/api/storefront/graphql
MiraklGraphQL - Forward request to Mirakl GraphQL API
MiraklGraphQL 3 params → 200
PUT
/api/storefront/graphql/upload
MiraklGraphQLUpload - Forward file upload request to Mirakl GraphQL Upload API
MiraklGraphQLUpload → 200
PUT
/api/storefront/fulfillments/receive
ReceiveFulfillment - Confirm the reception of a fulfillment
ReceiveFulfillment 1 param → 200

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are ListProductOffers_Response_200_Products_Offers (26 properties), GetPromotions_Response_200_Promotions (18 properties), GetReturns_Response_200_Returns (16 properties), ListProductOffers_Response_200_Products_Offers_ShippingTypes (11 properties). Each schema is shown below with its type and property counts.

ListShopEvaluations_Response_200
object
2 properties
ListProductOffers_Response_200_Products_Offers_ShippingTypes
object
11 properties
ListAccountingOrdersDocuments_Response_200_Documents
object
5 properties
GetPromotions_Response_200_Promotions_PublicDescriptions
object
Promotion public description for a given locale
2 properties
ListProductOffers_Response_200
object
1 property
GetReturns_Response_200_Returns
object
Return details
16 properties 10 required
CreateReturn_Response_200
object
Response returned when a return is created
2 properties
GetItemsToReturn_Response_200_ItemsToReturn
object
Item available for return
6 properties 3 required
ListShopEvaluations_Response_200_Evaluations
object
10 properties 8 required
CreateReturn_Request_MultipartFormData_Returnrequest
object
5 properties 4 required
ListProductOffers_Response_200_Products_Offers_ShippingTypes_DeliveryTime
object
4 properties
GetPromotions_Response_200
object
Response containing storefront promotions
2 properties
ListShopEvaluations_Response_200_Evaluations_Reply
object
3 properties 3 required
GetPromotions_Response_200_Promotions_Medias
object
Promotion media asset for a given locale
2 properties
ListShopEvaluations_Response_200_Evaluations_Entity
object
3 properties 3 required
GetReturns_Response_200_Returns_ReturnAddress
object
Return address
6 properties 4 required
GetPromotions_Response_200_Promotions_Triggers
object
Promotion trigger condition
4 properties
GetReturns_Response_200_Returns_ReturnLines
object
Return line details
3 properties 2 required
GetReturns_Response_200
object
List of returns
1 property
ListShopEvaluations_Response_200_Evaluations_Assessments
object
3 properties
ListProductOffers_Response_200_Products_Offers_Fulfillment
object
1 property
ListProductOffers_Response_200_Products_Offers
object
26 properties
GetPromotions_Response_200_Promotions
object
Storefront promotion derived from Mirakl PR01
18 properties
GetReturns_Response_200_Returns_ReturnLines_Compliance
object
Return line compliance details
3 properties 1 required
GetReturns_Response_200_Returns_Documents
object
Return document
2 properties 2 required
CreateReturn_Request_MultipartFormData_Returnrequest_ReturnLines
object
Return creation return line request
2 properties 2 required
ListAccountingOrdersDocuments_Response_200
object
1 property 1 required
GetItemsToReturn_Response_200
object
Items available for return
1 property
ListProductOffers_Response_200_Products_Offers_EcoContributions
object
3 properties
ListOrdersDocuments_Response_200_Documents
object
5 properties
ListProductOffers_Response_200_Products
object
2 properties
GetReturns_Response_200_Returns_Tracking
object
Return tracking details
5 properties
GetPromotions_Response_200_Promotions_Campaign
object
Promotion campaign information
1 property
GetEvaluationsAssessments_Response_200
object
3 properties
ListProductOffers_Response_200_Products_Offers_Fulfillment_Center
object
1 property
ListOrdersDocuments_Response_200
object
1 property 1 required
GetShipment_Response_200
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-storefront-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
AE Profile APIs.io
Mirakl Catalog Configuration API
AE Profile APIs.io
Mirakl Incidents API
AE Profile APIs.io
Mirakl Invoicing and Accounting API
AE Profile APIs.io
Mirakl Messages API
AE Profile APIs.io
Mirakl Multiple shipments API
AE Profile APIs.io
Mirakl Offers API
AE Profile APIs.io
Mirakl Orders API
AE Profile APIs.io
Mirakl Picklists API
AE Profile APIs.io
Mirakl Platform Settings API
AE Profile APIs.io
Mirakl Product Feedback API
AE Profile APIs.io
Mirakl Products API
AE Profile APIs.io
#Storefront
← Back to M APIs
API Details
ID
mirakl:mirakl-storefront-api
Base URL
https://your-instance.mirakl.net
Docs
https://developer.mirakl.com/content/product/mmp/rest/seller/openapi3
Provider
Mirakl
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mirakl-storefront-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mirakl-storefront-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

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