Quick Start

Get your API keys

Your API requests are authenticated using API keys. Any request that does not include an API key will return an error. Sign up for Cooler today to get started and navigate to the Accounts tab to retrieve your test and production API keys.

Note: We limit test api key usage as means for you to explore the API

Make your first footprint request

Send an authenticated request to the products footprint endpoint.

Calculate footprint for a given product

POST/v1/footprint/products

Authorization

bearer

Header parameters

Body

application/json

automaticallyNeutralizeboolean

on successful footprint, all transaction items will be neutralized

processSyncronouslyboolean

whether this transaction should be processed syncronously instead of asyncronously (default)

items*array of TransactionItemDto (object)

array of transaction items to footprint

currencystring

The currency of the items we need to footprint, in case we need to convert

Response

200400401404500

OK

Request

JavaScriptCurl

const response = await fetch('/v1/footprint/products', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "items": [
        {
          "price": 99,
          "sku": "de6879ee"
        }
      ]
    }),
});
const data = await response.json();

Take a look at how you might call this method via curl:

curl

curl -X 'POST' \
  'http://api.cooler.dev/v1/footprint/products' \
  -H 'accept: */*' \
  -H 'COOLER-API-KEY: YOUR_COOLER_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "automaticallyNeutralize": false,
  "processSyncronously": true,
  "items": [
    {
      "price": 999,
      "sku": "123",
      "store": "Apple - Legacy Place",
      "externalId": "456",
      "manufacturer": "Apple",
      "title": "iPhone X",
      "category": "consumer electronics",
      "zip": "02119",
      "isUsed": false
    }
  ],
  "currency": "USD"
}'

Make your first neutralization request

Mark this transaction for neutralization

POST/v1/neutralize/transactions/{id}

Authorization

bearer

Path parameters

id*string

the transaction to neutralize

Header parameters

Response

200400401404500

OK

Request

JavaScriptCurl

const response = await fetch('/v1/neutralize/transactions/{id}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Take a look at how you might call this method via curl:

curl

curl -X 'POST' \
  'http://api.cooler.dev/v1/neutralize/transactions/8a3c06b4-0840-46f2-9634-557ce041037a' \
  -H 'accept: */*' \
  -H 'COOLER-API-KEY: YOUR_COOLER_API_KEY'
}'