.. index:: Order

.. _order:


Order
=====

An order consists of products that you can purchase or have already bought if the status of the order is paid.

Fields
------

Each order has a unique identifier by which it can be retrieved and a set of
required and optional fields which are listed below:

.. apifields::
  .. apifield::
      :name: orderId
      :type: int
      :constraints: --
      :required: true
      :writable: false

      The id of the order.

  .. apifield::
      :name: status
      :type: string
      :constraints: either ``new``, ``payment required``, ``paid``, ``refused``, ``closed`` or ``payment initialization failed``.
      :required: false
      :writable: false

      The status of the order.

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

      The total price for this order in euro cents.


Relations
---------

.. relations::
    .. relation::
        :name: mp:order-products
        :embedded: yes

Reference
---------

.. endpoint:: GET /v1/orders/{orderId}

Retrieve a single order with the given orderId.


Example
-------

.. include:: examples/get-order-example.rst