.. index:: SearchResult

.. _search_result:

Search result
=============

A single result in a list of search results.

Fields
------

.. apifields::
    .. apifield::
        :name: itemId
        :type: string
        :constraints: ---
        :required: true
        :updateable: false
        :writable: false

        Unique reference to the Marktplaats advertisement

    .. apifield::
        :name: categoryId
        :type: int
        :constraints: ---
        :required: true
        :writable: false
        :updateable: false

        The category in which the advertisement is placed.

        An integer value from the category list. Must be a L2 category (see :ref:`categories <categories>`).

    .. apifield::
        :name: title
        :type: string
        :constraints: --
        :required: true
        :updateable: false
        :writable: false

        Any string with a minimum of 3 characters, up to 60 characters. Urls are not allowed as part of the title.

    .. apifield::
        :name: description
        :type: string
        :constraints: --
        :required: true
        :updateable: false
        :writable: false

        The description field of the ad.

    .. apifield::
        :name: priceModel
        :type: :ref:`Price Model <price_models>`
        :constraints: --
        :required: true
        :updateable: true
        :writable: false

    .. apifield::
        :name: seller
        :type: object
        :constraints: --
        :required: false
        :writable: false

    .. apifield::
        :name: seller.sellerId
        :type: int
        :constraints: --
        :required: false
        :writable: false
        :updateable: false

    .. apifield::
        :name: seller.sellerName
        :type: string
        :constraints: --
        :required: false
        :writable: false
        :updateable: false

    .. apifield::
        :name: seller.phoneNumber
        :type: string
        :constraints: --
        :required: false
        :writable: false
        :updateable: false

    .. apifield::
        :name: location
        :type: object
        :constraints: --
        :required: false
        :updateable: false
        :writable: false

    .. apifield::
        :name: location.postcode
        :type: string
        :constraints: --
        :required: false
        :updateable: false
        :writable: false

    .. apifield::
        :name: location.cityName
        :type: string
        :constraints: --
        :required: false
        :updateable: false
        :writable: false

    .. apifield::
        :name: seller.acceptPaypal
        :type: boolean
        :constraints: --
        :required: false
        :updateable: false
        :writable: false

        Accept bank or creditcard payments via PayPal

    .. apifield::
        :name: locale
        :type: string
        :constraints: valid locale
        :required: false
        :updateable: false
        :writable: false

        Locale (language) of the Ad, mainly title and Description


Relations
---------

.. relations::
    .. relation::
        :name: mp:advertisement
    .. relation::
        :name: mp:category
    .. relation::
        :name: mp:seller
    .. relation::
        :name: mp:advertisement-website-link
    .. relation::
        :name: mp:advertisement-image
        :embedded: yes