Delete Image

This endpoint removes an image file attached to an item already added to the cart by the customer.

Payload

cart.deleteImage.payload

file_id

number

required

The id of the image file that will be removed from an item in the cart.

Response

Success

Error

cart.deleteImage.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

data

required

Response data.

message

object

The file has been deleted successfully

optional

Usage

To delete an image file attached to an item already added to the cart, the developer may call the method deleteItem as follows:

Events

This endpoint may trigger two events, the onImageDeleted and onImageNotDeleted events.

onImageDeleted

This event is triggered when removing an image file attached to an item already added to the cart is done without having any errors coming back from the backend.

onImageNotDeleted

This event is triggered when removing an image file attached to an item already added to the cart is not completed and an error has occurred. For example, the id of the image file was not found.

Payload#

Response#

Usage#

Events#

onImageDeleted#

onImageNotDeleted#

Payload

Response

Usage

Events

onImageDeleted

onImageNotDeleted