Retrieving Discounts

The Discount API enables shop owners to add free value to their customers by discounting a percentage or a fixed sum of an order’s subtotal or an item’s price. Discounts can be applied to a purchase in 2 ways:

1. Discounts applied to carts based on certain conditions, called cart rules;
2. Price reductions provided when redeeming a discount voucher.

Discounts provided based on cart rules are calculated and taken into account automatically. Vouchers, on the other hand, need to be applied by customers explicitly. For this purpose, the Discounts API allows:

• applying a voucher to a certain purchase contained in a specific cart;
• retrieving the discounted amount of the purchase;
• checking which vouchers and cart rules are applied to a certain purchase;
• removing a voucher from a cart.

In your development, the API will help you to enable customers to apply voucher discounts to their purchases and check the correct order amount, discount included.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see GLUE: Promotions & Discounts Feature Integration.

Applying Discount Vouchers

To apply a discount voucher, first, a customer needs to have a cart with some products in it.

Request

To apply a discount voucher to a cart, you need to send it via a POST request to the following endpoints:

• /carts/{{uuid}}/vouchers - for carts of registered users;

• /guest-carts/{{uuid}}/vouchers - for guest carts.

Request sample: POST http://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers

where 1ce91011-8d60-59ef-9fe0-4493ef3628b2 is the UUID of the customer’s cart.

Request Attributes

Request Sample

{
    "data": {
        "type": "vouchers",
        "attributes": {
            "code": "mydiscount-qa1ma"
        }
    }
}

Response

The endpoints respond with information on the cart to which the discount is applied. Brief voucher information is available in the discounts section.

{
    "data": {
        "type": "carts",
        "id": "56a0b4e4-21d8-516f-acd5-90581c996676",
        "attributes": {
            "priceMode": "GROSS_MODE",
            "currency": "EUR",
            "store": "DE",
            "name": "Shopping cart",
            "isDefault": true,
            "totals": {...},
            "discounts": [
                {
                    "displayName": "My Discount",
                    "amount": 83133,
                    "code": null
                },
                {
                    "displayName": "10% Discount for all orders above",
                    "amount": 33253,
                    "code": null
                }
            ]
        },
        "links": {...},
        "relationships": {
            "vouchers": {
                "data": [
                    {
                        "type": "vouchers",
                        "id": "mydiscount-qa1ma"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "vouchers",
            "id": "mydiscount-qa1ma",
            "attributes": {
                "amount": 83133,
                "code": "mydiscount-qa1ma",
                "discountType": "voucher",
                "displayName": "My Discount",
                "isExclusive": false,
                "expirationDateTime": "2020-02-29 00:00:00.000000",
                "discountPromotionAbstractSku": null,
                "discountPromotionQuantity": null
            },
            "links": {
                "self": "http://glue.mysprykershop.com/vouchers/mydiscount-qa1ma?include=vouchers"
            }
        }
    ]
}

Possible Errors

Viewing Discounts Applied to a Purchase

Request

To view discounts applied to a purchase, send a GET request to the corresponding carts resource and include the discounts you want to retrieve as relationships.

Request Samples:

• /carts/{{uuid}}?include=vouchers - vouchers applied to a registered user’s cart;

• /carts/{{uuid}}?include=cart-rules - cart rules applied to a registered user’s cart.

• /guest-carts/{{uuid}}?include=vouchers - vouchers applied to a guest cart.

• /guest-carts/{{uuid}}?include=cart-rules - cart rules applied to a guest cart.

Request samples:

GET http://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=vouchers

GET http://glue.mysprykershop.com/guest-carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=cart-rules

GET http://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2?include=vouchers,cart-rules

where 1ce91011-8d60-59ef-9fe0-4493ef3628b2 is the cart ID.

Response

The endpoints respond with the cart information. The voucher data and the applied cart rules are available in the included section.

Voucher Attributes

• The fields mentioned are all attributes in the response. Type and ID are not mentioned.

Cart Rules Attributes

{
    "data": {
        "type": "carts",
        "id": "1ce91011-8d60-59ef-9fe0-4493ef3628b2",
        "attributes": {...},
        "links": {...},
        "relationships": {
            "vouchers": {
                "data": [
                    {
                        "type": "vouchers",
                        "id": "mydiscount-yu8je"
                    }
                ]
            },
            "cart-rules": {
                "data": [
                    {
                        "type": "cart-rules",
                        "id": "1"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "vouchers",
            "id": "mydiscount-yu8je",
            "attributes": {
                "amount": 49898,
                "code": "mydiscount-yu8je",
                "discountType": "voucher",
                "displayName": "My Discount",
                "isExclusive": false,
                "expirationDateTime": "2020-02-29 00:00:00.000000",
                "discountPromotionAbstractSku": null,
                "discountPromotionQuantity": null
            },
            "links": {
                "self": "http://glue.mysprykershop.com/vouchers/mydiscount-yu8je"
            }
        },
        {
            "type": "cart-rules",
            "id": "1",
            "attributes": {
                "amount": 19959,
                "code": null,
                "discountType": "cart_rule",
                "displayName": "10% Discount for all orders above",
                "isExclusive": false,
                "expirationDateTime": "2020-12-31 00:00:00.000000",
                "discountPromotionAbstractSku": null,
                "discountPromotionQuantity": null
            },
            "links": {
                "self": "http://glue.mysprykershop.com/cart-rules/1"
            }
        }
    ]
}

Possible Errors

Removing Vouchers

Request To unapply a discount voucher, send a DELETE request to the following endpoints:

• /carts/{{uuid}}/vouchers/{{voucher_id}} - for carts of registered users;

• /guest-carts/{{uuid}}/vouchers/{{voucher_id}} - for guest carts.

Request sample: DELETE http://glue.mysprykershop.com/carts/1ce91011-8d60-59ef-9fe0-4493ef3628b2/vouchers/mydiscount-we3ca

where:

• 1ce91011-8d60-59ef-9fe0-4493ef3628b2 - is the UUID of the customer’s cart;
• mydiscount-we3ca - is the voucher ID.