Methods

Method	HTTP request	Description
add_webhook	POST /webhooks/add	Add Webhook
calculate	POST /calculate	Calculate
calculate_cart	POST /stores/{store_ident}/cart	Calculate
get_categories	GET /categories	Get all Categories
get_certification_authorities	GET /certification_authorities	Get all Certification Authorities
get_metrics	POST /metrics	Order Metrics
get_order	GET /orders/{order_id}	Get Order
get_orders	POST /orders	Get Orders
get_payment_link	GET /orders/link/{payment_link_id}	Get Checkout Link
get_project	GET /projects/{project_id}	Get Project
get_projects	GET /projects	Get all supported Projects
link_by_calculation	POST /orders/link/calculate	By Calculation
link_by_carbon	POST /orders/link/carbon	By Carbon
link_by_price	POST /orders/link/price	By Price
me	GET /me	Get Authenticated User
order_by_calculation	POST /orders/process/calculate	By Calculation
order_by_carbon	POST /orders/process/carbon	By Carbon
order_by_price	POST /orders/process/price	By Price
pending_by_calculation	POST /orders/pending/calculate	By Calculation
pending_by_carbon	POST /orders/pending/carbon	By Carbon
pending_by_price	POST /orders/pending/price	By Price
process	POST /orders/{order_id}/process	Process Pending Order
process_cart	POST /stores/{store_ident}/cart/{order_id}/process	Process Cart
refund	DELETE /orders/{order_id}/refund	Refund Order
remove_webhook	DELETE /webhooks/remove	Remove Webhook
sync_bulk_store	POST /stores/{store_ident}/sync/bulk	Sync multiple Products
sync_store	POST /stores/{store_ident}/sync	Sync a single Product

add_webhook

add_webhook(add_webhook_request)

Add Webhook

Add a new Webhook to an integration. The webhook will be triggered by the given trigger.

Example

import klimapi_python
from klimapi_python.models.add_webhook_request import AddWebhookRequest
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

add_webhook_request = klimapi_python.AddWebhookRequest() # AddWebhookRequest | 

try:
    # Add Webhook
    klimapi.add_webhook(add_webhook_request)
except Exception as e:
    print("Exception when calling KlimApi->add_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_webhook_request	AddWebhookRequest

Return type

void (empty response body)

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
201	Successfully added the Webhook	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
500	System unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

calculate

CalculationResults calculate(calculate_request)

Calculate

IMPORTANT: Calling this route using API keys created in the sandbox mode is returning random numbers instead of real calculations.

Example

import klimapi_python
from klimapi_python.models.calculate_request import CalculateRequest
from klimapi_python.models.calculation_results import CalculationResults
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

calculate_request = klimapi_python.CalculateRequest() # CalculateRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.

try:
    # Calculate
    api_response = klimapi.calculate(calculate_request)
    print("The response of KlimApi->calculate:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->calculate: %s\n" % e)

Parameters

Name	Type	Description	Notes
calculate_request	CalculateRequest	Choose up to 100 Elements from the Calculation Options. In this example it is just Travel by Car.

Return type

CalculationResults

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully calculated	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
422	Unknown calculation parameter	-
500	System unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

calculate_cart

CartResult calculate_cart(store_ident, cart_item, locale=locale, currency=currency)

Calculate

IMPORTANT: Calling this route using API keys created in the sandbox mode is returning random numbers instead of real calculations.

Example

import klimapi_python
from klimapi_python.models.cart_item import CartItem
from klimapi_python.models.cart_result import CartResult
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

store_ident = 'store_ident_example' # str | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
cart_item = [klimapi_python.CartItem()] # List[CartItem] | 
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)

try:
    # Calculate
    api_response = klimapi.calculate_cart(store_ident, cart_item, locale=locale, currency=currency)
    print("The response of KlimApi->calculate_cart:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->calculate_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
store_ident	str	Setup a new store here to get a store ident
cart_item	List[CartItem]
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]

Return type

CartResult

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully calculated the cart	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_categories

List[Category] get_categories(locale=locale)

Get all Categories

Use the method to get all activated categories for the given API key.

Example

import klimapi_python
from klimapi_python.models.category import Category
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Get all Categories
    api_response = klimapi.get_categories(locale=locale)
    print("The response of KlimApi->get_categories:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_categories: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

List[Category]

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got all categories	-
401	Your API Key is invalid, deactivated or your account has been suspended	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_certification_authorities

List[CertificationAuthority] get_certification_authorities()

Get all Certification Authorities

Use this endpoint to get all external certification authorities we are using for our compensation projects. Learn more about our Portfolio.

Example

import klimapi_python
from klimapi_python.models.certification_authority import CertificationAuthority
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')


try:
    # Get all Certification Authorities
    api_response = klimapi.get_certification_authorities()
    print("The response of KlimApi->get_certification_authorities:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_certification_authorities: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[CertificationAuthority]

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got all Certification Authorities	-
401	Your API Key is invalid, deactivated or your account has been suspended	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_metrics

OrderMetrics get_metrics(get_metrics_request)

Order Metrics

Get metrics to all orders

Example

import klimapi_python
from klimapi_python.models.get_metrics_request import GetMetricsRequest
from klimapi_python.models.order_metrics import OrderMetrics
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

get_metrics_request = klimapi_python.GetMetricsRequest() # GetMetricsRequest | 

try:
    # Order Metrics
    api_response = klimapi.get_metrics(get_metrics_request)
    print("The response of KlimApi->get_metrics:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_metrics: %s\n" % e)

Parameters

Name	Type	Description	Notes
get_metrics_request	GetMetricsRequest

Return type

OrderMetrics

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got metrics for the orders	-
401	Your API Key is invalid, deactivated or your account has been suspended	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_order

Order get_order(order_id, locale=locale)

Get Order

Here you can request information about a specific Order.

Example

import klimapi_python
from klimapi_python.models.order import Order
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

order_id = 'order_id_example' # str | You can get the order_id from several endpoints, for example when creating an Order.
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Get Order
    api_response = klimapi.get_order(order_id, locale=locale)
    print("The response of KlimApi->get_order:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_order: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	str	You can get the order_id from several endpoints, for example when creating an Order.
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

Order

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got the requested order	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
404	Order not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_orders

MetadataOrders get_orders(get_orders_request, locale=locale)

Get Orders

Query all orders

Example

import klimapi_python
from klimapi_python.models.get_orders_request import GetOrdersRequest
from klimapi_python.models.metadata_orders import MetadataOrders
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

get_orders_request = klimapi_python.GetOrdersRequest() # GetOrdersRequest | 
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Get Orders
    api_response = klimapi.get_orders(get_orders_request, locale=locale)
    print("The response of KlimApi->get_orders:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_orders: %s\n" % e)

Parameters

Name	Type	Description	Notes
get_orders_request	GetOrdersRequest
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

MetadataOrders

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got the requested orders	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_payment_link

CheckoutLink get_payment_link(payment_link_id, locale=locale)

Get Checkout Link

Here you can request information about a specific Checkout Link.

Example

import klimapi_python
from klimapi_python.models.checkout_link import CheckoutLink
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

payment_link_id = 'payment_link_id_example' # str | The identifier of the checkout link that you want to be returned.
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Get Checkout Link
    api_response = klimapi.get_payment_link(payment_link_id, locale=locale)
    print("The response of KlimApi->get_payment_link:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_payment_link: %s\n" % e)

Parameters

Name	Type	Description	Notes
payment_link_id	str	The identifier of the checkout link that you want to be returned.
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

CheckoutLink

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got the requested Checkout Link	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
404	Checkout Link not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_project

Project get_project(project_id, locale=locale)

Get Project

Here you can request information to every project in our database.

Example

import klimapi_python
from klimapi_python.models.project import Project
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

project_id = 'project_id_example' # str | You can get the project_id from several endpoints, for example when creating an Order.
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Get Project
    api_response = klimapi.get_project(project_id, locale=locale)
    print("The response of KlimApi->get_project:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_project: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	You can get the project_id from several endpoints, for example when creating an Order.
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

Project

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got the requested project	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
404	Project not found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_projects

List[Project] get_projects(locale=locale)

Get all supported Projects

Get all projects you supported with the given API key.

Example

import klimapi_python
from klimapi_python.models.project import Project
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Get all supported Projects
    api_response = klimapi.get_projects(locale=locale)
    print("The response of KlimApi->get_projects:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->get_projects: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

List[Project]

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got the requested projects	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
404	No Projects found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_by_calculation

CheckoutLinksCalculated link_by_calculation(link_by_calculation_request, locale=locale, currency=currency)

By Calculation

IMPORTANT: Calling this route using API keys created in the sandbox mode is returning random numbers instead of real calculations.

Example

import klimapi_python
from klimapi_python.models.checkout_links_calculated import CheckoutLinksCalculated
from klimapi_python.models.link_by_calculation_request import LinkByCalculationRequest
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

link_by_calculation_request = klimapi_python.LinkByCalculationRequest() # LinkByCalculationRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)

try:
    # By Calculation
    api_response = klimapi.link_by_calculation(link_by_calculation_request, locale=locale, currency=currency)
    print("The response of KlimApi->link_by_calculation:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->link_by_calculation: %s\n" % e)

Parameters

Name	Type	Description	Notes
link_by_calculation_request	LinkByCalculationRequest	Choose up to 100 Elements from the Calculation Options. In this example it is just Travel by Car.
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]

Return type

CheckoutLinksCalculated

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got a Checkout Link	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
422	Unknown calculation parameter	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_by_carbon

CheckoutLinks link_by_carbon(locale=locale, currency=currency, link_by_carbon_request=link_by_carbon_request)

By Carbon

Get the compensation instantly by kilogram CO2e.

Example

import klimapi_python
from klimapi_python.models.checkout_links import CheckoutLinks
from klimapi_python.models.link_by_carbon_request import LinkByCarbonRequest
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)
link_by_carbon_request = klimapi_python.LinkByCarbonRequest() # LinkByCarbonRequest |  (optional)

try:
    # By Carbon
    api_response = klimapi.link_by_carbon(locale=locale, currency=currency, link_by_carbon_request=link_by_carbon_request)
    print("The response of KlimApi->link_by_carbon:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->link_by_carbon: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]
link_by_carbon_request	LinkByCarbonRequest		[optional]

Return type

CheckoutLinks

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got a Checkout Link	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_by_price

CheckoutLinks link_by_price(locale=locale, currency=currency, link_by_price_request=link_by_price_request)

By Price

Get the compensation instantly by price.

Example

import klimapi_python
from klimapi_python.models.checkout_links import CheckoutLinks
from klimapi_python.models.link_by_price_request import LinkByPriceRequest
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)
link_by_price_request = klimapi_python.LinkByPriceRequest() # LinkByPriceRequest |  (optional)

try:
    # By Price
    api_response = klimapi.link_by_price(locale=locale, currency=currency, link_by_price_request=link_by_price_request)
    print("The response of KlimApi->link_by_price:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->link_by_price: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]
link_by_price_request	LinkByPriceRequest		[optional]

Return type

CheckoutLinks

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got a Checkout Link	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

me

object me()

Get Authenticated User

Get Information about the Authenticated User, the Integration and the given API Key.

Example

import klimapi_python
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')


try:
    # Get Authenticated User
    api_response = klimapi.me()
    print("The response of KlimApi->me:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->me: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got the user	-
401	Your API Key is invalid, deactivated or your account has been suspended	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

order_by_calculation

OrderCalculated order_by_calculation(order_by_calculation_request, locale=locale, currency=currency)

By Calculation

IMPORTANT: Calling this route using API keys created in the sandbox mode is returning random numbers instead of real calculations.

Example

import klimapi_python
from klimapi_python.models.order_by_calculation_request import OrderByCalculationRequest
from klimapi_python.models.order_calculated import OrderCalculated
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

order_by_calculation_request = klimapi_python.OrderByCalculationRequest() # OrderByCalculationRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)

try:
    # By Calculation
    api_response = klimapi.order_by_calculation(order_by_calculation_request, locale=locale, currency=currency)
    print("The response of KlimApi->order_by_calculation:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->order_by_calculation: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_by_calculation_request	OrderByCalculationRequest	Choose up to 100 Elements from the Calculation Options. In this example it is just Travel by Car.
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]

Return type

OrderCalculated

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got an Order	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
406	The Request exceeds the given `price_limit`	-
422	Unknown calculation parameter	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

order_by_carbon

Order order_by_carbon(locale=locale, currency=currency, buy_amount=buy_amount)

By Carbon

Get the compensation instantly by kilogram CO2e. For this route the API key has no limits.

Example

import klimapi_python
from klimapi_python.models.buy_amount import BuyAmount
from klimapi_python.models.order import Order
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)
buy_amount = klimapi_python.BuyAmount() # BuyAmount |  (optional)

try:
    # By Carbon
    api_response = klimapi.order_by_carbon(locale=locale, currency=currency, buy_amount=buy_amount)
    print("The response of KlimApi->order_by_carbon:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->order_by_carbon: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]
buy_amount	BuyAmount		[optional]

Return type

Order

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got an Order	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
406	The Request exceeds the given `price_limit`	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

order_by_price

Order order_by_price(locale=locale, currency=currency, buy_price=buy_price)

By Price

Get the compensation instantly by price. For this route the API key has no limits.

Example

import klimapi_python
from klimapi_python.models.buy_price import BuyPrice
from klimapi_python.models.order import Order
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)
buy_price = klimapi_python.BuyPrice() # BuyPrice |  (optional)

try:
    # By Price
    api_response = klimapi.order_by_price(locale=locale, currency=currency, buy_price=buy_price)
    print("The response of KlimApi->order_by_price:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->order_by_price: %s\n" % e)

Parameters

Name	Type	Description	Notes
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]
buy_price	BuyPrice		[optional]

Return type

Order

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got an Order	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pending_by_calculation

PendingOrdersCalculated pending_by_calculation(pending_by_calculation_request, locale=locale, currency=currency)

By Calculation

IMPORTANT: Calling this route using API keys created in the sandbox mode is returning random numbers instead of real calculations.

Example

import klimapi_python
from klimapi_python.models.pending_by_calculation_request import PendingByCalculationRequest
from klimapi_python.models.pending_orders_calculated import PendingOrdersCalculated
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

pending_by_calculation_request = klimapi_python.PendingByCalculationRequest() # PendingByCalculationRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)

try:
    # By Calculation
    api_response = klimapi.pending_by_calculation(pending_by_calculation_request, locale=locale, currency=currency)
    print("The response of KlimApi->pending_by_calculation:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->pending_by_calculation: %s\n" % e)

Parameters

Name	Type	Description	Notes
pending_by_calculation_request	PendingByCalculationRequest	Choose up to 100 Elements from the Calculation Options. In this example it is just Travel by Car.
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]

Return type

PendingOrdersCalculated

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got an Order	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
422	Unknown calculation parameter	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pending_by_carbon

PendingOrders pending_by_carbon(pending_by_carbon_request, locale=locale, currency=currency)

By Carbon

Here you can create an Order by kilogram CO2e. Please note the request limits of your API key, normally it is 15000kg per request. We are happy to increase the limits on request, please write us a message.

Example

import klimapi_python
from klimapi_python.models.pending_by_carbon_request import PendingByCarbonRequest
from klimapi_python.models.pending_orders import PendingOrders
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

pending_by_carbon_request = klimapi_python.PendingByCarbonRequest() # PendingByCarbonRequest | 
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)

try:
    # By Carbon
    api_response = klimapi.pending_by_carbon(pending_by_carbon_request, locale=locale, currency=currency)
    print("The response of KlimApi->pending_by_carbon:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->pending_by_carbon: %s\n" % e)

Parameters

Name	Type	Description	Notes
pending_by_carbon_request	PendingByCarbonRequest
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]

Return type

PendingOrders

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got an Order	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
426	You reached a limit of your API key, contact us to upgrade the default limits	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

pending_by_price

PendingOrders pending_by_price(pending_by_price_request, locale=locale, currency=currency)

By Price

Here you can create an Order by price. Please note the request limits of your API key, normally it is 250€ per request. We are happy to increase the limits on request, please write us a message.

Example

import klimapi_python
from klimapi_python.models.pending_by_price_request import PendingByPriceRequest
from klimapi_python.models.pending_orders import PendingOrders
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

pending_by_price_request = klimapi_python.PendingByPriceRequest() # PendingByPriceRequest | 
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)
currency = EUR # str | The currency of the returned offset price (optional) (default to EUR)

try:
    # By Price
    api_response = klimapi.pending_by_price(pending_by_price_request, locale=locale, currency=currency)
    print("The response of KlimApi->pending_by_price:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->pending_by_price: %s\n" % e)

Parameters

Name	Type	Description	Notes
pending_by_price_request	PendingByPriceRequest
locale	str	The locale in which the response should be returned	[optional] [default to DE]
currency	str	The currency of the returned offset price	[optional] [default to EUR]

Return type

PendingOrders

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	Successfully got an Order	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
426	You reached a limit of your API key, contact us to upgrade the default limits	-
503	Order exceeds default stock limit. Contact us for larger orders and to increase the inventory limit for your API requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

process

Order process(order_id, process_order, locale=locale)

Process Pending Order

You accepted the given order. You may now show a confirmation or provide the link to the certificate.

Example

import klimapi_python
from klimapi_python.models.order import Order
from klimapi_python.models.process_order import ProcessOrder
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

order_id = 'order_id_example' # str | The order id specified in the Order
process_order = klimapi_python.ProcessOrder() # ProcessOrder | 
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Process Pending Order
    api_response = klimapi.process(order_id, process_order, locale=locale)
    print("The response of KlimApi->process:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->process: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	str	The order id specified in the Order
process_order	ProcessOrder
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

Order

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	The processed Order	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
410	The order is no longer available	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

process_cart

Order process_cart(store_ident, order_id, process_order, locale=locale)

Process Cart

Process a given cart to offset the cart's emissions

Example

import klimapi_python
from klimapi_python.models.order import Order
from klimapi_python.models.process_order import ProcessOrder
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

store_ident = 'store_ident_example' # str | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
order_id = 'order_id_example' # str | The order id specified in the Order
process_order = klimapi_python.ProcessOrder() # ProcessOrder | 
locale = DE # str | The locale in which the response should be returned (optional) (default to DE)

try:
    # Process Cart
    api_response = klimapi.process_cart(store_ident, order_id, process_order, locale=locale)
    print("The response of KlimApi->process_cart:\n")
    pprint(api_response)
except Exception as e:
    print("Exception when calling KlimApi->process_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
store_ident	str	Setup a new store here to get a store ident
order_id	str	The order id specified in the Order
process_order	ProcessOrder
locale	str	The locale in which the response should be returned	[optional] [default to DE]

Return type

Order

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
200	The processed Order	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
410	The order is no longer available	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refund

refund(order_id)

Refund Order

Refunding an Order is only available for 30 days after the initial create/process call. Refunding is not available for Checkout Link Orders

Example

import klimapi_python
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

order_id = 'order_id_example' # str | The order id specified in the Order

try:
    # Refund Order
    klimapi.refund(order_id)
except Exception as e:
    print("Exception when calling KlimApi->refund: %s\n" % e)

Parameters

Name	Type	Description	Notes
order_id	str	The order id specified in the Order

Return type

void (empty response body)

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
204	Order successfully refunded	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
410	Order not found or the period of 30 days was exceeded and a refund is no longer available	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_webhook

remove_webhook(add_webhook_request)

Remove Webhook

Remove a Webhook from an integration.

Example

import klimapi_python
from klimapi_python.models.add_webhook_request import AddWebhookRequest
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

add_webhook_request = klimapi_python.AddWebhookRequest() # AddWebhookRequest | 

try:
    # Remove Webhook
    klimapi.remove_webhook(add_webhook_request)
except Exception as e:
    print("Exception when calling KlimApi->remove_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_webhook_request	AddWebhookRequest

Return type

void (empty response body)

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
201	Successfully removed the Webhook	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
500	System unavailable	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sync_bulk_store

sync_bulk_store(store_ident, product)

Sync multiple Products

Use the method to sync multiple products from the given store to our database.

Example

import klimapi_python
from klimapi_python.models.product import Product
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

store_ident = 'store_ident_example' # str | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
product = [klimapi_python.Product()] # List[Product] | 

try:
    # Sync multiple Products
    klimapi.sync_bulk_store(store_ident, product)
except Exception as e:
    print("Exception when calling KlimApi->sync_bulk_store: %s\n" % e)

Parameters

Name	Type	Description	Notes
store_ident	str	Setup a new store here to get a store ident
product	List[Product]

Return type

void (empty response body)

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
204	Products successfully synced	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
413	You exceeded the maximum number of products (100) per request	-
422	Unknown or missing product parameter	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

sync_store

sync_store(store_ident, product)

Sync a single Product

Use the method to sync a single product from the given store to our database.

Example

import klimapi_python
from klimapi_python.models.product import Product
from klimapi_python.rest import ApiException
from pprint import pprint

klimapi = klimapi_python.KlimApi('your-private-api-key')

store_ident = 'store_ident_example' # str | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
product = klimapi_python.Product() # Product | 

try:
    # Sync a single Product
    klimapi.sync_store(store_ident, product)
except Exception as e:
    print("Exception when calling KlimApi->sync_store: %s\n" % e)

Parameters

Name	Type	Description	Notes
store_ident	str	Setup a new store here to get a store ident
product	Product

Return type

void (empty response body)

Authorization

apiKey

HTTP response details

Status code	Description	Response headers
204	Product successfully synced	-
400	Your request is invalid, please check the given parameters	-
401	Your API Key is invalid, deactivated or your account has been suspended	-
422	Unknown or missing product parameter	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

KlimApi.md

Latest commit

History

KlimApi.md

File metadata and controls

Methods

add_webhook

Example

Parameters

Return type

Authorization

HTTP response details

calculate

Example

Parameters

Return type

Authorization

HTTP response details

calculate_cart

Example

Parameters

Return type

Authorization

HTTP response details

get_categories

Example

Parameters

Return type

Authorization

HTTP response details

get_certification_authorities

Example

Parameters

Return type

Authorization

HTTP response details

get_metrics

Example

Parameters

Return type

Authorization

HTTP response details

get_order

Example

Parameters

Return type

Authorization

HTTP response details

get_orders

Example

Parameters

Return type

Authorization

HTTP response details

get_payment_link

Example

Parameters

Return type

Authorization

HTTP response details

get_project

Example

Parameters

Return type

Authorization

HTTP response details

get_projects

Example

Parameters

Return type

Authorization

HTTP response details

link_by_calculation

Example

Parameters

Return type

Authorization

HTTP response details

link_by_carbon