Skip to content
Products
/
Connect
/
Connect APIs
/
Returns

Mirakl Connect APIs

General Notes

Backward compatibility information

Mirakl solutions are updated through continuous delivery to provide new features, security fixes and bug fixes.

New deployed versions are backward compatible, which guarantees the durability of your integration after a Mirakl solution update, on condition that your integration follows these guidelines:

  • Your integration must allow for new fields to be added in API responses. From time to time, we add new fields as part of new features.
  • Do not expect fields to always have the same order in API calls. The order can change when fields are added to APIs.
  • Your integration must allow for new values to be added in enumeration fields. We can add new values in enumeration fields to support new features. We advise that you use strings to deserialize enumeration fields. Alternatively, you can configure your deserializer to accept unknown enumeration values.

Authentication with OAuth 2.0

You must authenticate with Mirakl Authentication System to make API calls. Refer to the Mirakl documentation: About the Mirakl Authentication System.

HTTPS only

All requests must use the HTTPS protocol.

API return codes

Mirakl API uses standard HTTP return codes.

When making HTTP requests, you can check the success or failure status of your request by using the HTTP Status Codes (i.e. 200). You must not use the HTTP Status Messages or Reason-Phrases (i.e. OK), as they are optional and may not be returned in HTTP responses (see RFC9110 for more information).

Our API documentation does not document Reason-Phrases but provides a short contextualized description of HTTP Status Codes.

Success Codes

  • 200: OK - Request succeeded.
  • 201: Created - Request succeeded and resource created.
  • 202: Accepted - Request accepted for processing.
  • 204: No Content - Request succeeded but does not return any content.

Error Codes

  • 400: Bad Request - Parameter errors or bad method usage. Bad usage of the resource. For example: a required parameter is missing, some parameters use an incorrect format, a data query is not in the expected state.
  • 401: Unauthorized - API call without authentication. Add authentication information or use a valid authentication token.
  • 403: Forbidden - Access to the resource is denied. Current user can not access the resource.
  • 404: Not Found - The resource does not exist. The resource URI or the requested resource do not exist for the current user.
  • 405: Method Not Allowed - The HTTP method (GET, POST, PUT, DELETE) is not allowed for this resource. Refer to the documentation for the list of accepted methods.
  • 406: Not Acceptable - The requested response content type is not available for this resource. Refer to the documentation for the list of correct values of the Accept header for this request.
  • 410: Gone - The resource is permanently gone. The requested resource is no longer available and will not be available again.
  • 415: Unsupported Media Type - The entity content type sent to the server is not supported. Refer to the documentation for the list of correct values of the Content-type header to send data.
  • 429: Too many requests - Rate limits are exceeded. The user has sent too many requests in the last hour. Refer to the documentation for the maximum calls count per hour.
  • 500: Internal Server Error - The server encountered an unexpected error.

Rate limits

Mirakl APIs are protected by rate limits. Each API has a dedicated section displaying its rate limit.

If you make too many calls, you might receive an HTTP 429 "Too Many Requests" error. The response will contain a Retry-After header that specifies the number of seconds to wait before making a new request.

Request Content-Type

If an API request supports multiple Content-Types, add a Content-Type header to select the format to use in the request. The API documentation lists the formats an API can consume.

Response Content-Type

If an API response supports multiple Content-Types, add an Accept header to select the format accepted in the response. The API documentation lists the formats an API can produce.

List of values as URL parameters

array type fields indicate a list of values as URL parameters. You can add more parameter=value elements to the URL. Refer to the example in the right panel.

UTF-8 encoding

Text data is encoded in UTF-8.

Locale

If the API returns internationalized data, you can specify the locale parameter.

The Locale format is usually <ISO-639>_<ISO-3166> (e.g. "en_US"). There are some exceptions where the Locale format can be <ISO-639> (e.g. "en"). The locale returned in a response uses this format.

The APIs only accept locales that are equivalent to the languages activated in the back-office.

Date formats

APIs can use different date formats (compliant with ISO 8601):

  • date-time with the pattern YYYY-MM-DDThh:mm:ss[.SSS]±hh:mm.
    • The offset +00:00 can be replaced by Z (the zero UTC offset).
    • All APIs provide date-times in UTC, with the trailing Z.
    • Milliseconds may be omitted if equals to .000.
  • date-time-without-timezone with the pattern YYYY-MM-DDThh:mm:ss[.SSS].
    • The timezone does not appear.
    • Milliseconds may be omitted if equals to .000.
  • time with the pattern hh:mm[:ss][.SSS]±hh:mm. Time only, with timezone
    • The offset +00:00 can be replaced by Z (the zero UTC offset).
    • Seconds may be omitted if equals to :00.
    • Milliseconds may be omitted if equals to .000.

In the patterns:

  • YYYY: years (four-digit)
  • MM: months, 01-12 (two-digit)
  • DD: days, 01-31 (two-digit)
  • T is a delimiter between the date and time
  • hh: hours, 00-23 (two-digit)
  • mm: minutes, 00-59 (two-digit)
  • ss: seconds, 00-60 (two-digit)
  • SSS: milliseconds, 000-999 (three-digit)
  • ±hh:mm: refers to an offset from UTC

For GET requests, use URL encoding (for example, 2019-08-29T02:34:00+02:00 becomes 2019-08-29T02%3A34%3A00%2B02%3A00).

Seek pagination & sort

For better performance and user experience, some APIs support "seek" pagination. This means that you cannot go directly to the N-th page.

Use the optional limit query parameter to indicate the maximum number of items returned per page. The default value is 10. The maximum value is 100.

If there are more results to return, the response contains a next_page_token field. Pass this value in the page_token query parameter to return the next page of results.

The API also returns a previous_page_token when the result is not the first page. Use it the same way as next_page_token.

Values of next_page_token and previous_page_token contain all required parameters to access next and previous page. When using the page_token parameter all other parameters are ignored, regardless of the value given to page_token.

When a sort parameter is available, it must follow the sort=criterion,direction format where:

  • criterion is the name of the criterion to sort by (e.g: date_created, title, ...)
  • direction is the sort direction. Can be one of ASC, DESC
Languages
Servers
Connect Production endpoint

https://miraklconnect.com/api/

Orders

Operations

Shipments

Operations

Catalog

Operations

Returns

Operations

v2-acceptReturn - Accept or refuse return

Request

Use this API to accept or refuse a return that is in the REQUEST_INITIATED status, from Mirakl Connect. The API also synchronizes the return status on the sales channel.

Call Frequency
Recommended usage: On each new return
Maximum usage: On each new return

Security
Bearer
Path
return_idstringrequired

Return identifier in Mirakl Connect

Example: 70885
Bodyapplication/jsonrequired
acceptedbooleanrequired

Indicates if a return is accepted (true) or refused (false).

rejection_reasonstring

Reason for rejecting the return

Enum"RETURN_WINDOW_CLOSED""NOT_ELIGIBLE_FOR_RETURN""FINAL_SALES"
curl -i -X PUT \
  https://miraklconnect.com/api/v2/orders/returns/70885/accept \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accepted": true
  }'

Responses

Accepted. The accept request will be processed asynchronously.

Bodyapplication/json
action_idstringrequired

The unique identifier for the asynchronous action. It should be used with the v2-getActionStatus API to retrieve current action status and potential errors.

tracking_idstringDeprecated

Deprecated: This field was previously used to obtain the action ID. It has been replaced by action_id and contains the same value. It is retained for backward compatibility.

Response
application/json
{
  "action_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4",
  "tracking_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4"
}

v2-acknowledgeReturnReception - Mark return as received

Request

Use this API to marks the return as received to officially confirm physical reception of the item from the customer. The API also synchronizes the return status on the sales channel.

Call Frequency
Recommended usage: On each new return
Maximum usage: On each new return

Security
Bearer
Path
return_idstringrequired

Return identifier in Mirakl Connect

Example: 70885
curl -i -X PUT \
  https://miraklconnect.com/api/v2/orders/returns/70885/receive \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted. The accept request will be processed asynchronously.

Bodyapplication/json
action_idstringrequired

The unique identifier for the asynchronous action. It should be used with the v2-getActionStatus API to retrieve current action status and potential errors.

tracking_idstringDeprecated

Deprecated: This field was previously used to obtain the action ID. It has been replaced by action_id and contains the same value. It is retained for backward compatibility.

Response
application/json
{
  "action_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4",
  "tracking_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4"
}

v2-closeReturn - Mark return as closed

Request

Use this API to marks the return as closed after all necessary steps required by the marketplace or seller’s process are completed (e.g., refund, compliance check, restocking). The API also synchronizes the return status on the sales channel.

Call Frequency
Recommended usage: On each new return
Maximum usage: On each new return

Security
Bearer
Path
return_idstringrequired

Return identifier in Mirakl Connect

Example: 70885
curl -i -X PUT \
  https://miraklconnect.com/api/v2/orders/returns/70885/close \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Accepted. The accept request will be processed asynchronously.

Bodyapplication/json
action_idstringrequired

The unique identifier for the asynchronous action. It should be used with the v2-getActionStatus API to retrieve current action status and potential errors.

tracking_idstringDeprecated

Deprecated: This field was previously used to obtain the action ID. It has been replaced by action_id and contains the same value. It is retained for backward compatibility.

Response
application/json
{
  "action_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4",
  "tracking_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4"
}

v2-listReturns - List Mirakl Connect returns

Request

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 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 return modification in Mirakl Connect (desc by default)

Security
Bearer
Query
order_idsArray of strings<= 100 items

Filter by Connect order identifiers

statusesArray of strings<= 100 items

Filter by return statuses

Items Enum"REQUEST_INITIATED""REQUEST_DECLINED""OPENED""RECEIVED""CLOSED"
updated_fromstring(date-time)required

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

Example: updated_from=2021-01-01T08:30:00Z
page_tokenstring

Token to access the next or previous page

limitinteger[ 1 .. 100 ]

Maximum number of listed returns

Default 10
curl -i -X GET \
  'https://miraklconnect.com/api/v2/orders/returns?order_ids=string&statuses=REQUEST_INITIATED&updated_from=2021-01-01T08%3A30%3A00Z&page_token=string&limit=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of returns

Bodyapplication/json
next_page_tokenstringnon-empty

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

previous_page_tokenstringnon-empty

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

dataArray of objectsrequired

Page of orders corresponding to the filter parameters

Response
application/json
{
  "data": [
    { … }
  ],
  "next_page_token": "bGltaXQ9MTAmYWZ0ZXI9MjAyMS0xMS0xNlQxNjoxNTowOSswMTowMCZhZnRlcj1jb25uZWN0bXAxLXRlc3QmYWZ0ZXI9MzE3ODczOC1BJnNvcnQ9ZGF0ZV91cGRhdGVkLERFU0M=",
  "previous_page_token": "YmVmb3JlPTIwMjEtMTEtMjRUMDA6MDA6MTErMDE6MDAmYmVmb3JlPWNvbm5lY3RtcDItdGVzdCZiZWZvcmU9MzIwMjYzMC1BJmxpbWl0PTEwJnNvcnQ9ZGF0ZV91cGRhdGVkLERFU0M="
}

v2-updateReturnTrackingInformation - Update return tracking information

Request

Use this API to update the tracking information of a return from Mirakl Connect. The API also updates the return tracking information on the sales channel.

Call Frequency
Recommended usage: On each new return
Maximum usage: On each new return

Security
Bearer
Path
return_idstringrequired

Return identifier in Mirakl Connect

Example: 70885
Bodyapplication/jsonrequired
label_urlstring

Return label URL

rma_idstring

RMA ID (Return Merchandise Authorization)

trackingobject

Return tracking information

curl -i -X PUT \
  https://miraklconnect.com/api/v2/orders/returns/70885/trackings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "label_url": "https://shipping.ups.com/returns/labels/d290f1ee-6c54-4b01-90e6-d701748f0851.pdf",
    "rma_id": "CR117B72FEF5E8391187",
    "tracking": {
      "carrier": "FedEx",
      "tracking_number": "791823193211",
      "tracking_url": "https://www.fedex.com/fedextrack/?trknbr=791823193211"
    }
  }'

Responses

Accepted. The accept request will be processed asynchronously.

Bodyapplication/json
action_idstringrequired

The unique identifier for the asynchronous action. It should be used with the v2-getActionStatus API to retrieve current action status and potential errors.

tracking_idstringDeprecated

Deprecated: This field was previously used to obtain the action ID. It has been replaced by action_id and contains the same value. It is retained for backward compatibility.

Response
application/json
{
  "action_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4",
  "tracking_id": "1ba5fc4b-c4fd-4251-880b-3052e301bbd4"
}