delete-private-orders-ORDER_ID.rst (1738B)
1 .. http:delete:: [/instances/$INSTANCE]/private/orders/$ORDER_ID 2 3 Delete information about an order. Fails if the order was paid in the 4 last 10 years (or whatever ``TAX_RECORD_EXPIRATION`` is set to) or was 5 claimed but is unpaid and thus still a valid offer. 6 7 Since protocol **vMixedPayments**, an order that carries externally 8 settled payments (``amount_external``) can only be deleted by explicitly 9 passing ``force``, as such an order may have received payments outside of 10 Taler that the merchant should resolve manually first. 11 12 **Request:** 13 14 :query force: *Optional*. If set to YES, the order will be deleted 15 even if it was already claimed or carries externally settled 16 payments. Note that even with force, a paid order cannot be deleted. 17 18 **Response:** 19 20 :http:statuscode:`204 No content`: 21 The backend has successfully deleted the order. 22 :http:statuscode:`401 Unauthorized`: 23 The request is unauthorized. 24 :http:statuscode:`404 Not found`: 25 The backend does not know the instance or the order. 26 Returned with ``TALER_EC_MERCHANT_GENERIC_ORDER_UNKNOWN``. 27 :http:statuscode:`409 Conflict`: 28 The backend refuses to delete the order. 29 Returned with ``TALER_EC_MERCHANT_PRIVATE_DELETE_ORDERS_ALREADY_PAID``, 30 ``TALER_EC_MERCHANT_PRIVATE_DELETE_ORDERS_AWAITING_PAYMENT`` or 31 ``TALER_EC_MERCHANT_PRIVATE_DELETE_ORDERS_EXTERNALLY_PAID`` (the latter 32 since protocol **vMixedPayments**, when the order carries externally 33 settled payments and ``force`` was not set). 34 :http:statuscode:`500 Internal Server Error`: 35 The server experienced an internal failure. 36 Returned with ``TALER_EC_GENERIC_DB_COMMIT_FAILED`` or 37 ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE``.