Calculate the discounts for a specified basket

curl --request POST \
  --url https://{host}/pos-discount/v1/discounted-baskets \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "470b553e-9457-46c8-89dc-574def394dc4",
  "storeId": "475",
  "total": 650,
  "lineItems": [
    {
      "id": "829a834a-420a-48ed-ae98-a3232a59be02",
      "barcode": "5700123969094",
      "quantity": 2,
      "sequenceNumber": 1,
      "totalSalePrice": 200,
      "product": {
        "id": "87e1887d-e747-46de-a653-603494e2b78e",
        "displayName": "Banana",
        "categoryId": "1",
        "category": "Fruits",
        "taxCode": "A",
        "salePrice": 100,
        "unitOfMeasure": "Piece",
        "units": 1
      }
    },
    {
      "id": "c06b2a38-16a6-4e6b-b8fc-4f39fd7e093d",
      "barcode": "5700123969095",
      "quantity": 3,
      "sequenceNumber": 2,
      "totalSalePrice": 450,
      "product": {
        "id": "a108cb6d-8c5f-4f7d-93ff-3f0f2005a5df",
        "displayName": "Orange",
        "categoryId": "1",
        "category": "Fruits",
        "taxCode": "A",
        "salePrice": 150,
        "unitOfMeasure": "Piece",
        "units": 1
      }
    }
  ],
  "discounts": [],
  "coupons": []
}
'

{
  "id": "<string>",
  "total": 123,
  "finalTotal": 123,
  "lineItems": [
    {
      "id": "<string>",
      "parentId": "<string>",
      "linkType": "Unknown",
      "barcode": "<string>",
      "quantity": 123,
      "sequenceNumber": 123,
      "totalSalePrice": 123,
      "product": {
        "id": "<string>",
        "displayName": "<string>",
        "categoryIds": [
          "<string>"
        ],
        "categoryId": "<string>",
        "category": "<string>",
        "taxCode": "<string>",
        "ageRequirement": 123,
        "salePrice": 123,
        "unitOfMeasure": "<string>",
        "units": 123,
        "depositItem": {
          "id": "<string>",
          "displayName": "<string>",
          "categoryId": "<string>",
          "category": "<string>",
          "taxCode": "<string>",
          "ageRequirement": 123,
          "salePrice": 123,
          "unitOfMeasure": "<string>",
          "units": 123
        },
        "hamperItems": [
          {
            "id": "<string>",
            "displayName": "<string>",
            "categoryId": "<string>",
            "category": "<string>",
            "taxCode": "<string>",
            "ageRequirement": 123,
            "salePrice": 123,
            "unitOfMeasure": "<string>",
            "units": 123
          }
        ]
      },
      "discounts": [
        {
          "id": "<string>",
          "couponId": "<string>",
          "couponIds": [
            "<string>"
          ],
          "description": "<string>",
          "fundedBy": "<string>",
          "value": 123,
          "applicationsNumber": 123,
          "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
          "rewardRedeemableTo": "2023-11-07T05:31:56Z"
        }
      ],
      "coupons": [
        {
          "couponId": "<string>",
          "barcode": "<string>",
          "sequenceNumber": 123,
          "description": "<string>",
          "value": 123,
          "campaignId": "<string>",
          "expiryDate": "2023-11-07T05:31:56Z",
          "dateToPickUp": "2023-11-07T05:31:56Z"
        }
      ],
      "finalTotalSalePrice": 123,
      "bonusTotalAmount": 123,
      "bonuses": [
        {
          "id": "<string>",
          "couponId": "<string>",
          "couponIds": [
            "<string>"
          ],
          "description": "<string>",
          "fundedBy": "<string>",
          "value": 123,
          "applicationsNumber": 123,
          "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
          "rewardRedeemableTo": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "discounts": [
    {
      "id": "<string>",
      "couponId": "<string>",
      "couponIds": [
        "<string>"
      ],
      "description": "<string>",
      "fundedBy": "<string>",
      "value": 123,
      "applicationsNumber": 123,
      "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
      "rewardRedeemableTo": "2023-11-07T05:31:56Z",
      "appliedLineItems": {}
    }
  ],
  "bonuses": [
    {
      "id": "<string>",
      "couponId": "<string>",
      "couponIds": [
        "<string>"
      ],
      "description": "<string>",
      "fundedBy": "<string>",
      "value": 123,
      "applicationsNumber": 123,
      "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
      "rewardRedeemableTo": "2023-11-07T05:31:56Z",
      "appliedLineItems": {}
    }
  ],
  "coupons": [
    {
      "couponId": "<string>",
      "barcode": "<string>",
      "sequenceNumber": 123,
      "description": "<string>",
      "value": 123,
      "campaignId": "<string>",
      "expiryDate": "2023-11-07T05:31:56Z",
      "dateToPickUp": "2023-11-07T05:31:56Z"
    }
  ]
}

POST

discounted-baskets

curl --request POST \
  --url https://{host}/pos-discount/v1/discounted-baskets \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "470b553e-9457-46c8-89dc-574def394dc4",
  "storeId": "475",
  "total": 650,
  "lineItems": [
    {
      "id": "829a834a-420a-48ed-ae98-a3232a59be02",
      "barcode": "5700123969094",
      "quantity": 2,
      "sequenceNumber": 1,
      "totalSalePrice": 200,
      "product": {
        "id": "87e1887d-e747-46de-a653-603494e2b78e",
        "displayName": "Banana",
        "categoryId": "1",
        "category": "Fruits",
        "taxCode": "A",
        "salePrice": 100,
        "unitOfMeasure": "Piece",
        "units": 1
      }
    },
    {
      "id": "c06b2a38-16a6-4e6b-b8fc-4f39fd7e093d",
      "barcode": "5700123969095",
      "quantity": 3,
      "sequenceNumber": 2,
      "totalSalePrice": 450,
      "product": {
        "id": "a108cb6d-8c5f-4f7d-93ff-3f0f2005a5df",
        "displayName": "Orange",
        "categoryId": "1",
        "category": "Fruits",
        "taxCode": "A",
        "salePrice": 150,
        "unitOfMeasure": "Piece",
        "units": 1
      }
    }
  ],
  "discounts": [],
  "coupons": []
}
'

{
  "id": "<string>",
  "total": 123,
  "finalTotal": 123,
  "lineItems": [
    {
      "id": "<string>",
      "parentId": "<string>",
      "linkType": "Unknown",
      "barcode": "<string>",
      "quantity": 123,
      "sequenceNumber": 123,
      "totalSalePrice": 123,
      "product": {
        "id": "<string>",
        "displayName": "<string>",
        "categoryIds": [
          "<string>"
        ],
        "categoryId": "<string>",
        "category": "<string>",
        "taxCode": "<string>",
        "ageRequirement": 123,
        "salePrice": 123,
        "unitOfMeasure": "<string>",
        "units": 123,
        "depositItem": {
          "id": "<string>",
          "displayName": "<string>",
          "categoryId": "<string>",
          "category": "<string>",
          "taxCode": "<string>",
          "ageRequirement": 123,
          "salePrice": 123,
          "unitOfMeasure": "<string>",
          "units": 123
        },
        "hamperItems": [
          {
            "id": "<string>",
            "displayName": "<string>",
            "categoryId": "<string>",
            "category": "<string>",
            "taxCode": "<string>",
            "ageRequirement": 123,
            "salePrice": 123,
            "unitOfMeasure": "<string>",
            "units": 123
          }
        ]
      },
      "discounts": [
        {
          "id": "<string>",
          "couponId": "<string>",
          "couponIds": [
            "<string>"
          ],
          "description": "<string>",
          "fundedBy": "<string>",
          "value": 123,
          "applicationsNumber": 123,
          "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
          "rewardRedeemableTo": "2023-11-07T05:31:56Z"
        }
      ],
      "coupons": [
        {
          "couponId": "<string>",
          "barcode": "<string>",
          "sequenceNumber": 123,
          "description": "<string>",
          "value": 123,
          "campaignId": "<string>",
          "expiryDate": "2023-11-07T05:31:56Z",
          "dateToPickUp": "2023-11-07T05:31:56Z"
        }
      ],
      "finalTotalSalePrice": 123,
      "bonusTotalAmount": 123,
      "bonuses": [
        {
          "id": "<string>",
          "couponId": "<string>",
          "couponIds": [
            "<string>"
          ],
          "description": "<string>",
          "fundedBy": "<string>",
          "value": 123,
          "applicationsNumber": 123,
          "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
          "rewardRedeemableTo": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "discounts": [
    {
      "id": "<string>",
      "couponId": "<string>",
      "couponIds": [
        "<string>"
      ],
      "description": "<string>",
      "fundedBy": "<string>",
      "value": 123,
      "applicationsNumber": 123,
      "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
      "rewardRedeemableTo": "2023-11-07T05:31:56Z",
      "appliedLineItems": {}
    }
  ],
  "bonuses": [
    {
      "id": "<string>",
      "couponId": "<string>",
      "couponIds": [
        "<string>"
      ],
      "description": "<string>",
      "fundedBy": "<string>",
      "value": 123,
      "applicationsNumber": 123,
      "rewardRedeemableFrom": "2023-11-07T05:31:56Z",
      "rewardRedeemableTo": "2023-11-07T05:31:56Z",
      "appliedLineItems": {}
    }
  ],
  "coupons": [
    {
      "couponId": "<string>",
      "barcode": "<string>",
      "sequenceNumber": 123,
      "description": "<string>",
      "value": 123,
      "campaignId": "<string>",
      "expiryDate": "2023-11-07T05:31:56Z",
      "dateToPickUp": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

offerTypes

string[]

List of Offer types to consider during discount calculation

excludedOfferTypes

string[]

List of Offer types to exclude during discount calculation

skipReservation

boolean

When set tot true, coupons that granted discount/bonus will not be reserved

preserveExternalDiscounts

boolean

When set, controls whether external discounts are preserved in the response, overriding the PreserveExternalDiscounts feature flag

Body

The specified basket that the discounts need to be calculated for.

The current basket state

string | null

The basket identifier

storeId

string | null

The store identifier

customer

object

Represents the customer associated with the basket

Show child attributes

checkoutType

string | null

The checkout type used during the purchase. If provided, only discounts matching this type will be considered.

purchaseTime

string<date-time> | null

Time when purchase was made. If provided, coupons avaialble at that time will be retrieved instead of currently available coupons

total

number<double>

The basket total

lineItems

object[] | null

The basket line items

Show child attributes

discounts

object[] | null

The set of basket-level discounts

Show child attributes

coupons

object[] | null

The set of coupons associated with basket-level discounts

Show child attributes

Response

Represents an updated basket state with the currently applicable discounts and their calculations

string | null

The basket identifier

total

number<double>

The initial basket total

finalTotal

number<double>

The updated basket total (after discounts have been applied)

lineItems

object[] | null

The set of line items associated with the current basket

Show child attributes

discounts

object[] | null

The set of basket-level discounts associated with the current basket

Show child attributes

bonuses

object[] | null

The set of basket-level bonuses associated with the current basket

Show child attributes

coupons

object[] | null

The set of coupons associated with the basket-level discounts

Show child attributes

Last modified on August 10, 2026

⌘I