Add Item

This addItem endpoint adds an item from the merchant's store to the customer's shopping cart. The customer may select the item, type in the quantity he wants to order, and click on the "add to cart" button. This sends the product to the shopping cart, and then the customer may continue to shop for other items.

TIP

The add item endpoint has been implemented in the Add Product Web Component, and it's ready for use.

Payload

AddItemPayload

number

required

The id of the item that will be added to the cart.

quantity

number

required

The quantity of the item that will be added to the cart.

Default:

options

array [object {2}]

optional

The options list for the item will be added to the cart

number

optional

The option id

Example:

98789

value

string | number | array[number]

optional

The option value

Example:

notes

string

AddItemPayload.notes

optional

Add notes to the product that will be added to the cart if needed.

file

string | object

BinaryType

optional

Attach file, for example image, to the product that will be added to the cart if needed.

Response

Success

Error

cart.addItem.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

data

optional

Response data.

cart

object

CartSummary

required

offer

object

array[Offer]

required

Usage

The method addItem adds an item into the cart, the developer may call the method addItem as follows:

Simple Product

Variable product

Events

This endpoint may trigger two events, the onItemAdded and onItemAddedFailed events.

onItemAdded

This event is triggered when adding an item to the cart is done without having any errors coming back from the backend.

onItemAddedFailed

This event is triggered when adding an item to the cart is not completed and an error has occurred. For example, the id of the product to be added to the cart was not found.

Payload#

Response#

Usage#

Simple Product#

Variable product#

Events#

onItemAdded#

onItemAddedFailed#

Payload

Response

Usage

Simple Product

Variable product

Events

onItemAdded

onItemAddedFailed