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

Request

Call Frequency

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

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

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_ORDER_CANCEL)

Path

order_idstringrequired

Order's identifier

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

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?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_lines": [
      {
        "id": "Order_00013-A-1",
        "reason_code": "34"
      }
    ]
  }'

Responses

No Content