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 Public API

The Public API from Mirakl — 2 operation(s) for public.

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

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

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

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

2 operations 2 paths 58 schemas 2 POST

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

Paths & Operations 2

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

Public 2
POST
/api/public/checkout-data
GetCheckoutData - Get checkout data
GetCheckoutData body → 200
POST
/api/public/shipping-feesdeprecated
GetShippingFees - Get shipping fees
GetShippingFees body → 200

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are GetCheckoutData_Request_ShippingAddress (12 properties), GetShippingFees_Request_ShippingAddress (12 properties), GetCheckoutData_Request_CartLines_Merchandise (10 properties), GetCheckoutData_Request_CartLines_LineComponents_Merchandise (10 properties). Each schema is shown below with its type and property counts.

GetCheckoutData_Request_CartLines_Merchandise_SelectedOptions
object
A product option applied to the variant
2 properties 2 required
GetCheckoutData_Request_CartLines_Merchandise_Product
object
The product object
3 properties 3 required
GetShippingFees_Request_CartLines_Attributes
object
The custom attribute
2 properties 2 required
GetCheckoutData_Request_CartLines_Cost_TotalAmount
object
The monetary value with currency
2 properties 2 required
GetCheckoutData_Request_CartLines_Attributes
object
The custom attribute
2 properties 2 required
GetCheckoutData_Request_CartLines
object
The line containing information about the items the customer intends to purchase
7 properties 7 required
GetShippingFees_Response_200_Fees
object
Shipping charges per seller
5 properties
GetShippingFees_Response_200_Fees_Choices
object
Shipping method
5 properties
GetCheckoutData_Request_CartLines_DiscountAllocations
object
The discounts applied to the cart line
4 properties 2 required
GetCheckoutData_Request_CartLines_DiscountAllocations_DiscountedAmount
object
The monetary value with currency
2 properties 2 required
GetCheckoutData_Request_CartLines_LineComponents_Merchandise
object
The merchandise
10 properties 7 required
GetCheckoutData_Request_CartLines_LineComponents_Merchandise_Image
object
The image details
2 properties 1 required
GetCheckoutData_Response_200
object
Checkout data per seller
2 properties
GetShippingFees_Request
object
Request object to retrieve shipping fees
3 properties 1 required
GetShippingFees_Request_CartLines_Merchandise_Product
object
The product object
3 properties 3 required
GetShippingFees_Request_CartLines_LineComponents_Merchandise_Image
object
The image details
2 properties 1 required
GetCheckoutData_Response_200_Sellers_Offers_Promotions_Configuration
object
Configuration used to calculate the applied promotion
6 properties
GetCheckoutData_Request_CartLines_LineComponents
object
The sub lines of the merchandise line
6 properties 6 required
GetCheckoutData_Request_CartLines_LineComponents_Merchandise_SellingPlan
object
The selling plan
1 property 1 required
GetShippingFees_Request_CartLines_LineComponents_Attributes
object
The custom attribute
2 properties 2 required
GetCheckoutData_Request_CartLines_LineComponents_Cost_TotalAmount
object
The monetary value with currency
2 properties 2 required
GetShippingFees_Request_CartLines_LineComponents_Merchandise
object
The merchandise
10 properties 7 required
GetShippingFees_Response_200
object
Shipping charges per seller
2 properties
GetShippingFees_Request_ShippingAddress
object
The shipping address
12 properties
GetCheckoutData_Request_CartLines_Merchandise_Image
object
The image details
2 properties 1 required
GetShippingFees_Request_CartLines
object
The line containing information about the items the customer intends to purchase
7 properties 7 required
GetCheckoutData_Request_CartLines_Merchandise_SellingPlan
object
The selling plan
1 property 1 required
GetCheckoutData_Response_200_Sellers_Offers
object
Offer details
8 properties
GetShippingFees_Request_CartLines_LineComponents_Cost_TotalAmount
object
The monetary value with currency
2 properties 2 required
GetCheckoutData_Response_200_Sellers
object
Shipping charges per seller
5 properties
GetCheckoutData_Response_200_Errors
object
Checkout error
2 properties
GetShippingFees_Request_CartLines_Merchandise_SellingPlan
object
The selling plan
1 property 1 required
GetCheckoutData_Request_CartLines_LineComponents_Merchandise_Product
object
The product object
3 properties 3 required
GetShippingFees_Request_CartLines_Merchandise_SelectedOptions
object
A product option applied to the variant
2 properties 2 required
GetCheckoutData_Response_200_Sellers_Choices
object
Shipping method
5 properties
GetShippingFees_Request_CartLines_Merchandise_Image
object
The image details
2 properties 1 required
GetShippingFees_Request_CartLines_Merchandise
object
The merchandise
10 properties 7 required
GetCheckoutData_Request_CartLines_LineComponents_Merchandise_SelectedOptions
object
A product option applied to the variant
2 properties 2 required
GetCheckoutData_Request_ShippingAddress
object
The shipping address
12 properties
GetCheckoutData_Request_CartLines_Cost
object
The details about the cost components attributed to the cart line
1 property 1 required
GetShippingFees_Request_CartLines_LineComponents_Merchandise_Product
object
The product object
3 properties 3 required
GetCheckoutData_Request_CartLines_Merchandise
object
The merchandise
10 properties 7 required
GetCheckoutData_Request_CartLines_LineComponents_Cost
object
The details about the cost components attributed to the cart line
1 property 1 required
GetCheckoutData_Response_200_Sellers_Offers_Promotions_Campaign
object
Promotion campaign information
1 property
GetShippingFees_Request_CartLines_Cost
object
The details about the cost components attributed to the cart line
1 property 1 required
GetShippingFees_Request_CartLines_LineComponents_Cost
object
The details about the cost components attributed to the cart line
1 property 1 required
GetShippingFees_Request_CartLines_DiscountAllocations
object
The discounts applied to the cart line
4 properties 2 required
GetShippingFees_Request_CartLines_LineComponents_Merchandise_SelectedOptions
object
A product option applied to the variant
2 properties 2 required
GetShippingFees_Request_CartLines_LineComponents
object
The sub lines of the merchandise line
6 properties 6 required
GetCheckoutData_Response_200_Sellers_Choices_DeliveryEstimate
object
Expected delivery time
4 properties
GetShippingFees_Request_CartLines_Cost_TotalAmount
object
The monetary value with currency
2 properties 2 required
GetCheckoutData_Request_CartLines_LineComponents_Attributes
object
The custom attribute
2 properties 2 required
GetShippingFees_Response_200_Fees_Choices_DeliveryEstimate
object
Expected delivery time
4 properties
GetShippingFees_Request_CartLines_DiscountAllocations_DiscountedAmount
object
The monetary value with currency
2 properties 2 required
GetCheckoutData_Request
object
Request object to retrieve checkout data
4 properties 1 required
GetShippingFees_Response_200_Errors
object
Checkout error
2 properties
GetCheckoutData_Response_200_Sellers_Offers_Promotions
object
Promotion applied to the order
8 properties
GetShippingFees_Request_CartLines_LineComponents_Merchandise_SellingPlan
object
The selling plan
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-public-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 Public 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.