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.

Payload#

Response#

Usage#

Events#

onGiftFetched#

onGiftFetchFailed#

Payload

Response

Usage

Events

onGiftFetched

onGiftFetchFailed