Documentation

Everything you need to get started with CarbonTrail

Last updated: December 2024

Getting Started

CarbonTrail integrates with your Shopify store to automatically calculate carbon emissions for every order and offer customers the option to offset at checkout.

Setup takes less than 10 minutes. No coding required.

Prerequisites

  • A Shopify store with an active plan
  • Admin access to your Shopify store
  • Product weights configured (recommended but not required)

Installation

Step 1: Install from Shopify App Store

Click "Install on Shopify" from our website or find CarbonTrail in the Shopify App Store. You'll be redirected to authorize the app.

Step 2: Authorize Permissions

CarbonTrail requires the following permissions:

  • Read orders — to calculate emissions for each shipment
  • Read products — to access product weights
  • Read shipping — to determine shipping destinations
  • Write script tags — to display the checkout widget

Step 3: Complete Onboarding

After authorization, you'll be guided through a quick setup wizard to configure your warehouse location and preferences.

Configuration

Warehouse Location

Set your primary fulfillment location. This is used as the origin point for distance calculations. You can update this anytime in Settings.

Default Product Weight

If a product doesn't have a weight configured in Shopify, we'll use your default weight. We recommend setting this to your average product weight.

SettingDefaultRecommendation
Default weight500gYour average product weight
Weight unitgramsMatch your Shopify settings

Offset Provider

Choose your preferred carbon offset provider. Each provider offers different project types and pricing structures.

Widget Setup

The CarbonTrail widget appears at checkout, allowing customers to opt-in to carbon offsets.

Widget Placement

The widget automatically appears in your checkout flow. No theme modifications required for most Shopify themes.

Customization Options

  • Toggle visibility on/off
  • Customize the call-to-action text
  • Choose between opt-in or opt-out default
  • Set a custom offset price or use calculated amount

Widget Styling

The widget inherits your theme's fonts and colors by default. For advanced customization, you can add custom CSS in Settings → Widget → Advanced.

Dashboard Guide

Overview

The dashboard home shows your key metrics at a glance: total emissions, offsets purchased, customer opt-in rate, and monthly trends.

Navigation

SectionDescription
OverviewKey metrics and trends
OrdersIndividual order emissions
OffsetsOffset purchase history
ReportsDetailed analytics and exports
ClaimsAI-reviewed sustainability claims
SettingsConfiguration and preferences
AuditActivity log and compliance

Reports & Analytics

Monthly Reports

Access monthly summaries of your carbon footprint, including breakdowns by shipping destination, transport mode, and product category.

Export Options

  • CSV export for spreadsheet analysis
  • PDF reports for stakeholder sharing
  • Scheduled email reports (Growth plan and above)

Key Metrics

MetricDescription
Total kgCO₂eCumulative emissions from all orders
Offset RatePercentage of emissions offset
Opt-in RateCustomer participation percentage
Avg per OrderAverage emissions per order

Managing Offsets

Automatic Offsets

When customers opt-in at checkout, offsets are purchased automatically from your configured provider. Each transaction is logged with a unique reference ID.

Manual Offsets

You can purchase offsets manually to cover emissions from orders where customers didn't opt-in. Go to Offsets → Purchase Manual Offset.

Offset Verification

All offsets include verification details from the provider, including project name, location, and certification standard.

Troubleshooting

Widget Not Appearing

  • Ensure the widget is enabled in Settings
  • Check that your theme supports app blocks
  • Clear your browser cache and try again
  • Contact support if the issue persists

Incorrect Emissions Calculations

  • Verify your warehouse location is correct
  • Check that product weights are configured in Shopify
  • Review the default weight setting

Need Help?

Contact our support team at support@carbontrail.org or use the chat widget in your dashboard.