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

The Shipments API from Mirakl — 2 operation(s) for shipments.

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

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

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

Requests are made against a single base URL, https://miraklconnect.com/api.

2 operations 2 paths 8 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 Shipments 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.

Shipments 2
POST
/orders/{order_id}/shipmentsdeprecated
createShipment - Ship items of a Connect order
createShipment 1 param body → 201400404
POST
/v2/orders/{order_id}/shipments
v2-createShipment - Ship items of a Connect order
v2-createShipment 1 param body → 202400404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ShipmentResponse (8 properties), V2CreateShipmentRequest (6 properties), CreateShipmentRequest (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

Error
object
4 properties 2 required
AsynchronousActionResponse
object
2 properties 1 required
ShipmentItemResponse
object
3 properties 3 required
CreateShipmentRequest
object
Shipment object and its items' details
5 properties 1 required
ShipmentResponse
object
8 properties 5 required
V2CreateShipmentRequest
object
Shipment object and its items' details
6 properties 1 required
ErrorItem
object
3 properties 1 required
CreateShipmentItemRequest
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-shipments-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 Shipments 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.