# Orders

## v2-acceptOrderLines - Accept or refuse order lines

 - [PUT /v2/orders/{order_id}/accept](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-acceptorderlines.md): Description

Use this API to accept or refuse order lines that are in the AWAITING_ACCEPTANCE status, from Mirakl Connect. The API also synchronizes the order line status on the sales channel.


Call Frequency

Recommended usage: On each new order
Maximum usage: On each new order

## v2-cancelOrderLines - Cancel order lines

 - [POST /v2/orders/{order_id}/cancel](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-cancelorderlines.md): Description

Use this API to cancel order lines (all or part) of an order.


Call Frequency

Recommended usage: At each cancel request
Maximum usage: At each cancel request

## v2-downloadOrderDocuments - Download documents from an order

 - [GET /v2/orders/{order_id}/documents](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-downloadorderdocuments.md): Description

Use this API to download documents from an order.



Call Frequency

Recommended usage: On each order where we want to retrieve its documents
Maximum usage: On each order where we want to retrieve its documents

## v2-uploadOrderDocument - Upload a document for an order

 - [POST /v2/orders/{order_id}/documents](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-uploadorderdocument.md): Description

Use this API to upload a document for an order or its related entities (e.g. returns).

Supported document types are :
  - RETURN_LABEL
  - CUSTOMER_INVOICE



Call Frequency

Recommended usage: On each document upload
Maximum usage: On each document upload

## v2-getActionStatus - Track an asynchronous action request

 - [GET /v2/orders/actions/{action_id}](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-getactionstatus.md): Description

Use this API to check the status of an asynchronous action request  (e.g., v2-acceptOrderLines) and retrieve  any potential errors that occurred during the action processing.
We recommend integrating this API asynchronously.


Call Frequency

Recommended usage: Asynchronous: every 5 minutes per action ID
Maximum usage: Asynchronous: once per minute per action ID

## v2-listOrderDocuments - List documents

 - [GET /v2/orders/documents](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-listorderdocuments.md): Description

Use this API to retrieve documents across orders with pagination support.

Each document in the response includes its associated order_id along with metadata such as name, type, size, and last update date.

Documents are returned as a flat list sorted by updated_at in descending order (most recent first).

At least one of the updated_from or order_ids filters must be provided.



Call Frequency

Recommended usage: When you need to retrieve documents for orders
Maximum usage: When you need to retrieve documents for orders
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:updated_at (Default) - Sort by document last update time (desc by default)

## v2-listOrders - List Mirakl Connect orders

 - [GET /v2/orders](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-listorders.md): Description

Use this API to synchronize Mirakl Connect orders with your system. We recommend integrating this API in asynchronous mode. You can retrieve all orders updated since the last call, and update your referential accordingly. To do so, schedule a task that calls this API using the updated_from parameter valued with the last execution time of the task.


Call Frequency

Recommended usage: Asynchronous: every 5 minutes
Maximum usage: Asynchronous: once per minute
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:updated_at (Default) - Sort by date time of last order modification in Mirakl Connect (desc by default)created_at - Sort by date time the order was created on the sales channel (desc by default)

## v2-refundOrderLines - Refund order lines

 - [POST /v2/orders/{order_id}/refund](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-refundorderlines.md): Description

Use this API to refund order lines (all or part) of an order.


Call Frequency

Recommended usage: At each refund request
Maximum usage: At each refund request

## v2-reportOrderActions - Log order action results and errors

 - [POST /v2/orders/actions](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-reportorderactions.md): Description

Use this API to report to Connect the results of actions performed on orders in your system, such as synchronizing  back orders. This enables enhanced error tracking while providing a centralized view of all  order actions and errors within the Connect interface.

We recommend integrating this API when developing a connector, such as for a CMS, to ensure comprehensive tracking  of order actions and errors. This integration is optional if you process orders directly via the Connect API without using a connector.



Call Frequency

Recommended usage: Every 5 minutes
Maximum usage: Once per minute

## acceptOrderLines - Accept or refuse order lines (deprecated)

 - [PUT /orders/{order_id}/accept](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/acceptorderlines.md): Description

Use this API to accept or refuse order lines that are in the AWAITING_ACCEPTANCE status, from Mirakl Connect. The API also synchronizes the order line status on the sales channel. We recommend integrating this API in synchronous mode.


Call Frequency

Recommended usage: On each new order
Maximum usage: On each new order

## listOrders - List Mirakl Connect orders (deprecated)

 - [GET /orders](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/listorders.md): Description

Use this API to synchronize Mirakl Connect orders with your system. We recommend integrating this API in asynchronous mode. You can retrieve all orders updated since the last call, and update your referential accordingly. To do so, schedule a task that calls this API using the updated_from parameter valued with the last execution time of the task.


Call Frequency

Recommended usage: Asynchronous: every 5 minutes
Maximum usage: Asynchronous: once per minute
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:updated_at (Default) - Sort by date time of last order modification in Mirakl Connect (desc by default)created_at - Sort by date time the order was created on the sales channel (desc by default)

## v2-getOrderTracking - Retrieve tracking information (deprecated)

 - [GET /v2/orders/tracking/{tracking_id}](https://developer.mirakl.com/content/product/connect/rest/connect/openapi3/orders/v2-getordertracking.md): Description

This API is deprecated. Please use the new v2-getActionStatus API for retrieving the status of action request and potential errors.


Call Frequency

Recommended usage: Uses the new v2-getActionStatus API
Maximum usage: Uses the new v2-getActionStatus API

