Mirakl Marketplace APIs (latest-release)

Languages
Servers
URL to be replaced by your Mirakl instance URL
https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Patch update returns

Request

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json
returnsArray of objects(RT04_Request_Returns)[ 1 .. 100 ] items

Returns to be updated, maximum number of returns per call: 100

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/returns?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "returns": [
      {
        "id": "string",
        "label_url": "string",
        "rma": "string",
        "tracking": {
          "carrier_code": "string",
          "carrier_name": "string",
          "carrier_standard_code": "string",
          "tracking_number": "string",
          "tracking_url": "string"
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
return_errorsArray of objects(RT04_Response_200_ReturnErrors)

Return creation errors

return_successArray of objects(RT04_Response_200_ReturnSuccess)

Return creation success

Response
application/json
{ "return_errors": [ {} ], "return_success": [ {} ] }

List returns

Request

Query
return_idArray of strings

Return id for filtering. This parameter can be supplied multiple times (return_id=58fd00d1-4ea4-453e-9a56-ec28c5c156ea&return_id=3071c162-dcd9-414b-a39d-ac3165f29453...).

return_stateArray of strings

Return state for filtering. This parameter can be supplied multiple times (return_state=WAITING_ACCEPTANCE&return_state=IN_PROGRESS...).

return_creation_date_fromstring(date-time)

Filter returns with a creation date after the given date.

return_creation_date_tostring(date-time)

Filter returns with a creation date before the given date.

return_last_updated_fromstring(date-time)

Filter returns updated after the given date.

return_last_updated_tostring(date-time)

Filter returns updated before the given date.

order_commercial_idArray of strings

Order commercial id for filtering. This parameter can be supplied multiple times (order_commercial_id=OR01-A&order_commercial_id=OR02-A...).

order_line_idArray of strings

Order line id for filtering. This parameter can be supplied multiple times (order_line_id=OR01-A-1&order_line_id=OR02-A-1...).

return_rmaArray of strings

Return RMA for filtering. This parameter can be supplied multiple times (return_rma=RMA-1&return_rma=RMA-2...).

customer_idArray of strings

Customer id for filtering. This parameter can be supplied multiple times (customer_id=id1&customer_id=id2...).

shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

page_tokenstring

Token retrieved from next_page_token or previous_page_token to get to next

sortstring

How the results should be sorted. Must follow "sort=criterion,direction" format as described in Mirakl API Documentation

curl -i -X GET \
  'https://your-instance.mirakl.net/api/returns?customer_id=string&order_commercial_id=string&order_line_id=string&page_token=string&return_creation_date_from=2019-08-24T14%3A15%3A22Z&return_creation_date_to=2019-08-24T14%3A15%3A22Z&return_id=string&return_last_updated_from=2019-08-24T14%3A15%3A22Z&return_last_updated_to=2019-08-24T14%3A15%3A22Z&return_rma=string&return_state=string&shop_id=0&sort=string'

Responses

OK

Bodyapplication/json
dataArray of objects(RT11_Response_200_Data)

Page of data

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.

Response
application/json
{ "data": [ {} ], "next_page_token": "string", "previous_page_token": "string" }

Accept or refuse a return request

Request

Limited to 100 returns at a time

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json
returnsArray of objects(RT21_Request_Returns)[ 1 .. 100 ] items

Returns to be accepted, maximum number of returns per call: 100

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/returns/accept?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "returns": [
      {
        "accepted": true,
        "id": "string",
        "rejection_reason_code": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
return_errorsArray of objects(RT21_Response_200_ReturnErrors)

Returns update success

return_successArray of objects(RT21_Response_200_ReturnSuccess)

Returns update success

Response
application/json
{ "return_errors": [ {} ], "return_success": [ {} ] }

Validate returns as received

Request

Limited to 100 returns at a time

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json
returnsArray of objects(RT25_Request_Returns)[ 1 .. 100 ] items

Return ids

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/returns/receive?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "returns": [
      {
        "id": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
return_errorsArray of objects(RT25_Response_200_ReturnErrors)

Returns update success

return_successArray of objects(RT25_Response_200_ReturnSuccess)

Returns update success

Response
application/json
{ "return_errors": [ {} ], "return_success": [ {} ] }

Mark a return as compliant or non compliant

Request

Limited to 100 returns at a time

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json
returnsArray of objects(RT26_Request_Returns)[ 1 .. 100 ] items

Mark returns as compliant or non-compliant, maximum number of returns per call: 100

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/returns/compliance?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "returns": [
      {
        "id": "string",
        "return_lines": [
          {
            "compliant": true,
            "non_compliance_additional_info": "string",
            "non_compliance_reason_code": "string",
            "order_line_id": "string"
          }
        ]
      }
    ]
  }'

Responses

OK

Bodyapplication/json
return_errorsArray of objects(RT26_Response_200_ReturnErrors)

Returns update success

return_successArray of objects(RT26_Response_200_ReturnSuccess)

Returns update success

Response
application/json
{ "return_errors": [ {} ], "return_success": [ {} ] }

Multiple shipments

Operations