MImirakl
Orders

v2-refundOrderLines - Refund order lines

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

Use this API to refund order lines (all or part) of an order.

<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: At each refund request</div> <div class="max-call-frequency">Maximum usage: At each refund request</div> </div>
post/v2/orders/{order_id}/refund

Request

Path parameters

order_idstring required

Order identifier in Mirakl Connect

Request body

Example request

{
  "refunds": [
    {
      "order_line_id": "01JYGX3F6A2P8QW4KZRD9TBEH5",
      "price": {
        "currency": "EUR"
      },
      "product_id": "SELLER_ID_1",
      "quantity": 10,
      "shipping_price": {
        "currency": "EUR"
      },
      "shipping_taxes": [
        {
          "amount": {
            "currency": "EUR"
          }
        }
      ],
      "taxes": [
        {
          "amount": {
            "currency": "EUR"
          }
        }
      ]
    }
  ]
}

Response

Accepted. The refund request will be processed asynchronously.

action_idstring required

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_idstring

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.

Example response

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

Changes

  • d12b10bceb6aRevision changes
    • breaking

      request property // was restricted to a list of enum values

    • info

      added the new AGREEMENT enum value to the request property //

    • info

      added the new CUSTOMER_CANCELATION enum value to the request property //

    • info

      added the new DEFECT enum value to the request property //

    • info

      added the new ITEM_NOT_RECEIVED enum value to the request property //

    • info

      added the new OUT_OF_STOCK enum value to the request property //

    • info

      added the new RETURN enum value to the request property //

    • info

      added the new UNABLE_TO_DELIVER enum value to the request property //