Test Environment

Production Environment

Getting Started

API Documentation

Authentication

Request IDs

Errors

Carbon accounts are essential for interacting with the Greener Choice API. To receive a quote, place an order, or retrieve carbon orders, you will need an `account_id`. 

 When you create an account, you will receive an `account_id` in the response object. Be sure to save this `account_id`, as it is required for any actions related to the account. 

 If an account is already associated with the email provided, the existing account will be returned instead of creating a new one.

Create Account

This will return all carbon accounts that belong to your organisation.

Get Accounts

To retrieve an account, you will need the `account_id` provided in the response object from the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint.

Get Account by Id

To retrieve an account, you can use the `account_email` provided in the response object from the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint.

Get Account by Email

This endpoint returns all available portfolios from our selected providers. These portfolios are the same as those included in the [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes) response, but are presented here in a more accessible format.

Get Portfolios

This endpoint returns all available portfolios from the requested provider. These portfolios are the same as those included in the [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes) response, but are presented here in a more accessible format.

Get Portfolios By Provider

This endpoint returns an estimated emissions value for the provided parameters for a flight reservation.

Flights

This endpoint returns an estimated emissions value for the provided parameters for an accommodation reservation.

Accommodation

This endpoint returns an estimated emissions value for the provided parameters for a bus journey.

Buses

This endpoint returns an estimated emissions value for the provided parameters for a train journey.

Trains

This endpoint requires an emissions value (in kg) and your `account_id`. It returns several quotes from different providers, each including portfolio breakdowns and information on the provider. 

 When creating an order for a specific quote, you must provide the `quote_id` of the desired quote. **All quotes are valid for 24 hours**.

Get Quotes

To retrieve a specific quote, you will need the `quote_id` provided by the [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes) endpoint. 

 If you did not save the desired `quote_id`, you will need to call the [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes) endpoint again, save the `quote_id`, and then use it to call this endpoint.

Get Quote By Id

After calling [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes), you can create an order for a specific quote using its `quote_id`. 

Please note that you also need an `account_id` to create an order. This `account_id` is provided by the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint. Ensure that the `account_id` used to create the order matches the one used to fetch the quotes. 

This endpoint will return an `order_id`. Save this `order_id` to retrieve the order at a later date.

Create Order

This endpoint returns a specific order for an account. To fetch the order, use the `account_id` returned from the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint and the `order_id` returned from the [Create Order](/api-reference/orders/v1-post-carbon-order) endpoint.

Get Order By Id

This endpoint returns all orders for an account. Use the `account_id` returned by the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint.

Get Orders By Account Id

After creating an order, that order marked as `INITIATED`. While an order is in the `INITIATED` state, the order can be cancelled. 

 If the order has been processed from `INITIATED` to `UNFULFILLED`, `FULFILLED` or `CANCELLED`, the order can no longer be processed.

Cancel Order

This endpoint renders a PDF invoice for a carbon order and emails it to the specified email address.

API Documentation

Carbon Accounts

Carbon Portfolios

Emissions Estimates

Carbon Quotes

Carbon Orders

Documents

Getting Started

Test Environment

Production Environment

API Documentation

Carbon Accounts

Carbon Portfolios

Emissions Estimates

Carbon Quotes

Carbon Orders

Documents

​Test Environment

​Production Environment

Test Environment

Production Environment