Products

Products is a collection resource consisting of all active products, of an active event, which an application has access to.

Accepted methods

• GET: Retrieve the list of all products.

Accepted query parameters

Field name	Description
name	Name exact match
name__startswith	Name starts with
subtitle	Subtitle exact match
subtitle__startswith	Subtitle starts with
price	Price exact match
price__lt	Price less than
price__lte	Price less-than or equal
price__gt	Price greater than
price__gte	Price greater than or equal
price_cur	Price currency
is_soldout	Product is sold out
event	Event URI
sale_start	Sale start date
sale_end	Sale end date

Data

Field name	Type	Description
item_count	Integer	The number of products in the collection.

Link relations

• Search

• First

• Prev

• Next

• Last

Embedded resources

• Product (list)

Example representation

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

{
    "_links": {
        "self": { "href": "https://shopping-api.paylogic.com/products?page=2" },
        "curies": [
            { "name": "shop", "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "templated": true, "type": "text/html" },
        ],
        "profile": { "href": "https://shopping-api-docs.paylogic.com/documentation/products.html", "type": "text/html" },
        "search": { "href": "https://shopping-api.paylogic.com/products{?name,subtitle,price,currency,sold_out}", "templated": true },
        "first": { "href": "https://shopping-api.paylogic.com/products" },
        "prev": { "href": "https://shopping-api.paylogic.com/products?page=1" },
        "next": { "href": "https://shopping-api.paylogic.com/products?page=3" },
        "last": { "href": "https://shopping-api.paylogic.com/products?page=10" }
    },
    "item_count": 183,
    "_embedded": {
        "shop:product": [
            {
                "_links": {
                    "curies": [
                        { "name": "shop", "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "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.com/products/6214630d91964b8199067963090bee28"
                    },
                    "shop:event": {
                        "href": "https://shopping-api.paylogic.com/events/4c508795d1814fc2875edc782267d8b9"
                    }
                },
                "name": {
                    "en": "Ticket1 Onion Junk Explosive"
                },
                "price": {
                    "amount": "1.20",
                    "currency": "EUR"
                },
                "sold_out": false,
                "sold_out_text": {
                    "de": "",
                    "en": "",
                    "es": "",
                    "fr": "",
                    "nl": "",
                    "pt": "",
                    "tr": ""
                },
                "subtitle": {
                    "en": "Subtitle1 Vulture Parachute Insect"
                },
                "min_per_order": null,
                "max_per_order": null,
                "separately_saleable": true,
                "uid": "6214630d91964b8199067963090bee28",
                "sale_end": "2021-11-30T20:59:00Z",
                "sale_start": "2011-11-30T22:24:00Z"
            }
        ]
    }
}