Sign in
Orders

v2-cancelOrderLines - Cancel order lines

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

Use this API to cancel 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 cancel request</div> <div class="max-call-frequency">Maximum usage: At each cancel request</div> </div>
post/v2/orders/{order_id}/cancel

Path parameters

order_idstring required

Order identifier in Mirakl Connect

Request body

Example request

{
  "cancelations": [
    {
      "order_line_id": "0002_3202630-A-2",
      "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 cancel 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"
}