DELETE /orders/:orderID

Cancels an Order owned by the authenticated User. The Order's status is moved to CANCELLED and, depending on the original status, the associated payment is refunded or the pending hold released. Orders in the following statuses cannot be cancelled:

  • FULFILLED - the Order has already been delivered
  • CANCELLED - the Order has already been cancelled
  • REPLACED - the Order has been replaced by a newer one

Path parameters

  • orderID string Required

    ID of the Order to cancel

Responses

  • 200 application/json

    Order cancelled successfully

    Empty object returned on successful cancellation.

DELETE /orders/:orderID
curl \
 --request DELETE 'https://zim.api.zimconnections.com/orders/:orderID' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-App-Identifier: $API_KEY"
Response examples (200)
{
  "summary": "Order cancelled",
  "value": {}
}