Product

Retrieve a single product

Get all available details of a single product. This request must be authenticated using Basic access authorization or a Bearer token.

Response

Field name	Type	Description
uid	String	A machine readable id for this product, used in communication with the API.
reference	String	A human readable id for products, used in communication with consumers.
name	I18N	The name of the product.
subtitle	I18N	The subtitle of the product, showing additional information.
price	Amount	The price of the product that has to be charged to the consumer.
sold_out_text	I18N	The merchant can provide a text which can be shown to provide more information when the product is sold out.
min_per_order	Integer	The minimum number of products that have to be bought in a single order.
max_per_order	Integer	The maximum number of products that are allowed to be bought in a single order.
separately_saleable	Boolean	Whether the product can be sold alone, or has to be sold in combination with a separately saleable product.
availability	Integer	The remaining available number of products out of total availability.
total_availability	Integer	Total number of products initially configured as available for sale.
additional_information	I18N	Additional information of a product.
viewing_order	Integer	When viewing the products as a list, they are sorted on this order per event.
parents	List of Strings	The URIs of the parent products of this product when this is a combo product.
combo	List of Strings	The URIs of the combo products of this product.
types	List of Strings	Product types descriptions. Value can be used as tags in the application.
sale_start	Datetime	The date and time that the sale for this product’s event has started.
sale_end	Datetime	The date and time that the sale for this product’s event will end.
requires_membership	Boolean	Indicates whether this product requires a membership.
provides_membership	Boolean	Indicates whether this product provides a membership.
metadata	List of Objects	Product metadata filtered for Google Analytics item categories (item_category and item_category1-5).

Link relations

• shop:event: event to which this ticket belongs, see Event.

Example

[GET] https://shopping-api.paylogic.com/products/0c2019503cd666fb35c5a3dbd7bafe86

{
    "_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/product.html",
            "type": "text/html"
        },
        "self": {
            "href": "https://shopping-api.paylogic.nl/products/0c2019503cd666fb35c5a3dbd7bafe86"
        },
        "shop:event": {
            "href": "https://shopping-api.paylogic.nl/events/f0b6844b6f344e72a731a1dbf4ae272e"
        }
    },
    "additional_information": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
    "availability": 0,
    "total_availability": 200,
    "combo": null,
    "min_per_order": 1,
    "max_per_order": 20,
    "name": {"de": "", "en": "Product Name", "es": "", "fr": "", "nl": "Productnaam", "pt": "", "tr": ""},
    "subtitle": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
    "parents": null,
    "price": {
        "amount": "10.00",
        "currency": "EUR"
    },
    "reference": "1669",
    "sale_end": "2021-11-30T20:59:00Z",
    "sale_start": "2011-11-30T22:24:00Z",
    "separately_saleable": true,
    "sold_out_text": {"de": "", "en": "", "es": "", "fr": "", "nl": "", "pt": "", "tr": ""},
    "types": [],
    "uid": "f0d8de67992e49d39bb9d0e818aba1fb",
    "viewing_order": 1,
    "requires_membership": false,
    "provides_membership": true,
    "metadata": [
        {
            "key": "item_category",
            "value": "Tickets"
        },
        {
            "key": "item_category2",
            "value": "Entertainment"
        }
    ]
}