{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"b4822c94-b675-4a4f-8e8b-103930ad662e","name":"Purchasing API","description":"The Carbon Direct Purchasing API helps companies run and grow carbon programs that are seamlessly integrated with their products and partners. Our API is organized around REST.\n\nA carbon removal portfolio is a collection of credits from one or more projects. You can integrate our API to purchase carbon removal tonnes for multiple carbon management use cases:\n\n1. Integrate the API into your operations to cover your carbon footprint\n2. Offer the API to your customers, partners, or vendors to make it easy for them to decarbonize\n    \n\nPurchases can be done at the fractional tonne amount so you only have to purchase what you need. A sample portfolio might have the following composition to meet your cost, permanence, and co-benefits goals:\n\nSample Portfolio: 2023 Solutions Blend\n\n| Project | Volume (tCO2e) | Vintage Type | Vintage Year |\n| --- | --- | --- | --- |\n| Sample Project 2 Bio-Oil | 10000 | ex-post | 2022 |\n| Sample Project 3 Biochar | 12000 | ex-ante | 2023 |\n| Sample Project 4 Improved Forest Management | 150000 | Combination of ex-post and ex-ante | 2021, 2023 |\n\n**Authentication / Authorization**\n\nAll CDX Purchasing API endpoints use API key authentication. To authenticate with any endpoint, you need to provide Carbon Direct-issued API key in your request header (`x-api-key`). Otherwise, an _HTTP (401) Unauthorized_ error will be returned by the endpoint with a corresponding error code:\n\n| **Error Code** | **Description** |\n| --- | --- |\n| INVALID_API_KEY | Invalid API key |\n| MISSING_API_KEY | API key missing from request header |\n\nCDX Purchasing API returns an _HTTP (403) Forbidden error_ for an authenticated API key with no access to the portfolio.\n\n| **Error Code** | **Description** |\n| --- | --- |\n| ACCESS_DENIED | This API key does not have access to the portfolio. |\n\n**Error Handling**\n\nIn addition to the error codes specified in the previous section, below [HTTP status codes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) may also be returned by the API in the response:\n\n| **Status Code** | **Status Meaning** |\n| --- | --- |\n| 400 | BAD_REQUEST |\n| 401 | UNAUTHORIZED |\n| 403 | FORBIDDEN |\n| 404 | NOT_FOUND |\n| 422 | UNPROCESSABLE_ENTITY |\n| 500 | INTERNAL_SERVER_ERROR |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19840007","collectionId":"b4822c94-b675-4a4f-8e8b-103930ad662e","publishedId":"UyrADwJt","public":true,"publicUrl":"https://demo.carbondirect.xyz","privateUrl":"https://go.postman.co/documentation/19840007-b4822c94-b675-4a4f-8e8b-103930ad662e","customColor":{"top-bar":"0D5F41","right-sidebar":"303030","highlight":"26956D"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2023-03-14T17:42:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Carbon Direct Demo Mock Server","id":"73e13b26-4cda-4271-a997-789cbc3a87a9","owner":"19840007","values":[{"key":"url","value":"https://demo.carbondirect.xyz","enabled":true,"type":"default"},{"key":"api_key","value":"valid_api_key_here","enabled":true,"type":"secret"},{"key":"portfolioId","value":"cnFzWA","enabled":true,"type":"default"},{"key":"projectId","value":"CFtAnx","enabled":true,"type":"default"},{"key":"partnerId","value":"0zWs5mz2zyoy1j5aN3fK","enabled":true,"type":"default"},{"key":"collectionId","value":"19840007-b4822c94-b675-4a4f-8e8b-103930ad662e","enabled":true,"type":"default"},{"key":"portfolioIdO1","value":"cnFzWA","enabled":true,"type":"default"},{"key":"portfolioIdO2","value":"mUIMAg","enabled":true,"type":"default"},{"key":"portfolioIdO3","value":"bRpoMn","enabled":true,"type":"default"},{"key":"projectIdP4","value":"CFtAnx","enabled":true,"type":"default"},{"key":"projectIdP5","value":"rnXCaO","enabled":true,"type":"default"},{"key":"projectIdP1","value":"xK4Yir","enabled":true,"type":"default"},{"key":"projectIdP2","value":"QSmhyg","enabled":true,"type":"default"},{"key":"projectIdP3","value":"EjY1wo","enabled":true,"type":"default"},{"key":"txnId","value":"PZ2SocwW","enabled":true,"type":"default"},{"key":"refId","value":"OHfVxg5S","enabled":true,"type":"default"},{"key":"orderId","value":"nH1f0W3wfcGxc6uzaOOIx","enabled":true,"type":"default"},{"key":"footprint_id","value":"FootPrint2OTtClrnhS1T","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://carbondirect.xyz/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Carbon Direct Demo Mock Server","value":"19840007-73e13b26-4cda-4271-a997-789cbc3a87a9"}],"canonicalUrl":"https://demo.carbondirect.xyz/view/metadata/UyrADwJt"}