Root

The root resource will give you access to the resources in the application and has no content other than links to related resources.

Accepted methods

• GET: Retrieve what you can do in the API.

Accepted query parameters

None.

Data

Field name	Type	Description
welcome	String	Welcome text for the API.

Embedded resources

None.

Example representation

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

{
    "_links": {
        "curies": [
            {
                "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                "name": "shop",
                "templated": true,
                "type": "text/html"
            }
        ],
        "help": {
            "href": "https://shopping-api-docs.paylogic.com/",
            "type": "text/html"
        },
        "profile": {
            "href": "https://shopping-api-docs.paylogic.com/documentation/root.html",
            "type": "text/html"
        },
        "self": {
            "href": "https://shopping-api.paylogic.com/"
        },
        "shop:bill": {
            "href": "https://shopping-api.paylogic.com/bill{?products,payment_method,shipping_method,country,external_purchase_amount}",
            "templated": true
        },
        "shop:consumer": {
            "href": "https://shopping-api.paylogic.com/consumers/{uid}",
            "templated": true
        },
        "shop:consumers": {
            "href": "https://shopping-api.paylogic.com/consumers"
        },
        "shop:event": {
            "href": "https://shopping-api.paylogic.com/events/{uid}",
            "templated": true
        },
        "shop:events": {
            "href": "https://shopping-api.paylogic.com/events{?merchant_name,title,subtitle,sale_start,sale_end,event_start,event_end,location_name,location_postal_code,location_city,location_country,artist}",
            "templated": true
        },
        "shop:order": {
            "href": "https://shopping-api.paylogic.com/orders/{uid}",
            "templated": true
        },
        "shop:orders": {
            "href": "https://shopping-api.paylogic.com/orders{?event,status,created,external_reference}",
            "templated": true
        },
        "shop:status": {
            "href": "https://shopping-api.paylogic.com/status"
        },
        "shop:ticket": {
            "href": "https://shopping-api.paylogic.com/tickets/{uid}",
            "templated": true
        },
        "shop:ticket_transfer_approval": {
            "href": "https://shopping-api.paylogic.com/ticket-transfer-approvals/{uid}",
            "templated": true
        },
        "shop:ticket_transfer_approvals": {
            "href": "https://shopping-api.paylogic.com/ticket-transfer-approvals"
        },
        "shop:tickets": {
            "href": "https://shopping-api.paylogic.com/tickets?event={event}&code={barcode}",
            "templated": true
        }
    },
    "welcome": "Welcome to the Paylogic shopping API!"
}