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 Multiple shipments API

The Multiple shipments API from Mirakl — 7 operation(s) for multiple shipments.

Mirakl Multiple 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 Multiple shipments. The published artifact set on APIs.io includes an OpenAPI specification.

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

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

9 operations 7 paths 90 schemas 2 GET2 POST5 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, HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 6

Mirakl Multiple shipments API declares 6 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). 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 (shop_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 9

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

Multiple shipments 9
POST
/api/shipments
ST01 - Create shipments
ST01 body → 201
GET
/api/shipments
ST11 - List shipments
ST11 5 params → 200
PUT
/api/shipments
ST07 - Update shipment shipping origin
ST07 body → 200
PUT
/api/shipments/delete
ST06 - Delete shipments
ST06 body → 200
GET
/api/shipments/items_to_ship
ST12 - List items to ship
ST12 4 params → 200
POST
/api/shipments/tracking
ST23 - Update carrier tracking information for shipments
ST23 body → 200
PUT
/api/shipments/ship
ST24 - Validate shipments as shipped
ST24 body → 200
PUT
/api/shipments/ready_for_pick_up
ST26 - Validate shipments as ready to pick up
ST26 body → 200
PUT
/api/shipments/additional_information
ST31 - Update shipment additional information
ST31 body → 200

Schemas 90

The contract defines 90 schemas that model the data the API accepts and returns. The most detailed are ST12_Response_200_Data_ShippingAddress (15 properties), ST01_Response_201_ShipmentSuccess (13 properties), ST11_Response_200_Data (13 properties), ST11_Response_200_Data_Tracking (9 properties). Each schema is shown below with its type and property counts.

ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo_OccurrenceDate
object
3 properties
ST01_Response_201_ShipmentSuccess_ShippingFrom_Address
object
6 properties
ST24_Response_200_ShipmentSuccess
object
1 property 1 required
ST01_Response_201_ShipmentSuccess_Tracking_Milestones_OccurrenceDate
object
3 properties
ST11_Response_200_Data_ShipmentLines
object
4 properties 1 required
ST11_Response_200_Data_Tracking
object
9 properties
ST11_Response_200_Data
object
13 properties 6 required
ST06_Response_200_ShipmentErrors
object
2 properties
ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate
object
2 properties
ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate
object
2 properties
ST12_Response_200_Data_ShippingAddress
object
15 properties 5 required
ST23_Request
object
1 property 1 required
ST01_Request_Shipments
object
Shipments list
7 properties 2 required
ST01_Response_201_ShipmentSuccess_PaymentDetails
object
3 properties 2 required
ST01_Request_Shipments_ShippingFrom
object
Shipment's shipping origin
1 property
ST01_Response_201_ShipmentSuccess_Tracking
object
9 properties
ST23_Response_200_ShipmentErrors
object
2 properties
ST12_Response_200_Data_ShipmentLines
object
6 properties 1 required
ST23_Response_200_ShipmentSuccess
object
1 property 1 required
ST01_Response_201_ShipmentSuccess_ShippingFrom_Warehouse
object
1 property
ST12_Response_200_Data_References
object
2 properties
ST24_Request_Shipments
object
Shipment ids
1 property 1 required
ST01_Response_201_ShipmentSuccess_ShippingFrom
object
2 properties
ST01_Request_Shipments_ShipmentAdditionalInformation
object
Shipment's additional information
3 properties 3 required
ST26_Request_Shipments
object
Shipment ids
1 property 1 required
ST11_Response_200_Data_Tracking_Milestones_OccurrenceDate
object
3 properties
ST12_Response_200_Data
object
9 properties 4 required
ST06_Response_200_ShipmentSuccess
object
1 property 1 required
ST06_Response_200
object
2 properties
ST11_Response_200_Data_ShipmentAdditionalInformation
object
2 properties
ST24_Response_200
object
2 properties
ST11_Response_200_Data_ShippingFrom_Address
object
6 properties
ST01_Response_201_ShipmentSuccess_ShipmentAdditionalInformation
object
2 properties
ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation_OccurrenceDate
object
3 properties
ST12_Response_200_Data_Fulfillment
object
1 property 1 required
ST26_Request
object
1 property 1 required
ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo
object
2 properties
ST01_Response_201_ShipmentSuccess_ShipmentLines
object
4 properties 1 required
ST01_Request
object
1 property 1 required
ST26_Response_200_ShipmentErrors
object
2 properties
ST11_Response_200_Data_Tracking_LastKnownLocation_OccurrenceDate
object
3 properties
ST11_Response_200_Data_Tracking_Milestones
object
3 properties
ST06_Request
object
1 property 1 required
ST01_Response_201_ShipmentSuccess_Tracking_Milestones
object
3 properties
ST01_Response_201
object
2 properties 2 required
ST01_Response_201_ShipmentSuccess_Tracking_LastKnownLocation
object
2 properties
ST11_Response_200_Data_ShippingFrom
object
2 properties
ST12_Response_200
object
3 properties 1 required
ST11_Response_200_Data_PaymentDetails
object
3 properties 2 required
ST11_Response_200
object
3 properties 1 required
ST12_Response_200_Data_Fulfillment_Center
object
1 property 1 required
ST01_Response_201_ShipmentSuccess
object
13 properties 6 required
ST24_Response_200_ShipmentErrors
object
2 properties
ST01_Request_Shipments_Tracking
object
Shipment tracking details
5 properties
ST23_Request_Shipments_Tracking
object
Shipment tracking details
5 properties
ST11_Response_200_Data_Tracking_LastKnownLocation
object
2 properties
ST23_Response_200
object
2 properties
ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Earliest
object
3 properties
ST01_Response_201_ShipmentSuccess_Tracking_Milestones_AdditionalInfo
object
2 properties
ST26_Response_200_ShipmentSuccess
object
1 property 1 required
ST23_Request_Shipments
object
Shipments list
2 properties 2 required
ST11_Response_200_Data_ShippingFrom_Warehouse
object
1 property
ST01_Request_Shipments_ShipmentLines
object
Shipment lines
4 properties 1 required
ST01_Request_Shipments_ShippingFrom_Warehouse
object
The warehouse from where the shipment is shipped
1 property
ST26_Response_200
object
2 properties
ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Earliest
object
3 properties
ST24_Request
object
1 property 1 required
ST11_Response_200_Data_Tracking_CarrierExpectedDeliveryDate_Latest
object
3 properties
ST01_Response_201_ShipmentErrors
object
2 properties
ST11_Response_200_Data_Tracking_Milestones_AdditionalInfo_OccurrenceDate
object
3 properties
ST01_Response_201_ShipmentSuccess_Tracking_CarrierExpectedDeliveryDate_Latest
object
3 properties
ST06_Request_Shipments
object
Shipment ids
1 property 1 required
ST31_Response_200_ShipmentUpdateSuccess_ShipmentAdditionalInformation
object
3 properties 3 required
ST31_Request_Shipments
object
List of shipments additional information
2 properties 2 required
ST31_Request_Shipments_ShipmentAdditionalInformation
object
Shipment additional information
3 properties 3 required
ST07_Request_Shipments_ShippingFrom
object
Shipment's shipping origin
1 property 1 required
ST07_Request_Shipments_ShippingFrom_Warehouse
object
The warehouse from where the shipment is shipped
1 property 1 required
ST31_Response_200
object
2 properties
ST31_Response_200_ShipmentUpdateSuccess
object
2 properties
ST07_Request
object
1 property 1 required
ST07_Response_200
object
2 properties 2 required
ST31_Request
object
1 property 1 required
ST07_Response_200_ShipmentSuccess
object
2 properties
ST31_Response_200_ShipmentUpdateErrors
object
2 properties
ST07_Response_200_ShipmentSuccess_ShippingFrom_Warehouse
object
1 property
ST31_Response_200_ShipmentUpdateErrors_Errors
object
3 properties 3 required
ST07_Response_200_ShipmentErrors
object
2 properties
ST07_Response_200_ShipmentSuccess_ShippingFrom
object
2 properties
ST07_Request_Shipments
object
Shipments list
2 properties 2 required
ST07_Response_200_ShipmentSuccess_ShippingFrom_Address
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-multiple-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 Offers API
Mirakl Orders API
Mirakl Picklists API
Mirakl Platform Settings API
Mirakl Product Feedback API
Mirakl Products API
Mirakl Promotions API
Where this information came from

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