CashBack

Endpoints in this group

• GET Get Marketplace Total Cashback Balance /loyaltyProgram/total

  Returns the cashback balance of your store, summed by type and by status. It is the consolidated view: one number per status, with no detail per customer or per order.

• GET List Aggregated Cashback Balance by Customer /loyaltyProgram/listCustomersTotal

  Lists your store's cashback balance customer by customer, with the totals per status for each one. Use it when you need the individual balance; for the store's consolidated figure, use GET /loyaltyProgram/total.

• GET Get Customer Cashback History /loyaltyProgram/customerReport/:document

  Lists the cashback statement of a customer of your store: one item per entry, earned or spent, from newest to oldest.

• POST Grant Cashback for External Order /loyaltyProgram/earnRewardExternal

  Grants cashback to a customer from an order that happened outside the CWS Platform — a sale at your counter, on your own e-commerce site or in another channel. You provide who bought, the order number in your system and the items; the loyalty program calculates how much each item earns and records the credit.

• PUT Update External Order Cashback /loyaltyProgram/earnRewardExternal

  Changes a cashback already granted for an external order: releases the credit that was in the grace period, cancels the grant, corrects the amount or the delivery date. The order is identified by the same externalOrderId used in the grant.