# Mirakl API Documentation

This is the complete API documentation for connecting to the Mirakl API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Mirakl connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/mirakl/actions/{actionSlug}/run
```

## Mirakl actions

- PUT `accept-or-refuse-order-lines` Accept or refuse order lines
- POST `create-shipments` Create shipments
- POST `create-update-or-delete-offers` Create, update, or delete offers
- GET `get-information-about-an-offer` Get information about an offer
- GET `get-pricing-import-error-report` Get Pricing Import Error Report
- GET `list-accounting-documents` List accounting documents
- GET `list-accounting-documents-requests` List accounting documents requests
- GET `list-all-carriers` List all carriers
- GET `list-offer-imports` List Offer Imports
- GET `list-shop-offers` List Offers
- GET `list-orders` List Orders
- GET `list-pricing-imports` List Pricing Imports
- GET `list-shipments` List Shipments
- PUT `update-carrier-tracking-information-for-a-specific-order` Update carrier tracking information for a specific order
- PUT `update-carrier-tracking-information-for-shipments` Update carrier tracking information for shipments
- PUT `validate-shipments-as-shipped` Validate shipments as shipped
