latestOpenAPI 3.1.02026-08-1828105315.1 KB

cc009fec5cdd

Orders

v2-listOrders - List Mirakl Connect orders

<div class="extension-title">Description</div>

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 <code>updated_from</code> parameter valued with the last execution time of the task.

<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: Asynchronous: every 5 minutes</div> <div class="max-call-frequency">Maximum usage: Asynchronous: once per minute</div> <div class="extension-title">Pagination</div> <p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p> <div class="extension-title">Sort fields</div>

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

</div>
get/v2/orders

Query parameters

order_idsstring[]

Filter by Connect order identifiers

statusesstring[]

Filter by order statuses

updated_fromstring date-time
Example:2021-01-01T08:30:00Z

Select orders that were last updated in Mirakl Connect from the specified date time. If omitted and no order_ids filter is provided, defaults to 30 days ago.

fulfillment_type'FULFILLED_BY_SELLER' | 'FULFILLED_BY_PARTNER'

Filter by fulfillment channel

page_tokenstring

Token to access the next or previous page

limitinteger

Maximum number of listed orders

Response

List of orders

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.