Get List of Orders

GET

orders

curl --request GET \
  --url https://api.cnaught.com/v1/orders \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "Gre28Fc35bt3",
      "order_number": "47726-53238-46633-33562-7433",
      "created_on": "2022-08-01T18:00:00.000000Z",
      "metadata": "Customer metadata",
      "description": "On behalf of Jane Smith",
      "amount_kg": 10.5,
      "state": "fulfilled",
      "price_usd_cents": 2350,
      "certificate_public_url": "https://registry.cnaught.com/orders/Gre28Fc35bt3",
      "certificate_download_public_url": "https://registry.cnaught.com/api/certificates/Gre28Fc35bt3/pdf"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Subaccount-Id

string

If present, scopes the operation to the subaccount with given id. See Subaccounts for more info.

Query Parameters

limit

integer | null

default:20

Limits the number of orders returned, default is 20, max is 100

Required range: 1 <= x <= 100

starting_after

string | null

If specified, returns orders submitted before (earlier than) the order with this id, exclusive (order with this id is not included). Only one of starting_after and ending_before can be specified.

ending_before

string | null

If specified, returns orders submitted after (later than) the order with this id, exclusive (order with this id is not included). Only one of starting_after and ending_before can be specified.

Response

200

application/json

List of orders

data

object[]

data.id

string

Identifier that can be used to retrieve the order details

Example:

"Gre28Fc35bt3"

data.order_number

string

Hex representation derived from the order id that will be shown on the certificate

Example:

"47726-53238-46633-33562-7433"

data.created_on

string

Timestamp of when the order was created (in UTC)

data.metadata

string | null

Optional metadata that was provided with the order

Maximum length: 512

Example:

"internal_order_id=12345"

data.description

string | null

Optional public description for the order that will be shown on the certificate, as provided when order was placed

Maximum length: 512

Example:

"on behalf of Jane Smith"

data.amount_kg

number

Amount of credits purchased, in kg of CO₂e

Example:

10.5

data.state

enum<string>

The current state of the order.

placed - the order has been placed, and is waiting to be matched against available credits in our system.
fulfilled - the order has been fulfilled by matching it against available credits in our system, which have been retired.
canceled - the order has been canceled

Available options:

placed,

fulfilled,

cancelled

data.price_usd_cents

number

Amount charged for the credits purchased, in USD cents

Example:

2350

data.callback_url

string

Callback URL to invoke when status of the order changes, if specified in the order

data.certificate_public_url

string | null

URL for the publicly accessible page showing order details and the certificate. This will be null if the order state is cancelled

Example:

"https://registry.cnaught.com/orders/ABCDE"

data.certificate_download_public_url

string | null

URL for downloading the certificate PDF. This will be null if the order state is cancelled

Example:

"https://registry.cnaught.com/api/certificates/ABCDE/pdf"

data.project_allocations

object[]

For fulfilled orders, a list of the projects that were used to fulfill the order

data.project_allocations.project

object

Details of the project for this allocation

data.project_allocations.project.id

string

Identifier that can be used to retrieve the project details

Example:

"Fc35bt3"

data.project_allocations.project.name

string

Name of the project

Example:

"Liling Landfill Gas Project"

data.project_allocations.project.summary

string | null

A short summary of the project

Example:

"Lorem Ipsum"

data.project_allocations.project.description

string | null

A longer description of the project

Example:

"Lorem Ipsum Shmipsum"

data.project_allocations.project.type

string

Type of project, eg Afforrestation, Renewable Energy, etc

Example:

"REDD"

data.project_allocations.project.activity_types

string[]

List of activity types for the project

Example:

["Landfill Gas", "Renewable Energy"]

data.project_allocations.project.developer

string | null

The name of the company or organization sponsoring the project

Example:

"Charm Industrial"

data.project_allocations.project.registry_name

string | null

The name of the registry on which the project's credits are registered

Example:

"Verra"

data.project_allocations.project.registry_id

string | null

The id of the project within the registry

Example:

824

data.project_allocations.project.registry_url

string | null

The full url to the project's documentation on the registry website

Example:

"https://registry.verra.org/app/projectDetail/VCS/824"

data.project_allocations.project.location_name

string | null

Location of the project

Example:

"Fujian Province, China"

data.project_allocations.project.location_latitude

number | null

Latitude for the location of the project

Example:

26.0833

data.project_allocations.project.location_longitude

number | null

Longitude for the location of the project

Example:

119.3

data.project_allocations.project.primary_image_url

string | null

URL for the primary image of the project

Example:

"https://assets.cnaught.com/63a4ad4c853f90fd4c455107/64122d1dcf47f3840933826a_charm-industrial.jpg"

data.project_allocations.project.un_sdg_goals

number[]

list of UN Sustainable Development Goals supported by this project; see https://sdgs.un.org/goals

Example:

[1, 4, 6]

data.project_allocations.project.methodology

string | null

The methodology used for the project

Example:

"VM0010"

data.project_allocations.project.verifier

string | null

The verifier of the project

Example:

"DNV GL"

data.project_allocations.project.permanence

string | null

Information about the permanence of the carbon removal

Example:

"100+ years"

data.project_allocations.project.lifetime

object

The lifetime of the project

data.project_allocations.project.impact_type

string | null

The type of impact the project has (avoided emissions, removal, or mix of both)

Example:

"Avoided Emissions"

data.project_allocations.project.due_diligence

string | null

Information about the due diligence performed on the project

Example:

"Extensive verification process was conducted..."

data.project_allocations.project.beyond_carbon

string | null

Information about benefits beyond carbon reduction

Example:

"This project also supports local communities..."

data.project_allocations.project.risk_of_reversal

string | null

Information about the risk of carbon reversal

Example:

"Low risk due to long-term conservation agreements..."

data.project_allocations.project.third_party_labels

string[] | null

List of third-party labels or certifications

Example:

["Gold Standard", "Climate Action Reserve"]

data.project_allocations.project.notable_buyers

object[] | null

List of notable buyers of credits from this project

data.project_allocations.project.due_diligence_figure

object | null

Figure illustrating due diligence information

data.project_allocations.project.news_articles

object[] | null

List of news articles related to the project

data.project_allocations.amount_kg

number

Amount (in kg CO₂e) of the order fulfilled from this project

Example:

1000

data.project_allocations.retirements

object[]

List of retirement records for this project allocation

data.checkout_session_id

string | null

Id of the checkout session whose completion resulted in the creation of this order. Null if the order did not originate from a checkout session.

Example:

"zpQ6QSNRQh"

Overview Create Carbon Credits Order

curl --request GET \
  --url https://api.cnaught.com/v1/orders \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "Gre28Fc35bt3",
      "order_number": "47726-53238-46633-33562-7433",
      "created_on": "2022-08-01T18:00:00.000000Z",
      "metadata": "Customer metadata",
      "description": "On behalf of Jane Smith",
      "amount_kg": 10.5,
      "state": "fulfilled",
      "price_usd_cents": 2350,
      "certificate_public_url": "https://registry.cnaught.com/orders/Gre28Fc35bt3",
      "certificate_download_public_url": "https://registry.cnaught.com/api/certificates/Gre28Fc35bt3/pdf"
    }
  ]
}

API Documentation

Orders

Quotes

Subaccounts

Checkout Sessions

Climate Impact

Projects

Portfolios

Authorizations

Headers

Query Parameters

Response