Upload Gift Image

This endpoint is used to upload a product image associated with the gifted product.

TIP

The upload gift image endpoint has been implemented in the Gifting Web Component, and It's all setup to save developer's time and effort.

Payload

UploadGifImagePayload

multiPartData

object

FormData

required

An object for the form that contains the details of the uploaded image.

Response

Success

Error

product.upoladGiftImage.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

required

Data is available when the success is true

url

string

required

this is the url of the uploaded image

Usage

To perform the action of uploading a product image associated with a gifted product, the developer may call the method uploadGiftImage() as follows.

Events

This endpoint may trigger two events, the onGiftImageUploadSucceeded and onGiftImageUploadFailed events.

onGiftImageUploadSucceeded

This event is triggered when uploading a product image associated with a gifted product is done without having any errors coming back from the backend.

onGiftImageUploadFailed

This event is triggered when uploading a product image associated with a gifted product is not completed and an error has occurred.

Payload#

Response#

Usage#

Events#

onGiftImageUploadSucceeded#

onGiftImageUploadFailed#

Payload

Response

Usage

Events

onGiftImageUploadSucceeded

onGiftImageUploadFailed