Get order upsell recommendation

Get a list of products to be recommended to the creator of the given order.

Authentication

The retrieval of an order upsell recommendation can be authenticated in multiple ways.

  • Basic access authorization: The application must have permission to access this order.
  • Bearer token: The application will have access if it created the order.
  • Cognito token: The user represented by the token must be the creator of the order.
  • Order token: The token has to match the order token in our system.

Response

Field name Type Description
show_images Boolean Whether to show images when recommending upsell products.
products List of products (see below) A list of products for recommendation.

Example

[GET] https://shopping-api.paylogic.com/orders/87a2195h3gd162fb35c5a3dbd7bapo1l/upsell-recommendation
{
    "_links": {
        "upsell_sale": {"href": "https://shopping-api.paylogic.com/sales/44939815dc174465b8b9c14b37cdf163"},
        "upsell_shop": {"href": "https://frontoffice.paylogic.nl/?event_id=296&point_of_sale_id=896"}
    },
    "show_images": False,
    "products": [
        {
            "_links": {
                "self": {"href": "https://shopping-api.paylogic.com/products/47f1589f03414c54b18444fab8fe2065"},
                "shop:event": {"href": "https://shopping-api.paylogic.com/events/6cc7e597211c43edbd8c5cdb7539f998"},
                "profile": {
                    "href": "https://shopping-api-docs.paylogic.com/documentation/product.html",
                    "type": "text/html"
                },
                "curies": [
                    {
                        "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                        "name": "shop",
                        "templated": True,
                        "type": "text/html"
                    }
                ]
            },
            "uid": "47f1589f03414c54b18444fab8fe2065",
            "reference": "744",
            "name": {
                "en": "Simple product 3",
                "nl": "Gewoon product 3",
                "de": "",
                "es": "",
                "fr": "",
                "pt": ""
            },
            "label": None,
            "subtitle": {
                "en": "",
                "nl": "",
                "de": "",
                "es": "",
                "fr": "",
                "pt": ""
            },
            "price": {
                "amount": "2.50",
                "currency": "EUR"
            },
            "sold_out_text": {
                "en": "",
                "nl": "",
                "de": "",
                "es": "",
                "fr": "",
                "pt": ""
            },
            "sale_start": "2022-07-02T18:38:42Z",
            "sale_end": "2022-08-23T18:38:42Z",
            "min_per_order": None,
            "max_per_order": None,
            "separately_saleable": True,
            "additional_information": {
                "en": "",
                "nl": "",
                "de": "",
                "es": "",
                "fr": "",
                "pt": ""
            },
            "viewing_order": 3,
            "parents": None,
            "combo": None,
            "personalization_required": False,
            "types": ["NULL", "NULL", "NULL"],
            "requires_membership": False,
            "provides_membership": False,
            "images": [],
            "price_breakdown": {
                "unit_price_including_service_costs": {"amount": "4.50", "currency": "EUR"},
                "unit_price_excluding_service_costs": {"amount": "2.50", "currency": "EUR"},
                "unit_price_service_costs": {"amount": "2.00", "currency": "EUR"},
                "total_including_service_costs": {"amount": "4.50", "currency": "EUR"},
                "total_excluding_service_costs": {"amount": "2.50", "currency": "EUR"},
                "total_service_costs": {"amount": "2.00", "currency": "EUR"}
            }
        }
    ]
}