Allegro WebAPI

Programming interface of the Allegro platform

doRequestCancelBid

Group: Buyer
Last change: ---
Availability:
This method allows for sending a request to cancel a bid made by a logged-in user.

  1. session-handle | string | required
    User's session identifier received using the doLogin(Enc) method.
  2. item-id | long | required
    Offer identifier.
  3. request-cancel-reason| string | required
    Bid cancellation reason.



Sample structure of method call

$dorequestcancelbid_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'request-item-id' => 1048196513,
   'request-cancel-reason' => 'Rash decision'
);


  1. request-value | int
    Information on whether the request for bid cancellation has been sent successfully (1 - yes, 0 - no).



Sample structure of server reply

$dorequestcancelbid_response = array(
   'request-value' => 1
);

  • ERR_BLOCKED_USER_CANT_INVOKE_METHOD
    User whose account has been blocked cannot use this method.
  • ERR_GIVE_CANCEL_BIDS_REASON
    Reason for bid cancellation has not been provided.
  • ERR_NO_DATABASE
    Problems with Allegro database.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Invalid session identifier or the session has expired.
  • ERR_WEBAPI_KEY_INACTIVE
    The session-generating WebAPI key has been deactivated (the owner did not accept the User Agreement).
  • ERR_WEBAPI_NOT_AVAIL
    Problems with Allegro WebAPI service.
  • ERR_YOU_NOT_BIDS_ITEM
    It is impossible to cancel the bid as the logged user has made no bid in the indicated offer, or the offer has ended or provided offer identifier is incorrect.

Allegro is not to be held liable for consequences of using examples of the published code. It does not guarantee its correct operation either. The code you see serves as an example only and may contain errors.