Methods

Method	HTTP request	Description
addWebhook	POST /webhooks/add	Add Webhook
calculate	POST /calculate	Calculate
calculateCart	POST /stores/{store_ident}/cart	Calculate
getCategories	GET /categories	Get all Categories
getCertificationAuthorities	GET /certification_authorities	Get all Certification Authorities
getMetrics	POST /metrics	Order Metrics
getOrder	GET /orders/{order_id}	Get Order
getOrders	POST /orders	Get Orders
getPaymentLink	GET /orders/link/{payment_link_id}	Get Checkout Link
getProject	GET /projects/{project_id}	Get Project
getProjects	GET /projects	Get all supported Projects
linkByCalculation	POST /orders/link/calculate	By Calculation
linkByCarbon	POST /orders/link/carbon	By Carbon
linkByPrice	POST /orders/link/price	By Price
me	GET /me	Get Authenticated User
orderByCalculation	POST /orders/process/calculate	By Calculation
orderByCarbon	POST /orders/process/carbon	By Carbon
orderByPrice	POST /orders/process/price	By Price
pendingByCalculation	POST /orders/pending/calculate	By Calculation
pendingByCarbon	POST /orders/pending/carbon	By Carbon
pendingByPrice	POST /orders/pending/price	By Price
process	POST /orders/{order_id}/process	Process Pending Order
processCart	POST /stores/{store_ident}/cart/{order_id}/process	Process Cart
refund	DELETE /orders/{order_id}/refund	Refund Order
removeWebhook	DELETE /webhooks/remove	Remove Webhook
syncBulkStore	POST /stores/{store_ident}/sync/bulk	Sync multiple Products
syncStore	POST /stores/{store_ident}/sync	Sync a single Product

addWebhook

void addWebhook(addWebhookRequest)

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.addWebhook({
    // AddWebhookRequest
    addWebhookRequest: {
    hookUrl: "hookUrl_example",
    trigger: "order.created",
  },
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: Not defined

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(calculateRequest)

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.calculate({
    // CalculateRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.
    calculateRequest: {
    calculationOptions: [
      null,
    ],
    fractionalDigits: 2,
  },
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

calculateCart

CartResult calculateCart(cartItem, )

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.calculateCart({
    // Array<CartItem>
    cartItem: [
    {
      amount: 1,
      total: 3.14,
      product: {
        productId: "productId_example",
        name: "name_example",
        description: "description_example",
        price: 3.14,
        categories: [
          "categories_example",
        ],
        tags: [
          "tags_example",
        ],
        weight: 3.14,
        weightUnit: "kg",
        madeIn: "madeIn_example",
        emissionFactor: "emissionFactor_example",
        emissionMultiplicator: "price",
      },
    },
  ],
    // string | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
    storeIdent: "store_ident_example",
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

getCategories

Array getCategories()

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getCategories({
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

getCertificationAuthorities

Array getCertificationAuthorities()

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getCertificationAuthorities().then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

getMetrics

OrderMetrics getMetrics(getMetricsRequest)

Get metrics to all orders

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getMetrics({
    // GetMetricsRequest | 
    getMetricsRequest: {
    operator: "AND",
    filters: {
      metadata: {
        "key": "key_example",
      },
      status: "processed",
      recipientName: "recipientName_example",
      recipientEmail: "recipientEmail_example",
      price: 3.14,
      currency: "EUR",
      kgCO2e: 1,
      _from: new Date('1970-01-01T00:00:00.00Z'),
      to: new Date('1970-01-01T00:00:00.00Z'),
    },
  },
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

getOrder

Order getOrder()

Here you can request information about a specific Order.

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getOrder({
    // string | You can get the order_id from several endpoints, for example when creating an Order.
    orderId: "order_id_example",
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

getOrders

MetadataOrders getOrders(getOrdersRequest)

Query all orders

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getOrders({
    // GetOrdersRequest | 
    getOrdersRequest: {
    operator: "AND",
    filters: {
      metadata: {
        "key": "key_example",
      },
      status: "processed",
      recipientName: "recipientName_example",
      recipientEmail: "recipientEmail_example",
      price: 3.14,
      currency: "EUR",
      kgCO2e: 1,
      _from: new Date('1970-01-01T00:00:00.00Z'),
      to: new Date('1970-01-01T00:00:00.00Z'),
    },
    limit: 10,
    skip: 0,
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

getPaymentLink

CheckoutLink getPaymentLink()

Here you can request information about a specific Checkout Link.

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getPaymentLink({
    // string | The identifier of the checkout link that you want to be returned.
    paymentLinkId: "payment_link_id_example",
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

getProject

Project getProject()

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getProject({
    // string | You can get the project_id from several endpoints, for example when creating an Order.
    projectId: "project_id_example",
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

getProjects

Array getProjects()

Get all projects you supported with the given API key.

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.getProjects({
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

linkByCalculation

CheckoutLinksCalculated linkByCalculation(linkByCalculationRequest)

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.linkByCalculation({
    // LinkByCalculationRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.
    linkByCalculationRequest: {
    calculationOptions: [
      null,
    ],
    changeAllowed: false,
    successUrl: "successUrl_example",
    cancelUrl: "cancelUrl_example",
    orderCount: 1,
    metadata: {
      "key": "key_example",
    },
    fractionalDigits: 2,
    paymentType: "default",
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

linkByCarbon

CheckoutLinks linkByCarbon()

Get the compensation instantly by kilogram CO2e.

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.linkByCarbon({
    // LinkByCarbonRequest (optional)
    linkByCarbonRequest: {
    kgCO2e: 1,
    changeAllowed: false,
    successUrl: "successUrl_example",
    cancelUrl: "cancelUrl_example",
    orderCount: 1,
    metadata: {
      "key": "key_example",
    },
    paymentType: "default",
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

linkByPrice

CheckoutLinks linkByPrice()

Get the compensation instantly by price.

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.linkByPrice({
    // LinkByPriceRequest (optional)
    linkByPriceRequest: {
    priceAmount: 0.5,
    changeAllowed: false,
    successUrl: "successUrl_example",
    cancelUrl: "cancelUrl_example",
    orderCount: 1,
    metadata: {
      "key": "key_example",
    },
    paymentType: "default",
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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

any me()

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.me().then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

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]

orderByCalculation

OrderCalculated orderByCalculation(orderByCalculationRequest)

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.orderByCalculation({
    // OrderByCalculationRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.
    orderByCalculationRequest: {
    calculationOptions: [
      null,
    ],
    recipientName: "recipientName_example",
    recipientEmail: "recipientEmail_example",
    sendAt: new Date('1970-01-01T00:00:00.00Z'),
    priceLimit: 0.5,
    metadata: {
      "key": "key_example",
    },
    fractionalDigits: 2,
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

orderByCarbon

Order orderByCarbon()

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.orderByCarbon({
    // BuyAmount (optional)
    buyAmount: {
    kgCO2e: 1,
    recipientName: "recipientName_example",
    recipientEmail: "recipientEmail_example",
    sendAt: new Date('1970-01-01T00:00:00.00Z'),
    priceLimit: 0.5,
    metadata: {
      "key": "key_example",
    },
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

orderByPrice

Order orderByPrice()

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.orderByPrice({
    // BuyPrice (optional)
    buyPrice: {
    priceAmount: 0.5,
    recipientName: "recipientName_example",
    recipientEmail: "recipientEmail_example",
    sendAt: new Date('1970-01-01T00:00:00.00Z'),
    metadata: {
      "key": "key_example",
    },
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

pendingByCalculation

PendingOrdersCalculated pendingByCalculation(pendingByCalculationRequest)

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.pendingByCalculation({
    // PendingByCalculationRequest | Choose up to 100 Elements from the **[Calculation Options](https://klimapi.com/resources/factors)**. In this example it is just **Travel by Car**.
    pendingByCalculationRequest: {
    calculationOptions: [
      null,
    ],
    orderCount: 1,
    metadata: {
      "key": "key_example",
    },
    fractionalDigits: 2,
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

pendingByCarbon

PendingOrders pendingByCarbon(pendingByCarbonRequest)

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

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.pendingByCarbon({
    // PendingByCarbonRequest
    pendingByCarbonRequest: {
    kgCO2e: 1,
    orderCount: 1,
    metadata: {
      "key": "key_example",
    },
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

pendingByPrice

PendingOrders pendingByPrice(pendingByPriceRequest)

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

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.pendingByPrice({
    // PendingByPriceRequest
    pendingByPriceRequest: {
    priceAmount: 0.5,
    orderCount: 1,
    metadata: {
      "key": "key_example",
    },
  },
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
    // 'EUR' | 'USD' | 'GBP' | 'CHF' | 'CAD' | 'NOK' | 'SEK' | 'DKK' | 'INR' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BWP' | 'BZD' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GIP' | 'GMD' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'ISK' | 'JMD' | 'KES' | 'KGS' | 'KHR' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'MAD' | 'MDL' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'RSD' | 'SBD' | 'SCR' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SZL' | 'THB' | 'TJS' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UYU' | 'UZS' | 'WST' | 'XCD' | 'YER' | 'ZAR' | 'ZMW' | The currency of the returned offset price (optional)
    X_CURRENCY: "EUR",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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(processOrder, )

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.process({
    // ProcessOrder
    processOrder: {
    recipientName: "recipientName_example",
    recipientEmail: "recipientEmail_example",
    sendAt: new Date('1970-01-01T00:00:00.00Z'),
    metadata: {
      "key": "key_example",
    },
  },
    // string | The order id specified in the Order
    orderId: "order_id_example",
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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]

processCart

Order processCart(processOrder, )

Process a given cart to offset the cart's emissions

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.processCart({
    // ProcessOrder
    processOrder: {
    recipientName: "recipientName_example",
    recipientEmail: "recipientEmail_example",
    sendAt: new Date('1970-01-01T00:00:00.00Z'),
    metadata: {
      "key": "key_example",
    },
  },
    // string | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
    storeIdent: "store_ident_example",
    // string | The order id specified in the Order
    orderId: "order_id_example",
    // 'DE' | 'EN' | 'ES' | 'FR' | 'IT' | 'NL' | 'PL' | 'PT' | 'SV' | 'SL' | 'FI' | 'BG' | 'CS' | 'DA' | 'EL' | 'ET' | 'HU' | 'LT' | 'LV' | 'RO' | 'SK' | The locale in which the response should be returned (optional)
    X_LOCALE: "DE",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

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

void refund()

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.refund({
    // string | The order id specified in the Order
    orderId: "order_id_example",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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]

removeWebhook

void removeWebhook(addWebhookRequest)

Remove a Webhook from an integration.

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.removeWebhook({
    // AddWebhookRequest
    addWebhookRequest: {
    hookUrl: "hookUrl_example",
    trigger: "order.created",
  },
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: Not defined

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]

syncBulkStore

void syncBulkStore(product, )

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.syncBulkStore({
    // Array<Product>
    product: [
    {
      productId: "productId_example",
      name: "name_example",
      description: "description_example",
      price: 3.14,
      categories: [
        "categories_example",
      ],
      tags: [
        "tags_example",
      ],
      weight: 3.14,
      weightUnit: "kg",
      madeIn: "madeIn_example",
      emissionFactor: "emissionFactor_example",
      emissionMultiplicator: "price",
    },
  ],
    // string | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
    storeIdent: "store_ident_example",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: Not defined

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]

syncStore

void syncStore(product, )

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

Example

const { KlimApi } = require('@klimapi/klimapi-node');

const klimapi = new KlimApi('your-private-api-key');

klimapi.syncStore({
    // Product
    product: {
    productId: "productId_example",
    name: "name_example",
    description: "description_example",
    price: 3.14,
    categories: [
      "categories_example",
    ],
    tags: [
      "tags_example",
    ],
    weight: 3.14,
    weightUnit: "kg",
    madeIn: "madeIn_example",
    emissionFactor: "emissionFactor_example",
    emissionMultiplicator: "price",
  },
    // string | Setup a new store **[here](https://klimapi.com/dashboard/ecommerce)** to get a store ident
    storeIdent: "store_ident_example",
}).then((data) => {
    console.log('API called successfully. Returned data: ');
    console.log(data);
}).catch((error) => console.error(error));

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

addWebhook

Example

Authorization

HTTP request headers

HTTP response details

calculate

Example

Authorization

HTTP request headers

HTTP response details

calculateCart

Example

Authorization

HTTP request headers

HTTP response details

getCategories

Example

Authorization

HTTP request headers

HTTP response details

getCertificationAuthorities

Example

Authorization

HTTP request headers

HTTP response details

getMetrics

Example

Authorization

HTTP request headers

HTTP response details

getOrder

Example

Authorization

HTTP request headers

HTTP response details

getOrders

Example

Authorization

HTTP request headers

HTTP response details

getPaymentLink

Example

Authorization

HTTP request headers

HTTP response details

getProject

Example

Authorization

HTTP request headers

HTTP response details

getProjects

Example

Authorization

HTTP request headers

HTTP response details

linkByCalculation

Example

Authorization

HTTP request headers

HTTP response details

linkByCarbon

Example

Authorization

HTTP request headers

HTTP response details

linkByPrice

Example

Authorization

HTTP request headers

HTTP response details

me

Example

Authorization