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

Mirakl Stores API

The Stores API from Mirakl — 5 operation(s) for stores.

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

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

This API exposes 7 operations across 5 paths, and defines 91 schemas. It is described by OpenAPI 3.2.0.

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

7 operations 5 paths 91 schemas 1 DELETE4 GET1 POST1 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, OAuth 2.0, HTTP Bearer, API Key, HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 8

Mirakl Stores API declares 8 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token). It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token). An API key is passed in the header as Authorization (Shop-API-Key). It accepts HTTP bearer tokens (JWT) (operator_bearer_token). An API key is passed in the header as Authorization (shop_api_key). An API key is passed in the header as Authorization (front_api_key). An API key is passed in the header as Authorization (operator_api_key).

  • OAuth-2 — For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Stores 7
GET
/api/shops/documents
S30 - List shop's documents
S30 3 params → 200
POST
/api/shops/documents
S32 - Upload business documents to associate with a shop
S32 body → 200
GET
/api/shops/documents/download
S31 - Download documents for one or multiple shops
S31 3 params → 200
DELETE
/api/shops/documents/{document_id}
S33 - Delete a shop document
S33 1 param → 204
GET
/api/account
A01 - Get shop information
A01 1 param → 200
PUT
/api/account
A02 - Update shop information
A02 1 param body → 200
GET
/api/account/statistics
A21 - Get shop statistics
A21 3 params → 200

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are A01_Response_200 (45 properties), A02_Response_200_Updated (22 properties), A21_Response_200 (22 properties), A02_Request (17 properties). Each schema is shown below with its type and property counts.

S32_Request_MultipartFormData_ShopDocuments_ShopDocuments
object
Shop documents
2 properties 2 required
S32_Response_200
object
2 properties 1 required
S30_Response_200
object
2 properties 1 required
S32_Response_200_Documents_Errors
object
3 properties 3 required
S32_Request_MultipartFormData_ShopDocuments
object
1 property 1 required
S30_Response_200_ShopDocuments
object
6 properties 4 required
S32_Response_200_Documents
object
1 property 1 required
A01_Response_200_PaymentDetails_SubBalances
object
4 properties 4 required
A01_Response_200_DefaultBillingInformation_CorporateInformation
object
5 properties
A01_Response_200_DefaultBillingInformation_RegistrationAddress
object
6 properties 3 required
A21_Response_200_ApprovalDelay
object
2 properties
A01_Response_200_BillingInfo
object
7 properties
A21_Response_200_AverageCartWithShipping
object
2 properties
A01_Response_200
object
45 properties 24 required
A01_Response_200_ApplicableTaxes
object
3 properties 2 required
A02_Response_200_Updated_SpecificBillingInformations
object
6 properties 2 required
A01_Response_200_ShopAdditionalFields
object
2 properties 1 required
A01_Response_200_DefaultBillingInformation
object
7 properties 3 required
A21_Response_200_ConsecutiveRefusedOrdersCount
object
2 properties
A21_Response_200_ApprovalRate
object
2 properties
A21_Response_200_LateShipmentRate
object
2 properties
A21_Response_200_ShippingDelay
object
2 properties
A21_Response_200_CancelationRate
object
2 properties
A02_Response_200_Updated_Address
object
11 properties
A02_Response_200_Updated_SpecificBillingInformations_RegistrationAddress
object
6 properties 3 required
A01_Response_200_ProDetails
object
4 properties
A01_Response_200_DefaultBillingInformation_FiscalRepresentative
object
12 properties 8 required
A02_Response_200_Updated_DefaultBillingInformation
object
7 properties 3 required
A21_Response_200_OrdersCount
object
2 properties
A02_Request
object
17 properties
A02_Response_200_Errors
object
3 properties 3 required
A01_Response_200_ContactInformations
object
14 properties 5 required
A01_Response_200_SpecificBillingInformations_CorporateInformation
object
5 properties
A01_Response_200_SpecificBillingInformations_PersonalInformation
object
6 properties
A02_Response_200_Updated_SpecificBillingInformations_PersonalInformation
object
6 properties
A21_Response_200_AverageCart
object
2 properties
A01_Response_200_PaymentDetails
object
6 properties 3 required
A02_Request_ShopAdditionalFields
object
Additional fields of the shop. Note that if the 'value' field in the child structure is absent, the corresponding additional field value will be removed for th…
2 properties 1 required
A01_Response_200_PaymentInfo
object
2 properties 1 required
A01_Response_200_ProducerIdentifiers
object
2 properties 2 required
A21_Response_200_AutoRefusedRate
object
2 properties
A01_Response_200_SpecificBillingInformations_CorporateInformation_ComplementaryInformation
object
9 properties
A01_Response_200_SpecificBillingInformations
object
6 properties 2 required
A01_Response_200_Dropship
object
1 property 1 required
A02_Request_PaymentInfo
object
Payment information of the shop. Nullable.
2 properties 1 required
A01_Response_200_SpecificBillingInformations_RegistrationAddress
object
6 properties 3 required
A02_Response_200_Updated_SpecificBillingInformations_FiscalInformation
object
3 properties
A01_Response_200_DefaultBillingInformation_PersonalInformation
object
6 properties
A21_Response_200_RefundRate
object
2 properties
A21_Response_200
object
22 properties
A21_Response_200_OffersCount
object
2 properties
S30_Response_200_ShopDocuments_2
object
4 properties 3 required
A01_Response_200_Shipping
object
1 property
A01_Response_200_DefaultBillingInformation_FiscalInformation
object
3 properties
A01_Response_200_DefaultBillingInformation_CorporateInformation_ComplementaryInformation
object
9 properties
A01_Response_200_Shippings
object
7 properties 4 required
S30_Response_200_2
object
2 properties 1 required
A02_Response_200
object
2 properties
A02_Response_200_Updated_DefaultBillingInformation_FiscalRepresentative
object
12 properties 8 required
A02_Response_200_Updated_Shipping
object
1 property
A02_Response_200_Updated_ProducerIdentifiers
object
2 properties 2 required
A02_Response_200_Updated_PaymentInfo
object
2 properties 1 required
A02_Response_200_Updated_DefaultBillingInformation_CorporateInformation
object
5 properties
A01_Response_200_SpecificBillingInformations_FiscalRepresentative
object
12 properties 8 required
A01_Response_200_Shippings_AdditionalFields
object
2 properties 1 required
A02_Request_ProDetails
object
Professional details of the shop. Updated and not nullable if shop is declared as professional.
3 properties
A02_Request_Address
object
The address of the shop. Cannot be null.
11 properties
A01_Response_200_SpecificBillingInformations_FiscalInformation
object
3 properties
A02_Response_200_Updated_DefaultBillingInformation_FiscalInformation
object
3 properties
A21_Response_200_ReturnRate
object
2 properties
A02_Response_200_Updated_SpecificBillingInformations_CorporateInformation_ComplementaryInformation
object
9 properties
A02_Request_ProducerIdentifiers
object
List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection rela…
2 properties 2 required
A02_Response_200_Updated_ShopAdditionalFields
object
2 properties 1 required
A02_Response_200_Updated_ProDetails
object
3 properties
A01_Response_200_Kyc
object
2 properties 1 required
A02_Response_200_Updated_DefaultBillingInformation_PersonalInformation
object
6 properties
A02_Response_200_Updated
object
22 properties
A02_Response_200_Updated_DefaultBillingInformation_RegistrationAddress
object
6 properties 3 required
A21_Response_200_TotalRevenue
object
2 properties
A21_Response_200_IncidentRate
object
2 properties
A02_Response_200_Updated_SpecificBillingInformations_CorporateInformation
object
5 properties
A21_Response_200_EvaluationsCount
object
2 properties
A21_Response_200_Grade
object
2 properties
A02_Response_200_Updated_SpecificBillingInformations_FiscalRepresentative
object
12 properties 8 required
A02_Response_200_Updated_DefaultBillingInformation_CorporateInformation_ComplementaryInformation
object
9 properties
A21_Response_200_ValidTrackingRate
object
2 properties
A21_Response_200_OrderMessagesResponseDelay
object
2 properties
S30_Response_200_ShopDocuments_3
object
4 properties 3 required
S30_Response_200_3
object
2 properties 1 required
S30_Response_200_ShopDocuments_4
object
4 properties 3 required
S30_Response_200_4
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-stores-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
Mirakl Catalog Configuration API
Mirakl Incidents API
Mirakl Invoicing and Accounting API
Mirakl Messages API
Mirakl Multiple shipments API
Mirakl Offers API
Mirakl Orders API
Mirakl Picklists API
Mirakl Platform Settings API
Mirakl Product Feedback API
Mirakl Products API
Where this information came from

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