Products
/- Mirakl Platform
- Rest Operator APIs
- OR29 - Perform a full cancelation of an order
OR04 - Patch update orders
OR11 - List orders with pagination
OR75 - List all the order taxes available on the platform
OR07 - Update order line shipping origin
OR13 - Export orders asynchronously
OR14 - Get the status of an asynchronous order export.
OR15 - Retrieve order export files once asynchronous export is complete (OR13).
OR21 - Accept or refuse order lines
OR23 - Update carrier tracking information for a specific order
OR24 - Validate the shipment of an order
OR28 - Perform refunds on order lines
OR30 - Perform cancelations on order lines
OR31 - Update the custom fields of an order and its order lines
OR32 - Adjust order line
OR33 - Fully cancel a list of order lines of an order
OR51 - Get the evaluation of an order
OR72 - Lists order's documents
OR73 - Download one or multiple documents attached to one or multiple orders
OR74 - Upload documents to attach to an order
OR76 - Delete an order document
OR12 - Get information about an order
OR26 - Perform a refund of order lines of an order
OR41 - List messages of an order
OR29 - Perform a full can...
⚠️ Content-length header
The Content-Length header must be present with value 0, even when there is no request body.
Description
- for
PAY_ON_DELIVERY,PAY_ON_DUE_DATEorPAY_ON_SHIPMENTworkflows: shop can only cancel a non-debited order. - for
NO_CUSTOMER_PAYMENT_CONFIRMATIONworkflow: shop can only cancel an unshipped order.
Call Frequency
Recommended usage: At each order cancelation
Maximum usage: At each order cancelation
Security
Operator-Bearer-Token or OAuth-2
- URL to be replaced by your Mirakl instance URLhttps://your-instance.mirakl.net/api/orders/{order_id}/cancel
curl -i -X PUT \
'https://your-instance.mirakl.net/api/orders/{order_id}/cancel' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'