v1
latestOpenAPI 3.0.12026-07-24501176.6 MBGet Cart Promotions for a particular till
This API can be used to fetch the Cart promotions for a particular till
get/api_gateway/v1/promotions/till/{tillId}
Path parameters
tillIdstring required
Request body
Response
200
Example response
{
"data": [
{
"id": "string",
"name": "string",
"active": true,
"messageLabel": "string",
"type": "POS",
"timeCriteria": {
"repeatFrequency": "DOES_NOT_REPEAT",
"weeklyValues": [
"MONDAY"
]
},
"storeCriteria": {
"type": "STORE",
"operator": "IN"
},
"supplementaryCriteria": {
"programType": "TIER"
},
"condition": {
"type": "CART",
"cartCondition": {
"kpi": "SUBTOTAL",
"operator": "EQUALS"
},
"productCondition": {
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
},
"comboProductCondition": {
"productConditions": [
{
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
}
]
},
"tenderCondition": {
"type": "PAYMENT_VOUCHER",
"identifier": "string",
"tenderModes": [
{
"type": "PAYMENT_VOUCHER",
"identifiers": [
"string"
]
}
],
"condition": "string"
}
},
"action": {
"type": "FIXED_PRICE",
"cartBasedAction": {
"type": "PERCENTAGE"
},
"productBasedAction": {
"productBasedCondition": {
"type": "CART",
"cartCondition": {
"kpi": "SUBTOTAL",
"operator": "EQUALS"
},
"productCondition": {
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
},
"comboProductCondition": {
"productConditions": [
{
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
}
]
},
"tenderCondition": {
"type": "PAYMENT_VOUCHER",
"identifier": "string",
"tenderModes": [
{
"type": "PAYMENT_VOUCHER",
"identifiers": [
"string"
]
}
],
"condition": "string"
}
},
"type": "PERCENTAGE",
"includeItemsFromConditionSet": true
},
"fixedPriceAction": {
"productBasedCondition": {
"type": "CART",
"cartCondition": {
"kpi": "SUBTOTAL",
"operator": "EQUALS"
},
"productCondition": {
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
},
"comboProductCondition": {
"productConditions": [
{
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
}
]
},
"tenderCondition": {
"type": "PAYMENT_VOUCHER",
"identifier": "string",
"tenderModes": [
{
"type": "PAYMENT_VOUCHER",
"identifiers": [
"string"
]
}
],
"condition": "string"
}
},
"includeItemsFromConditionSet": true
},
"freeProductAction": {
"productBasedCondition": {
"type": "CART",
"cartCondition": {
"kpi": "SUBTOTAL",
"operator": "EQUALS"
},
"productCondition": {
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
},
"comboProductCondition": {
"productConditions": [
{
"criteriaList": [
{
"entity": "SKU",
"operator": "IN",
"values": [
"string"
],
"attributeName": "string"
}
],
"kpi": "AMOUNT",
"operator": "EQUALS"
}
]
},
"tenderCondition": {
"type": "PAYMENT_VOUCHER",
"identifier": "string",
"tenderModes": [
{
"type": "PAYMENT_VOUCHER",
"identifiers": [
"string"
]
}
],
"condition": "string"
}
},
"includeItemsFromConditionSet": true
},
"tenderBasedAction": {
"type": "PERCENTAGE"
},
"perUnitAction": {
"rewardAction": "string",
"perUnitKPI": "AMOUNT",
"includeItemsFromConditionSet": true
}
},
"createdOn": "2023-01-19T09:28:58.595Z",
"lastUpdatedOn": "2023-01-19T09:28:58.595Z",
"earningCriteria": {
"criteriaName": "string",
"earnedFromType": "BULK_ISSUE",
"eventType": "TransactionAdd",
"storeCriteria": {
"type": "STORE",
"operator": "IN"
},
"timeCriteria": {
"repeatFrequency": "DOES_NOT_REPEAT",
"weeklyValues": [
"MONDAY"
]
},
"earningValidTillDays": 1,
"criteriaDsl": "string",
"criteriaDslJson": "string",
"active": true
},
"promotionRestrictions": {
"additionalProp1": [
{
"kpi": "TRANSACTION",
"frequency": "DAYS"
}
],
"additionalProp2": [
{
"kpi": "TRANSACTION",
"frequency": "DAYS"
}
],
"additionalProp3": [
{
"kpi": "TRANSACTION",
"frequency": "DAYS"
}
]
},
"earnLimitedToSpecificAudience": true,
"customFieldValues": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"onEarnCommunicationChannels": {
"additionalProp1": {
"subject": "string",
"message": "string",
"senderLabel": "string",
"senderReplyToEmail": "string",
"unsubscribeLabel": "string",
"senderEmail": "string",
"senderGSM": "string",
"senderCDMA": "string",
"domainPropertyId": "string",
"accountId": "string",
"channelType": "ANDROID",
"pushNotificationCta": {
"type": "DEEP_LINK",
"actionLink": "string",
"image": "string",
"pushNotificationCtaActionList": [
{
"type": "DEEP_LINK",
"actionLink": "string",
"actionText": "string",
"templateCtaId": "string"
}
]
}
},
"additionalProp2": {
"subject": "string",
"message": "string",
"senderLabel": "string",
"senderReplyToEmail": "string",
"unsubscribeLabel": "string",
"senderEmail": "string",
"senderGSM": "string",
"senderCDMA": "string",
"domainPropertyId": "string",
"accountId": "string",
"channelType": "ANDROID",
"pushNotificationCta": {
"type": "DEEP_LINK",
"actionLink": "string",
"image": "string",
"pushNotificationCtaActionList": [
{
"type": "DEEP_LINK",
"actionLink": "string",
"actionText": "string",
"templateCtaId": "string"
}
]
}
},
"additionalProp3": {
"subject": "string",
"message": "string",
"senderLabel": "string",
"senderReplyToEmail": "string",
"unsubscribeLabel": "string",
"senderEmail": "string",
"senderGSM": "string",
"senderCDMA": "string",
"domainPropertyId": "string",
"accountId": "string",
"channelType": "ANDROID",
"pushNotificationCta": {
"type": "DEEP_LINK",
"actionLink": "string",
"image": "string",
"pushNotificationCtaActionList": [
{
"type": "DEEP_LINK",
"actionLink": "string",
"actionText": "string",
"templateCtaId": "string"
}
]
}
}
},
"languagesConfigured": [
"string"
],
"customerActivationRequired": true,
"isLoyaltyOnly": true,
"mode": "DISCOUNT",
"maxIssuancePerCustomer": 50,
"isStackable": true,
"expiryDateChangeJobList": [
{
"jobType": "ISSUED",
"status": "OPEN",
"createdOn": "2023-01-19T09:28:58.595Z",
"lastUpdatedOn": "2023-01-19T09:28:58.595Z",
"message": "string"
}
],
"redeemableFromCriteria": {
"redeemableFrom": {
"type": "HOURS"
},
"redemptionValidBeforeExpiry": {
"type": "HOURS"
}
}
}
],
"errors": [
{
"message": "string"
}
]
}