CarbonSutra API calculates the carbon emission footprint for your organization. Hosted at ZYLA, it can be instantly tested by yourself at no cost.
This is an advanced algorithm to estimate the emissions of a package's journey from its shipment location to its collection point. The starting and end points of journey are matched with a database of 1.5 million postal codes within 95 countries.
If the distance between coordinates is above a threshold, we find the nearest airports from these postal codes using a dataset of 9,200 airports. The final distance of journey is then a sum of the legs: first, the distance between the starting postal code and its nearest airport by land, second, the distance between destination airport and postal code of collection point by land and lastly, the journey between the two airports by air.
Optionally, you can add radiative forcing multipliers for the flight and well to tank upstream emission factors if needed. Using recommended conversion factors from BEIS and guidelines from ECTA, the API calculates the final emission based on weight of package and returns the value of carbon dioxide equivalent in kilograms, metric tonnes and pounds.
This is an advanced algorithm to estimate the emissions of a package's journey from its shipment location to the collection point. If the distance between two postal codes is above a threshold, we find the nearest airports from the origin and then from the destination location. The final distance of journey is then a sum of the distance between the origin postal code and nearest airport by land, air travel between the airports closest to the origin and the destination and finally, land travel between destination airport and postal code of collection point by land. The final calculation follows ECTA/Cefic and BEIS/DEFRA's recommended conversion factors and works on a database of over 1.5 million postal codes across 95 countries and 9,200 global airports.
Product Page: https://www.carbonsutra.com/api-carbon-emission-freight-ecommerce-shipments.html
Introduction Video: https://www.youtube.com/watch?v=jPaM0kV0A-0
The spreadsheet (Google Sheets) function is explained at https://www.youtube.com/watch?v=nq9Im6xNwa4
The following country codes are covered in the current version of API: AD (Andorra), AR (Argentina), AS (American Samoa), AT (Austria), AU (Australia), AX (Åland Islands), AZ (Azerbaijan), BD (Bangladesh), BE (Belgium), BG (Bulgaria), BM (Bermuda), BR (Brazil), BY (Belarus), CA (Canada), CH (Switzerland), CL (Chile), CO (Colombia), CR (Costa Rica), CY (Cyprus), CZ (Czechia), DE (Germany), DK (Denmark), DO (Dominican Republic (the)), DZ (Algeria), EE (Estonia), ES (Spain), FI (Finland), FM (Micronesia (Federated States of)), FO (Faroe Islands (the)), FR (France), GB (United Kingdom of Great Britain and Northern Ireland (the)), GF (French Guiana), GG (Guernsey), GL (Greenland), GP (Guadeloupe), GT (Guatemala), GU (Guam), HR (Croatia), HT (Haiti), HU (Hungary), IE (Ireland), IM (Isle of Man), IN (India), IS (Iceland), IT (Italy), JE (Jersey), JP (Japan), KR (Korea (the Republic of)), LI (Liechtenstein), LK (Sri Lanka), LT (Lithuania), LU (Luxembourg), LV (Latvia), MC (Monaco), MD (Moldova (the Republic of)), MH (Marshall Islands (the)), MK (Republic of North Macedonia), MP (Northern Mariana Islands (the)), MQ (Martinique), MT (Malta), MW (Malawi), MX (Mexico), MY (Malaysia), NC (New Caledonia), NL (Netherlands (the)), NO (Norway), NZ (New Zealand), PE (Peru), PH (Philippines (the)), PK (Pakistan), PL (Poland), PM (Saint Pierre and Miquelon), PR (Puerto Rico), PT (Portugal), PW (Palau), RE (Réunion), RO (Romania), RS (Serbia), RU (Russian Federation (the)), SE (Sweden), SG (Singapore), SI (Slovenia), SJ (Svalbard and Jan Mayen), SK (Slovakia), SM (San Marino), TH (Thailand), TR (Turkey), UA (Ukraine), US (United States of America (the)), UY (Uruguay), VA (Holy See (the)), VI (Virgin Islands (U.S.)), WF (Wallis and Futuna), YT (Mayotte) and ZA (South Africa).
The following fields are ingested:
ORIGIN_COUNTRY_CODE : Mandatory. Two letter code of the country from where the package is starting the journey.
ORIGIN_POSTAL_CODE : Mandatory. The postal code in the origin country from where the package is being shipped.
DESTINATION_COUNTRY_CODE : Mandatory. Two letter code of the country of package's destination.
DESTINATION_POSTAL_CODE : Mandatory. The postal code in the destination country to where the package is collected.
PACKAGE_WEIGHT : Mandatory. The weight of package in kilograms (KG). If an undefined value is passed, it will be set to 1.00
ADD_RF : Optional. A "Y" would add radiative forcing multiplier factor in the footprint calculation, while a "N" will bypass it. The default value is "N". This is used only if the algorithm considers air travel in its calculation.
INCLUDE_WTT : Optional. A "Y" would include the Well-to-Tank (WTT) factors to the footprint calculation, while a "N" will bypass it. The default value is "N".
Object | Description |
---|---|
origin_country_code |
[Required] Two letter code of the country from where the package is starting the journey. |
origin_postal_code |
[Required] The postal code in the origin country from where the package is being shipped. |
destination_country_code |
[Required] Two letter code of the country of package's destination. |
destination_postal_code |
[Required] The postal code in the destination country to where the package is collected. |
package_weight |
[Required] The weight of package in kilograms (KG). If an undefined value is passed, it will be set to 1.00 |
add_rf |
[Optional] A "Y" would add radiative forcing multiplier factor in the footprint calculation, while a "N" will bypass it. The default value is "N". This is used only if the algorithm considers air travel in its calculation. |
include_wtt |
[Optional] A "Y" would include the Well-to-Tank (WTT) factors to the footprint calculation, while a "N" will bypass it. The default value is "N". |
{
"data": {
"type": "estimate-ecommerce",
"origin_country_code": "IN",
"origin_postal_code": "248001",
"destination_country_code": "US",
"destination_postal_code": "90210",
"package_weight": "12",
"add_rf": "N",
"include_wtt": "N",
"co2e_gm": 179,
"co2e_kg": 0.18,
"co2e_mt": 0,
"co2e_lb": 0.4
},
"success": true,
"status": 200
}
curl --location --request POST 'https://zylalabs.com/api/2853/carbon+footprint+of+ecommerce+shipment+api/2969/emissions+from+ecommerce+shipments?origin_country_code=US&origin_postal_code=90210&destination_country_code=IN&destination_postal_code=248002&package_weight=12' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Carbon Footprint of eCommerce Shipment API REST API, simply include your bearer token in the Authorization header.
Header | Description |
---|---|
Authorization
|
[Required] Should be Bearer access_key . See "Your API Access Key" above when you are subscribed. |
No long term commitments. One click upgrade/downgrade or cancellation. No questions asked.
Zyla API Hub is, in other words, an API MarketPlace. An all-in-one solution for your developing needs. You will be accessing our extended list of APIs with only your user. Also, you won't need to worry about storing API keys, only one API key for all our products is needed.
Prices are listed in USD. We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world’s most reliable payment companies. If you have any trouble with paying by card, just contact us at [email protected]
Sometimes depending on the bank's fraud protection settings, a bank will decline the validation charge we make when we attempt to be sure a card is valid. We recommend first contacting your bank to see if they are blocking our charges. If more help is needed, please contact [email protected] and our team will investigate further
Prices are based on a recurring monthly subscription depending on the plan selected — plus overage fees applied when a developer exceeds a plan’s quota limits. In this example, you'll see the base plan amount as well as a quota limit of API requests. Be sure to notice the overage fee because you will be charged for each additional request.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
Just go to the pricing page of that API and select the plan that you want to upgrade to. You will only be charged the full amount of that plan, but you will be enjoying the features that the plan offers right away.
Yes, absolutely. If you want to cancel your plan, simply go to your account and cancel on the Billing page. Upgrades, downgrades, and cancellations are immediate.
You can contact us through our chat channel to receive immediate assistance. We are always online from 9 am to 6 pm (GMT+1). If you reach us after that time, we will be in contact when we are back. Also you can contact us via email to [email protected]
Service Level:
100%
Response Time:
990ms
Service Level:
94%
Response Time:
308ms
Service Level:
99%
Response Time:
131ms
Service Level:
100%
Response Time:
559ms
Service Level:
100%
Response Time:
215ms
Service Level:
100%
Response Time:
224ms
Service Level:
100%
Response Time:
997ms
Service Level:
100%
Response Time:
1,155ms
Service Level:
100%
Response Time:
965ms
Service Level:
100%
Response Time:
958ms
Service Level:
100%
Response Time:
995ms
Service Level:
100%
Response Time:
334ms
Service Level:
100%
Response Time:
1,039ms
Service Level:
100%
Response Time:
315ms
Service Level:
100%
Response Time:
808ms
Service Level:
100%
Response Time:
553ms
Service Level:
100%
Response Time:
501ms