OR33 - Fully cancel a list of order lines of an order

Request

Description

If the Shop partial cancelation feature is enabled by Mirakl Support Team:

for PAY_ON_DELIVERY, PAY_ON_DUE_DATE or PAY_ON_SHIPMENT workflows: shop can only cancel a non-debited order.
for NO_CUSTOMER_PAYMENT_CONFIRMATION workflow: shop can only cancel an unshipped order.

Call Frequency

Recommended usage: At each order (or order line) cancelation

Maximum usage: At each order (or order line) cancelation

Security

Front-Bearer-Token or OAuth-2

Path

order_idstringrequired

Order's identifier

Bodyapplication/json

order_linesArray of objects, [ 1 .. 100 ] itemsrequired

List of order line's representations, maximum number of order lines per call: 100

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/{order_id}/cancel-order-lines' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_lines": [
      {
        "id": "Order_00013-A-1",
        "reason_code": "34"
      }
    ]
  }'

Responses

No Content