Cancels an Order created by the authenticated User. Returns an empty body.
PENDING_PAYMENT/PENDING_APPROVAL- moved toCANCELLED, nothing was chargedPROCESSING/FAILED- the charge is reversed and the Order moves toREFUNDED
Orders in the following statuses cannot be cancelled (400, the reason is given in message):
FULFILLED-CANNOT_CANCEL_FULFILLED_ORDERCANCELLED-ALREADY_CANCELLED_ORDERREPLACED-CANNOT_CANCEL_REPLACED_ORDERREFUNDED-ALREADY_REFUNDED_ORDER
Cancelling an IN_BASKET Order removes it from the basket.
To stop a delivered plan, cancel its Subscription instead.
DELETE
/orders/{orderID}
curl \
--request DELETE 'https://zim.api.zimconnections.com/orders/ordr_GMAVA4ISiqfWSG0ArGOzB' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-App-Identifier: $API_KEY"
Response examples (400)
{
"statusCode": 400,
"message": [
"property foo should not exist"
],
"error": "Bad Request"
}
Response examples (404)
{
"statusCode": 404,
"message": "Record not found",
"error": "Not Found"
}