API voor in aanmerking komende speciale acties
Gebruik de API voor in aanmerking komende speciale acties om klanten een lijst van speciale acties te bieden die in aanmerking komen voor winkelwagentjes van klanten. De API kan de lijst van in aanmerking komende speciale acties ophalen voor contactpersonen, accounts en leden van loyaliteitsprogramma's.
Vereiste editions
| Beschikbaar in: Lightning Experience |
| Beschikbaar in: Enterprise, Unlimited en Developer Edition met realtime aanbiedingsbeheer |
Geef uw klanten een lijst van speciale acties die in aanmerking komen voor hun winkelwagentje. De API neemt de details van het winkelwagentje van een klant als verzoek en geeft de details van de in aanmerking komende actieve speciale acties voor het winkelwagentje als reactie. Bij het zoeken naar in aanmerking komende speciale acties voor een item scant de API 5 niveaus van de categoriehiërarchie van het product.
Als een winkelwagentje een product bevat dat niet voorkomt in de Salesforce-catalogus, negeert de API de niet-gesynchroniseerde producten tijdens het evalueren van speciale acties op regelniveau en op regelniveau en toont deze in aanmerking komende speciale acties voor het winkelwagentje.
Als een organisatie meerdere regelbibliotheken van het type Beheer van globale speciale acties heeft, moeten systeemintegrators opgeven welke regelbibliotheek de API uitvoert. Ze moeten ook bevestigen dat het verzoek van de API waarden bevat die de contextdefinitie van de regelbibliotheek vereist voor het evalueren van winkelwagentjes.
De API-respons biedt deze details van de speciale actie.
- Primaire details van speciale actie, zoals begin- en einddatum
- Aangepaste veldwaarden van speciale actie
- Limieten van speciale actie
- Regels van speciale actie die in aanmerking komen voor het winkelwagentje van de klant
- Aangepaste veldwaarden van speciale actie die worden toegewezen in de definitie van de context van de speciale actie.
Als u klanten hun in aanmerking komende speciale acties in realtime wilt aanbieden, integreert u de API voor in aanmerking komende speciale acties met externe systemen die winkelwagentjes van klanten beheren. Zie In aanmerking komende speciale acties.
Nadat het gebruik van een speciale actie voldoet aan de limiet van de speciale actie voor een bepaald winkelwagentje, biedt de API voor in aanmerking komende speciale acties geen beloning in de API-uitvoer voor een klant. Nadat het gebruik van een beloning door een klant voldoet aan de limiet op klantniveau van de speciale actie, biedt de API voor in aanmerking komende speciale acties de beloning niet langer aan de klant.
Het verzoek van de API voor in aanmerking komende speciale acties ziet er als volgt uit wanneer de API wordt uitgevoerd vanaf de online winkelsite van Cloud Kicks.
{
"cart":{
"Accessory":[
{
"activityStartDate":"2023-06-14T12:45:19Z",
"contactId":"003xx000004WjzAAAS",
"transactionAmount":85,
"currencyISOCode":"INR",
"cartLineDetails":[
{
"CartLineProductCategory":"Sneaker Shields",
"cartLineProductCatalogId:"0ZSSB0000002d8X4AQ"",
"AttributeKey:"Premium"
}
]
}
]
}
}In aanmerking komende API voor speciale acties met coupons
Wanneer coupons worden toegevoegd aan een speciale actie, neemt de API voor in aanmerking komende speciale acties de details van het winkelwagentje van een klant als het verzoek en reageert deze met de details van de actieve coupons voor de speciale acties die in aanmerking komen voor het winkelwagentje van de klant. De klant kan de coupon van de speciale actie die hij of zij wil toepassen, gebruiken voor zijn of haar winkelwagentje.
Voor in aanmerking komende speciale acties die een coupon bevatten, bevat de respons van de API deze coupondetails.
- Couponcode
- Begin- en einddatum
- Status
De API retourneert alleen speciale acties die minstens één actieve en geldige coupon hebben voor de activiteitsdatum van de klant. Hoewel een speciale actie kan bestaan uit meerdere coupons, toont de API de couponcode niet in deze scenario's.
- Als er meerdere actieve coupons zijn die in aanmerking komen voor de activiteitsdatum
- Als er geen coupon actief is voor de activiteitsdatum
- Als de in aanmerking komende actieve coupon zijn gebruikslimiet heeft bereikt
