.. index:: Bid

.. _bid:

Bid
===

Bid is an (price) offer for an advertisement. Seller can enable or disable bids on their ads. Bids can have minimal bid and asking price.
See :ref:`bidding <price_model_bidding>` for the more detail.


Fields
------


.. apifields::
    .. apifield::
        :name: bidId
        :type: int
        :constraints: --
        :required: true
        :writable: false
        :updateable: false
        :description: The bid id.

    .. apifield::
        :name: amount
        :type: int
        :constraints: non negative
        :required: true
        :writable: true
        :updateable: false
        :description: The bid amount.

    .. apifield::
        :name: placeDate
        :type: ISO 8601 timestamp
        :constraints: --
        :required: false
        :writable: false
        :updateable: false
        :description: The date the bid has been placed.

    .. apifield::
        :name: bidder.id
        :type: int
        :constraints: --
        :required: true
        :writable: false
        :updateable: false
        :description: The bidder's user id.

    .. apifield::
        :name: bidder.nickName
        :type: string
        :constraints: --
        :required: true
        :writable: true
        :updateable: false
        :description: The nick name of the bidder.

Relations
---------

.. relations::
    .. relation::
        :name: mp:bidder

Reference
---------

.. endpoint:: GET /v1/advertisements/{itemId}/bids/{bidId}

Returns specific bid on the advertisement.

.. endpoint:: DELETE /v1/advertisements/{itemId}/bids/{bidId}

Deletes the specific bid on the advertisement. The bid can be deleted either by the owner of the bid or the owner of
the advertisement.


Errors
------

.. errors::
    .. error::
        :http: 404
        :code: bid-not-found
        :description: The bid doesn't exist
    .. error::
        :http: 403
        :code: unauthorized
        :description: The user is not authorized to delete the bid


Examples
--------

.. include:: examples/get-bid-example.rst
.. include:: examples/delete-bid-example.rst