taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

delete-private-orders-ORDER_ID.rst (1222B)

      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   **Request:**
      8 
      9   :query force: *Optional*. If set to YES, the order will be deleted
     10       even if it was already claimed. Note that even with force, a
     11       paid order cannot be deleted.
     12 
     13   **Response:**
     14 
     15   :http:statuscode:`204 No content`:
     16     The backend has successfully deleted the order.
     17   :http:statuscode:`401 Unauthorized`:
     18     The request is unauthorized.
     19   :http:statuscode:`404 Not found`:
     20     The backend does not know the instance or the order.
     21     Returned with ``TALER_EC_MERCHANT_GENERIC_ORDER_UNKNOWN``.
     22   :http:statuscode:`409 Conflict`:
     23     The backend refuses to delete the order.
     24     Returned with ``TALER_EC_MERCHANT_PRIVATE_DELETE_ORDERS_ALREADY_PAID`` or
     25     ``TALER_EC_MERCHANT_PRIVATE_DELETE_ORDERS_AWAITING_PAYMENT``.
     26   :http:statuscode:`500 Internal Server Error`:
     27     The server experienced an internal failure.
     28     Returned with ``TALER_EC_GENERIC_DB_COMMIT_FAILED`` or
     29     ``TALER_EC_GENERIC_INTERNAL_INVARIANT_FAILURE``.