Returns

RT01 - Create returns

Request

Description

Limited to 200 returns at a time

Call Frequency

Recommended usage: At each customer return request

Maximum usage: At each customer return 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, [ 1 .. 200 ] itemsrequired

Returns list

curl -i -X POST \
  'https://your-instance.mirakl.net/api/returns?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "returns": [
      {
        "accepted": null,
        "label_url": "https://www.label-url.com",
        "method_code": "RETURN_METHOD_BY_MAIL",
        "order_commercial_id": "ORDER-001",
        "reason_code": "RETURN_CHANGED_MIND",
        "return_lines": [
          {
            "order_line_id": "ORDER-001-A-1",
            "quantity": 1
          },
          {
            "order_line_id": "ORDER-001-B-2",
            "quantity": 2
          }
        ],
        "rma": "RETURN_RMA"
      },
      {
        "accepted": true,
        "description": "Description of return",
        "label_url": null,
        "method_code": "RETURN_METHOD_DROP_OFF_POINT",
        "order_commercial_id": "ORDER-DROPSHIP-1",
        "reason_code": "RETURN_CHANGED_MIND",
        "return_lines": [
          {
            "order_line_id": "ORDER-DROPSHIP-1-A-1",
            "quantity": 1
          }
        ],
        "rma": null
      }
    ]
  }'

Responses

OK

Bodyapplication/json

return_errorsArray of objectsrequired

Return creation errors

return_successArray of objectsrequired

Return creation success

Response

{
  "return_errors": [
    { … }
  ],
  "return_success": [
    { … },
    { … }
  ]
}