******************
Storefront seating
******************

The storefront resource represents categorized product choices for a specific event at any one moment in time. The
storefront seating resource is a part of the storefront that has to do with seating information.


Get a storefront seating info
=============================
* **GET**


Accepted query parameters
=========================
========================  ==============================================  ==============================================
Parameter                 Type                                            Description
========================  ==============================================  ==============================================
event                     :doc:`event`                                    URI of the event.
sale                      Link                                            URI of the sale.
basket                    Link                                            URI of the basket. This can be used as alternative for the sale URI.
vouchers                  List of Strings                                 Optional list of voucher codes.
cache_allowed             Boolean                                         Optional bool whether the storefront can be cached. Defaults to true.
========================  ==============================================  ==============================================


Embedded resources
==================

* :doc:`/objects/assigned_seat`: list of seats available at this storefront.
* :doc:`/objects/unplaced_section`: list of unplaced sections related to this storefront.


Example representation
======================

.. code-block:: bash

    [GET] https://shopping-api.paylogic.com/storefront/seating?event=https%3A%2F%2Fshopping-api.paylogic.com%2Fevents%2F6eeda079963c4060899309f26a6dec2f


.. code-block:: javascript


    {
        "_embedded": {
            "shop:seat": [
                {
                    "_links": {
                        "self": {"href": "https://shopping-api.paylogic.com/seats/6aa9a3f74ffd40e2a6251fb5bf3b98b7"},
                        "section": {"href": "https://shopping-api.paylogic.com/sections/28e9b926735741e495952155435e49db"},
                        "product": [
                            {"href": "https://shopping-api.paylogic.com/products/0b43321b3768494cbe455e38dcdeafb3"}
                        ]
                    },
                    "name": "Seat 0",
                    "position": 0,
                    "row": {"name": "Row 0", "code": "price-all-preve"},
                    "is_available": True
                },
                {
                    "_links": {
                        "self": {"href": "https://shopping-api.paylogic.com/seats/3fec2f9cc1174b9dbb47088d471e0989"},
                        "section": {"href": "https://shopping-api.paylogic.com/sections/28e9b926735741e495952155435e49db"},
                        "product": [
                            {"href": "https://shopping-api.paylogic.com/products/0b43321b3768494cbe455e38dcdeafb3"}
                        ]
                    },
                    "name": "Seat 1",
                    "position": 1,
                    "row": {"name": "Row 0", "code": "price-all-preve"},
                    "is_available": True
                },
                {
                    "_links": {
                        "self": {"href": "https://shopping-api.paylogic.com/seats/8fccb18ef5f54b9cb4d1ff618fec60b1"},
                        "section": {"href": "https://shopping-api.paylogic.com/sections/28e9b926735741e495952155435e49db"},
                        "product": [
                            {"href": "https://shopping-api.paylogic.com/products/0b43321b3768494cbe455e38dcdeafb3"}
                        ],
                    },
                    "name": "Seat 2",
                    "position": 2,
                    "row": {"name": "Row 0", "code": "price-all-preve"},
                    "is_available": True
                }
            ],
            "shop:unplaced_section": [
                {
                    "_links": {
                        "self": {"href": "https://shopping-api.paylogic.com/unplaced_sections/c5a7f493c4024a53b481bb64d4b59b6e"},
                        "shop:product": [{"href": "https://shopping-api.paylogic.com/products/e8190e8695a04e8f9758918376af6ffe"}],
                        "curies": [
                            {
                                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                                "name": "shop",
                                "templated": True,
                                "type": "text/html"
                            }
                        ]
                    },
                    "name": "Section A",
                    "code": "heavy-this-ever",
                    "section_label": {
                        "en": "Section",
                        "nl": "Sectie",
                        "de": "Block",
                        "es": "Sección",
                        "fr": "Section",
                        "pt": "Seção"
                    }
                },
                {
                    "_links": {
                        "self": {"href": "https://shopping-api.paylogic.com/unplaced_sections/6400c5d90f1d4b049e89a88365670995"},
                        "shop:product": [{"href": "https://shopping-api.paylogic.com/products/2ea41f0746f647dfb41efe9f4f3513e6"}],
                        "curies": [
                            {
                                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                                "name": "shop",
                                "templated": True,
                                "type": "text/html"
                            }
                        ]
                    },
                    "name": "Section B",
                    "code": "measure-full-ne",
                    "section_label": {
                        "en": "Section",
                        "nl": "Sectie",
                        "de": "Block",
                        "es": "Sección",
                        "fr": "Section",
                        "pt": "Seção"
                    }
                }
            ]
        },
        "_links": {
            "curies": [{
                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                "name": "shop",
                "templated": True,
                "type": "text/html"
            }]
        }
    }


Error handling
==============

Validation errors
-----------------

Request validation errors return 400 (Bad Request) responses with the validation errors in the error details.

.. code-block:: bash

    HTTP/1.1 400 Bad Request

.. code-block:: javascript

    {
        "logref": "<UID>",
        "message": "Bad request.",
        "_links": {
            "help": {
                "href": "http://shopping-api-docs.paylogic.com/documentation/storefront.html"
            }
        },
        "type": "BAD_REQUEST"
    }


Error types
-----------
Error type codes can be used to dispatch the errors on the client side.

================================= =========== ==========================================================================
Type                              HTTP code   Description
================================= =========== ==========================================================================
FORBIDDEN                         403         Forbidden.
NOT_FOUND                         404         Not found.
BAD_REQUEST                       400         Bad request.
VOUCHER_INVALID                   400         Voucher code is invalid.
================================= =========== ==========================================================================