MImirakl
Orders

listOrders - List Mirakl Connect orders

Changed on
<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/orders

Request

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.

Changes

  • c0527a972b89Revision changes
    • info

      added the optional property ///// to the response with the status

  • d12b10bceb6aRevision changes
    • warning

      added the new ACCEPTANCE_TIMEOUT enum value to the ///// response property for the response status

    • warning

      added the new ACCEPTANCE_TIMEOUT enum value to the /// response property for the response status

    • warning

      added the new AGREEMENT enum value to the /////// response property for the response status

    • warning

      added the new AUTOMATICALLY_CLOSED enum value to the ///// response property for the response status

    • warning

      added the new AUTOMATICALLY_CLOSED enum value to the /// response property for the response status

    • warning

      added the new AWAITING_ACCEPTANCE enum value to the ///// response property for the response status

    • warning

      added the new AWAITING_ACCEPTANCE enum value to the /// response property for the response status

    • warning

      added the new AWAITING_FRAUD_CHECK enum value to the ///// response property for the response status

    • warning

      added the new AWAITING_FRAUD_CHECK enum value to the /// response property for the response status

    • warning

      added the new AWAITING_PAYMENT enum value to the ///// response property for the response status

    • warning

      added the new AWAITING_PAYMENT enum value to the /// response property for the response status

    • warning

      added the new AWAITING_SHIPMENT enum value to the ///// response property for the response status

    • warning

      added the new AWAITING_SHIPMENT enum value to the /// response property for the response status

    • warning

      added the new BOOLEAN enum value to the ///// response property for the response status

    • warning

      added the new BOOLEAN enum value to the /////// response property for the response status

    • warning

      added the new CANCELATION enum value to the /////// response property for the response status

    • warning

      added the new CANCELED enum value to the ///// response property for the response status

    • warning

      added the new CANCELED enum value to the /// response property for the response status

    • warning

      added the new CHANNEL_SPECIFIC enum value to the /////// response property for the response status

    • warning

      added the new CHANNEL_SPECIFIC enum value to the ///// response property for the response status

    • warning

      added the new CHANNEL_SPECIFIC enum value to the /// response property for the response status

    • warning

      added the new CLOSED enum value to the ///// response property for the response status

    • warning

      added the new CLOSED enum value to the /// response property for the response status

    • warning

      added the new CUSTOMER_CANCELATION enum value to the /////// response property for the response status

    • warning

      added the new DATE enum value to the ///// response property for the response status

    • warning

      added the new DATE enum value to the /////// response property for the response status

    • warning

      added the new DEFECT enum value to the /////// response property for the response status

    • warning

      added the new DELIVERED enum value to the ///// response property for the response status

    • warning

      added the new DELIVERED enum value to the /// response property for the response status

    • warning

      added the new FRAUD_CHECK_FAILED enum value to the ///// response property for the response status

    • warning

      added the new FRAUD_CHECK_FAILED enum value to the /// response property for the response status

    • warning

      added the new FRAUD_CHECK_TIMEOUT enum value to the ///// response property for the response status

    • warning

      added the new FRAUD_CHECK_TIMEOUT enum value to the /// response property for the response status

    • warning

      added the new FULFILLED_BY_PARTNER enum value to the //// response property for the response status

    • warning

      added the new FULFILLED_BY_SELLER enum value to the //// response property for the response status

    • warning

      added the new ITEM_NOT_RECEIVED enum value to the /////// response property for the response status

    • warning

      added the new LIST enum value to the ///// response property for the response status

    • warning

      added the new LIST enum value to the /////// response property for the response status

    • warning

      added the new NUMERIC enum value to the ///// response property for the response status

    • warning

      added the new NUMERIC enum value to the /////// response property for the response status

    • warning

      added the new OUT_OF_STOCK enum value to the /////// response property for the response status

    • warning

      added the new PAYMENT_TIMEOUT enum value to the ///// response property for the response status

    • warning

      added the new PAYMENT_TIMEOUT enum value to the /// response property for the response status

    • warning

      added the new REFUND enum value to the /////// response property for the response status

    • warning

      added the new REFUNDED enum value to the ///// response property for the response status

    • warning

      added the new REFUNDED enum value to the /// response property for the response status

    • warning

      added the new REFUSED enum value to the ///// response property for the response status

    • warning

      added the new REFUSED enum value to the /// response property for the response status

    • warning

      added the new REFUSED_PAYMENT enum value to the ///// response property for the response status

    • warning

      added the new REFUSED_PAYMENT enum value to the /// response property for the response status

    • warning

      added the new RETURN enum value to the /////// response property for the response status

    • warning

      added the new SHIPPED enum value to the ///// response property for the response status

    • warning

      added the new SHIPPED enum value to the /// response property for the response status

    • warning

      added the new STRING enum value to the ///// response property for the response status

    • warning

      added the new STRING enum value to the /////// response property for the response status

    • warning

      added the new UNABLE_TO_DELIVER enum value to the /////// response property for the response status