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. Product
  • Overview
  • Languages
  • Notify
  • Event
  • 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. Product

Get Gift Details

This endpoint provides the details of the gifted product, along with any related entities, such as images and texts associated with the gift.
TIP
The get gift details endpoint has been implemented in the Gifting Web Component , and It's all setup to save developer's time and effort.

Payload#

GetGiftDetailsPayload
product_id
number 
required
The id of the product to be gifted.

Response#

Success
Error
product.getGiftDetails.success
success
boolean 
success
required
Response flag
status
enum<number> 
status
required
Allowed values:
200201202
data
object 
Loyalty
required
Data is available when the success is true
gift
object 
Gift_Model
required

Usage#

To perform the action of providing the details of the gifted product, the developer may call the method getGiftDetails() as follows.

Events#

This endpoint may trigger two events, the onGiftFetched and onGiftFetchFailed events.

onGiftFetched#

This event is triggered when the action of providing the details of the gifted product is done without having any errors coming back from the backend.

onGiftFetchFailed#

This event is triggered when the action of providing the details of the gifted product is not completed and an error has occurred.
Modified at 2025-03-04 12:54:02
Previous
Search products
Next
Add Gift To Cart