MImirakl
Returns

v2-listReturns - List Mirakl Connect returns

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

Use this API to synchronize Mirakl Connect returns with your system. We recommend integrating this API in asynchronous mode. You can retrieve all returns 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 return modification in Mirakl Connect (desc by default)</li></ul>

</div>
get/v2/orders/returns

Request

Query parameters

order_idsstring[]

Filter by Connect order identifiers

statusesstring[]

Filter by return statuses

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

Select returns that were last updated in Mirakl Connect from the specified date time.

page_tokenstring

Token to access the next or previous page

limitinteger

Maximum number of listed returns

Response

List of returns

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

  • d12b10bceb6aRevision changes
    • 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 DAMAGED_ITEM enum value to the ///// response property for the response status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • ba57c5b188b5Revision changes
    • breaking

      the response property //// became optional for the status