Price Quote

The priceQuote endpoint calculates and returns a price quote for the items in a cart. This endpoint takes into account any discounts, taxes, shipping costs, and other factors that may affect the final price, and returns the calculated price along with a breakdown of the individual costs. The price quote can be used to inform the user of the total cost of their purchase and to facilitate the checkout process.

Payload

PriceQuotePayload

cartId

number

required

This field refers to the unique identifier of the cart for which a price quote is being generated.

Response

Success

Error

cart.priceQuote.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

case

enum<string>

required

A string indicating the result of the price quote operation, which can be "success" or "login"

Allowed values:

successlogin

Usage

To perform the action of calculating and returning a price quote for the items in a cart, the developer may call the priceQuote() as shown below.

Events

This endpoint may trigger two events, the onPriceQuoteSucceeded and onPriceQuoteFailed events.

onPriceQuoteSucceeded

This event is triggered when of calculating and returning a price quote for the items in a cart is done without having any errors coming back from the backend.

onPriceQuoteFailed

This event is triggered when of calculating and returning a price quote for the items in a cart is not completed and an error has occurred.

Payload#

Response#

Usage#

Events#

onPriceQuoteSucceeded#

onPriceQuoteFailed#

Payload

Response

Usage

Events

onPriceQuoteSucceeded

onPriceQuoteFailed