Salla Docs
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Merchant API
  • Merchant API
  • Salla OAuth 2.0
Partner APIs
  • App API
  • Shipment API
Storefront
  • Twilight Engine
  • Twilight SDK
  • Web Components
  • Change Log
Salla CLI
Salla - Opensource
Salla - Developers Community
  1. Loyalty
  • Languages
  • Notify
  • Event
  • Overview
  • Storage
  • Configuration
  • Forms
  • Helpers
  • Auth
    • Login
    • Logout
    • Verify
    • Resend
    • Register
    • Refresh
  • Cart
    • Latest
    • Details
    • Quick Add
    • Add Item
    • Delete Item
    • Delete Image
    • Add Coupon
    • Remove Coupon
    • Get Upload Image
    • Get Quick Order Settings
    • Create Quick Order
    • Order Status
    • Get Current Cart Id
    • Price Quote
  • Wishlist
    • Add
    • Remove
    • Toggle
  • Loyalty
    • Get Program
    • Exchange
    • Reset
  • Comment
    • Add Comment
    • Fetch
    • Get Page Comments
    • Get Product Comments
  • Profile
    • Update profile
    • Update contact
  • Product
    • Get price
    • Product availability
    • Categories
    • Offer details
    • Search products
    • Get Gift Details
    • Add Gift To Cart
    • Upload Gift Image
    • Get Product Details
    • Fetch
    • Fetch Options
    • Size Guides
  • Order
    • Create cart from order
    • Cancel
    • Send invoice
    • Show order
  • Booking
    • Add
  • Rating
    • Order
    • Store
    • Products
    • Shipping
  • Currency
    • Change
    • List
  • Component
    • Reviews
    • Menus
  1. Loyalty

Reset

This endpoint is used when the customer removes an added reward from the live cart. In some cases, customers may need to remove a prize after adding it to the live cart.
TIP
The reset endpoint has been implemented in the Loyalty Web Component, , and It's all setup to save developer's time and effort.

Response#

Success
Error
loyalty.reset.success
success
boolean 
success
required
Response flag
status
enum<number> 
status
required
Allowed values:
200201202

Usage#

To perform the action of removing an added reward from the live cart, the method reset() may be called as below, with the id of the order to be rated.

Events#

This endpoint may trigger two events, the onResetSucceeded and onResetFailed events.

onResetSucceeded#

This event is triggered when the action of removing an added reward from the live cart is done without having any errors coming back from the backend.

onResetFailed#

This event is triggered when the action of removing an added reward from the live cart is not completed and an error has occurred.
Modified at 2025-03-04 12:54:02
Previous
Exchange
Next
Comment