Contents

Dynamic Product Checkout API

The API is designed to create links using which all the products having the following property peculiarities get added to the cart on checkout page:

  • One part of product properties (e.g.: name, price) transferred in the request when generating a checkout link,
  • The other part of the product properties is taken from the original product that is pre-configured in your catalog on our end.

Hereinafter, such products are called dynamic products or products with dynamic information.
In other words, a dynamic product is a product for which some of the properties are set during the checkout process.

This section describes the new version of the protocol in JSON format. The previous version (XML) is obsolete and no longer updated. If you are using the old protocol, we recommend you to update. If you need any documentation concerning the old version of the protocol, please contact our support team.
  • You have to transfer the following in the request:
    • List of dynamic products to be added to cart on checkout page.
      For each product: original product identifier, dynamic information (name, price, etc.).
  • Customer data (optional).
    If the data is transferred, the customer will not need to fill it out in the cart to place an order. They will see the already pre-filled fields and will be able to edit them.
  • In response, the API returns a checkout link that must be provided to the customer for them to be able to place an order.
  • When clicking on the link, the products transferred will be added to the cart and the customer data will be pre-filled. 
  • Next, the customer can place an order.
Note! The link can be used one time. Only one order can be placed using the link. Dynamic products are not added to the catalog.
  • When selling products for which the customer selects the configuration settings in your catalog.
    E.g., on your website, there is a "calculator" that allows the customer to customize a set of product properties and calculate a price.
    If there are a lot of such properties, then it is faster to receive a checkout link through the API described here than to create products in the catalog for every possible combination of properties.
  • When selling frequently changing products that you do not want to constantly add and edit through the catalog on our end.
  • Selling products requiring additional conditions.
    E.g., a product can only be purchased if the customer has a correct serial number of a previous license of the product.
    In this case, you request the serial number from the customer, verify its correctness on your end. If the condition is met, then you create a one-time checkout link via the API .
    Thus, the customer will be able to create their order only if the condition is met. There will be only one order.
  • When providing special conditions for certain customers.
    E.g.: special product price or special packages, pre-filling of customer data in the cart.