Skip to main content

Dynamic Emissions at Checkout

This is a walkthrough for integrating what we called the Climes Vote Flow with Dynamic Emission or Truecost values at checkout
The only difference between this and the Standard Emissions Flow is that the emission values are calculated per checkout per user instead of an estimated value across all users

note

Our estimate for the complete integration is around 10-12 Hours of Engineering and Design bandwidth including time for testing

Integration Steps​

There are 5 steps to integrate the Climes Vote Flow into your product.

  1. Get your billing setup
    • Reach out to our api team and get an account setup
    • Add your billing details
    • Get your API keys for staging and production from the API key page
  2. Carbon Accounting Integration
    • Since the emissions or truecost of each order will be calculated dynamically based on available info you'll need to integrate those directly
  3. Cart Management
    • We provide simple endpoints through which you can set and get the opt in status of the cart
  4. Order Management
    • These endpoints are used to manage the status of a climes order while checking out and post-checkout.
    • It allows you to modify/cancel an order for climes in case an order gets cancelled on your end
  5. Post Order Experience
    • These endpoints allow you to customize the post order experience to your liking
    • You can either use our default post-order voting experience or build it into your interface using our simple APIs

Carbon Accounting Integration​

Once you have your API keys you should be able to test our Carbon Accounting APIs for your use case here For now, we have public instructions for the following

  1. Flights Truecosting
  2. Commute Truecosting
  3. Logistics Truecosting

Using these APIs you'll be able to fetch the truecost or the emission value that you can display in the next step

Cart Management​

The following API flow is needed pre checkout

Preview​

Show a widget similar to the one below to allow the user to Opt-In to climate action

In the above image, the 10 kg CO2e value can be fetched through the Carbon Accounting Integration that applies to your use case

Our recommended placement is on the checkout and cart pages just before Total Amount

Checkbox Interaction and State​

The state of the checkbox can be managed by

  1. Checking whether the current cart_id is opted in or not by using our Get OptIn API
    When the Get OptIn API endpoint is called, it sends back a response in this format

    {
        "optedIn": true
    }

    Where the value of optedIn indicates whether for this cart_id , the box should be checked or not.

  2. On interaction with the checkbox setting the opted in status to true or false by using our Set OptIn API

    When the user checks the box set the optedIn value to true and on unchecking set the optedIn value to false
    This allows you to track the state of opt-in for the current cart_id anywhere you want

  3. If you'd like to show the current opt-in anywhere else as well you can fetch it using Get OptIn API

tip

If you use the same id for Cart and Order Management - you can pass the Order II as the value for cart_id.

Order Management​

In your order placement flow, add the following steps right at the end

  1. Check if the the cart_id that corresponds to this order has opted in for climes by making a request to Get OptIn API endpoint
  2. If it returns optedIn : true then create a new order using our Create Order API along with the same cart_id that was used for the OptIn
  3. When we receive the order, we’ll assign the pre-calculated no of climes to this order and the user will be able to access these climes
    • One caveat, to allow for a cancellation period we allow you to set an unlock_date for this order upto which even if the user chooses to vote with these climes the climes can be cancelled
    • unlock_date is set as 10 days as default from date we receive the order
  4. In the event of a cancellation you can use Order Cancel API
    • Orders cannot be cancelled once the unlock_date date has passed

Post Order Experience​

After the order is successfully created you can display a success card at the success page

This success card will have a Choose Now button The link for the Choose Now button can be fetched using the Get Voting Link endpoint
It should have a format similar to this : 

https://climes.io/app/brands/YOUR_SLUG/vote?o=PARTNER_ORDER_ID

Where YOUR_SLUG is the slug for your brand on the Brands Directory

Using this link your users can vote using the map interface.

If you'd like to offer a more customized experience you may refer to the User Experience APIs

With that the integration is complete