Handling Line Item Discounts

Overview

This document outlines the process for managing line item discounts within the cart of an e-commerce platform. The e-commerce system allows the application of discounts to individual products (line items) when sending the cart for validation or saving the sale.

Discount Fields

When applying a discount to a line item, the following fields should be used:

discount: This field specifies the value of the discount applied to the line item. Depending on the type of discount (discountType), this value can be either a percentage or a fixed amount.

If discountType is set to P (percentage), the value in discount should represent a percentage (e.g., 10 for a 10% discount).

If discountType is set to N (value), the value in discount should represent a fixed monetary amount (e.g., 10 for a $10 discount).

discountType: This field indicates the type of discount being applied. It can take on one of the following two values:

P: Represents a percentage-based discount.

N: Represents a fixed value discount.

discountReason: This field contains the code representing the reason for the discount. The discount reasons are pre-defined within the system and can be configured in the suite. These discount reasons can also be utilized by Mobile Shop to enable sales associates to apply manual discounts.

discountReasonDescription: This field provides a description of the discount reason code. It should clearly explain why the discount was applied to the line item.

Example

Here is an example of how these fields would be populated in a cart's line item:

Row percentage discount

Row amount discount

In this case, a 10% discount has been applied to the line item because the discountType is set to "P". The discount value can be seen in the discountPerc attribute, while the discount code and reason are provided in the discountReason and discountReasonDescription attributes, respectively.

{
"transactionId": "{% faker datatype.uuid %}",
"movementType": "V",
"barcodeInfo": "{{ean13}}",
"currency": "EUR",
"currencySymbol": "€",
"branchCode": "9999",
"entityCode": "501",
"docNumberDigital": "{% faker random.numeric %}",
"docNumber": "TICKET_{% faker random.numeric %}",
"endDate": "2024-07-22 10:07:49",
"startDate": "2024-07-22 10:07:49",
"deliveryDate": "2024-07-22 10:07:49",
"clientDenomination": "Mario Rossi",
"discountsManualCumulative": "N",
"registerCode": "1",
"clientId": "11111",
"ticket": 240905,
"rounding": 2,
"onlineValidation": "Y",
"seller": "Marco Bianchi",
"sellerId": 1001,
"filling": "FIRST",
"callback": "https://webhook.site/782f0878-03b5-47ff-86b3-0f555bdca511",
"items":
[
    {
        "rowId": "{% faker datatype.uuid %}",
        "rowType": "ITEM",
        "barcode": "8058251375998",
        "barcodeType": "EAN13",
        "unitPrice": 215,
        "qty": 1,
        "qtyType": "N",
        "itemState": "SERVER_OK",
        "taxRate": 22,
        "vatCode": 4,
        "rowVat": 34.89,
        "rowTotal": 193.5,
        "description": "Descrizione del prodotto",
        "discount": 30,
        "discountType": "P",
        "discountReason": "SC_RIGA_PERC",
        "discountReasonDescription": "Sconto riga percentuale",
        "itemType": "PRODUCT",
        "itemSubtype": "ITEM",
        "qtaConfirmed": "Y",
        "movementType": "V",
        "printerDepartmentCode": 1,
        "havingTailoring": "N",
        "itemCode": "033---00000",
        "currencySymbol": "€",
        "currency": "EUR",
        "rounding": 2,
        "oldUnitPrice": 215,
        "priceList": "80",
        "rowOrder": 1,
        "channel": "IN_STORE"
    }
],
"totals":
{
    "total": 193.5,
    "vat":34.89,
    "grandTotal": 193.5,
    "allowance": 0,
    "alreadyPayed": 0,
    "taxableIncome": 193.5,
    "digitalGrandTotal": 0,
    "totalDeposits": 0,
    "totalDepositsVat": 0
}
}

Validation and Save Process

When the e-commerce system sends the cart for validation (Cart Validation Service) or to save the sale (for example E-commerce Recipt Processing with 4ws.trade or E-commerce Order sale Processing with 4ws.trade), each line item with an applied discount should include these fields. The system will use this information to correctly process the discount, ensuring it is reflected in the total sale and recorded for future reference.

Discount reasons

All discount reasons must be pre-configured in the suite to ensure consistency and accuracy in reporting and auditing. Sales associates applying manual discounts through Mobile Shop should select from these pre-defined reasons to maintain uniformity across all platforms.

Handling Line Item Discounts