Product Docs Help

Example flow

Based on the current client implementation of the checkout, the following flow is used. The flow is based on the client (server) making requests to the Qvickly Checkout API and the client (browser) receiving JS events.

  1. Client (server) makes a initCheckout request

  2. Qvickly replies with a number and url.

    1. Keep track of the url, note that this number is temporary and not the final transaction id.

    2. URL is the URL to the Checkout window to be passed to the IFRAME.

  3. User gets identified using the Checkout.

  4. Client (browser) receives a JS event with customer data such as address, zip, email and phone number.

    1. Now the client can handle the data received and might perform a updateCheckout for example if shipping cost should be updated.

      1. Before performing updateCheckout send JS event lock to lock the Checkout.

      2. updateCheckout - Request

      3. updateCheckout - Response

      4. Send update Javascript event. Note that there is no unlock event required to be sent after the update JS event. The Checkout handles this by itself.

  5. User change shipping method, articles or any other order information on the hosting iframe hosting system. Client should perform the same events as in 4.a if you need to update the Checkout.

  6. User selects a different shipping address. Hosting system should perform the same events as in 4.a if you need to update the Checkout.

  7. User confirms order, third party application might be needed to confirm the order. Checkout sends JS event to client (browser) to open a specific url (app). Example: BankID or Swish. Note: If user is redirected to a third-party app or website and cancels the order they could be redirected to the provided cancelURL.

  8. Order is confirmed

    1. Accepturl User is redirected to the provided acceptURL using the requested return method. Client should perform necessary actions to fulfill the order.

    2. CallbackClient (server) receives a request from Qvickly Checkout API with the order status. Client should perform necessary actions to fulfill the order.

Role definitions

Client The complete system who integrates Qvickly Checkout.

Client (server) Back-end who communicates with the Qvickly Checkout API.

Client (browser) The clients browser (front-end). Will perform and receive JS events.

User The end-user who is making a purchase in Qvickly Checkout.

Last modified: 13 September 2024