********
Consumer
********
Consumer represents the information of an event visitor or an order consumer.

Accepted methods
================
* **GET**: Retrieve the details of a single consumer.

Accepted query parameters
=========================
None.

Data
====
All fields of :doc:`consumer` object. Inserted here for ease of reference.

============== ============= ==========================================================================================================================================================================================================================================================================================================================================
Field name     Type          Description
============== ============= ==========================================================================================================================================================================================================================================================================================================================================
uid            String        Optional, a machine readable id for this consumer, used in communication with the API. For ``POST`` methods, you can only use uid to refer to an existing consumer, and then the fields below will be all optional, as the consumer data exists in the records. If any other field provided, a new revision of the consumer will be created.
first_name     String        The first name of the consumer.
last_name      String        The last name of the consumer.
date_of_birth  Date          The date of birth of the consumer.
email          String        The email of the consumer, which can be used for any correspondence about their order or ticket.
gender         Number        The gender of the consumer (0=unknown, 1=male, 2=female, 9=other).
phone_number   String        The telephone number of the consumer.
address        String        The street and house number of the consumer.
postal_code    String        The postal code (or zipcode) of the consumer.
city           String        The city of residence of the consumer.
country        String        The country of the consumer.
state          String        The state of the consumer. Optional; only required when the country is the USA or Brazil.
language       String        Language code of the consumer (ISO 639-1). Optional.
cognito_user   UUID          Optional Cognito User ID, if Cognito is enabled for the channel for which this consumer was created.
============== ============= ==========================================================================================================================================================================================================================================================================================================================================

Embedded resources
==================
None.

Example representation
======================
.. code-block:: bash

    [GET] https://shopping-api.paylogic.com/consumers/cba40d60019448278542c9f5ac1bf7ce

.. code-block:: javascript

    {
        "_links": {
            "curies": [
                {
                    "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                    "name": "shop",
                    "templated": true,
                    "type": "text/html"
                }
            ],
            "profile": {
                "href": "https://shopping-api-docs.paylogic.com/documentation/consumer.html",
                "type": "text/html"
            },
            "self": {
                "href": "https://shopping-api.paylogic.com/consumers/cba40d60019448278542c9f5ac1bf7ce"
            }
        },
        "uid": "cba40d60019448278542c9f5ac1bf7ce",
        "cognito_user": "c1c35532-1e0e-455e-83c5-d0e52b3206fa",
        "address": "Some street 31",
        "city": "Some city",
        "country": "US",
        "date_of_birth": "1990-01-01",
        "email": "john.smith.last@example.com",
        "first_name": "John",
        "last_name": "Smith",
        "gender": 1,
        "phone_number": "+31 6 11 123456",
        "postal_code": "1234",
        "state": "UT",
        "language": "en"
    }