Skip to main content

Cart API (3D Product Configurator)

Summary

  1. Overview

  2. Configuration Cart Properties

    2.1 preview

    2.2 price

    2.3 Attributes and Options List

    2.4 edit

    2.5 designID

  3. Add to Cart Endpoint

1. Overview

This API allows you to seamlessly integrate personalized product information directly into your standard shopping cart page, enhancing user engagement and satisfaction. Here's what the Configurator Cart API brings to the table:

  • Configured Product Preview (A):

    Provide users with a visual preview of each configured product directly within the shopping cart. This feature ensures that customers can see a detailed representation of their unique products, fostering clarity and minimizing any confusion between the standard and customized versions.

  • Updated Price (B):

    Harness the flexibility of Zakeke's Configurator to assign prices to individual options, enabling the calculation of a final price based on the chosen customization. The Configurator Cart API ensures the accurate display of the updated product price in the shopping cart, reflecting the dynamic pricing determined by the combination of selected options.

  • Attributes and Options List (C):

    Show a comprehensive list of attributes and options selected by the customers during the configuration process to create their own version of the product. This list is called "Composition" in Zakeke.

  • Edit Functionality (D):

    Add an 'Edit' button for each customized product, redirecting buyers back to the Zakeke Configurator. This functionality enables users to make additional modifications before finalizing their purchase, ensuring a personalized and flexible shopping experience.

Integrate the Configurator Cart API effortlessly and transform your shopping cart into a dynamic and user-friendly space for personalized product exploration and customization.

add-to-cart

2. Configuration Cart Properties

2.1 preview

"preview": "https://..."

Url to image preview of the configured product.

The preview image is a screenshot of the 3D product. You can set the angle of the screenshot by configuring a specific camera named "buy_screenshot_camera" in the Scene Editor section of the back office. For more information, please refer to this link.

2.2 price

"price": 19.99

The unit price of the product must be increased by the unit price of the configuration reported by Zakeke.

The price of the configuration is always in the base currency set in the Zakeke API settings. The price of the configuration must be converted into the correct currency.

Depending on the settings of your system, product, and the customer, the tax settings must be calculated for the configuration price.

Depending on the settings of your system, product, and the customer, the applicable discounts must be calculated for the configuration price.

Every time the consumer changes the quantity for the shopping cart line, that must be updated by calling this API again with the new quantity.

2.3 Attributes and Options List

"items": [
{
"attributeCode": {

"id":"242422342",
"label":"Color",
"zakekePlatform":true
},
"attributeName": "Color",
"selectedOptionCode": {
"id":"537564567",
"label":"White",
"zakekePlatform":true
},
"selectedOptionName": "White"
}
]

The list of attributes (items) and respective chosen option.

For attributes that are linked to attributes on the store, the attributeCode and selectedOptionName properties each contain a json serialized with the sentinel zakekePlatform property and the id of your system.

2.4 edit

For edit, reopen the iframe as done with the customAddToCartButtonText, but ensure to include the 'compositionId' parameter:

"compositionId" :  "315-e4848045-91c2-44b2"

2.5 designID

"designID": "000-2vXWy19gyU6jK3Wamdpm6A"

The optional designID associated to the composition.

3. Add to Cart Endpoint

GET https://api.zakeke.com/v1/compositions/{composition}/cartinfo

For more details click here

Example

Retrieve the Information on a Product Configuration with Quantity 5:

GET https://api.zakeke.com/v1/compositions/315-e4848045-91c2-44b2/cartinfo?quantity=5

For more details click here