Documentation

# Orders

Get a quote, create and fetch orders.

# Create an order by mass

Create an order to purchase carbon offset by specifying a mass in tonnes or kilograms.

POST /orders/by-mass
Request Body Schema
200 Order created successfully. The response returns an Order object.
400 Bad Request
401 Unauthorized. The API Key is invalid or disabled.
409 Conflict Examples: 1. account is suspended 2. order idempotency failure: an order with the same idempotency_key has already by created
415 The request is not an application/json encoded request
429 Rate limit exceeded

# Create an order by value

Create an order to purchase carbon offset by specifying a maximum purchase value.

POST /orders/by-value
Request Body Schema
200 Order created successfully. The response returns an Order object.
400 Bad Request
401 Unauthorized. The API Key is invalid or disabled.
409 Conflict Examples: 1. account is suspended 2. order idempotency failure: an order with the same idempotency_key has already by created
415 The request is not an application/json encoded request
429 Rate limit exceeded

# Create an order from an emission estimate

Create an order to purchase carbon offset by specifying an estimate id

POST /orders/by-estimate
Request Body Schema
200 Order created successfully. The response returns an Order object.
400 Bad Request
401 Unauthorized. The API Key is invalid or disabled.
409 Conflict Examples: 1. account is suspended 2. order idempotency failure: an order with the same idempotency_key has already by created 3. order for this emission estimate has already been placed
415 The request is not an application/json encoded request
429 Rate limit exceeded

# Get orders

Returns paginated account orders ordered by creation date descending

The API key used to access this method affects what orders are returned: test orders for the test API key, live orders for the live one.

GET /orders
Query parameters
200 The response returns paginated orders
401 Unauthorized. The API Key is invalid or disabled.
429 Rate limit exceeded

# Get an order

Returns an order by id if it exists.

GET /orders/{id}
Path parameters
200 The response returns an order
404 The order does not exist
429 Rate limit exceeded

# Get a carbon offset certificate

Download a Carbon Offset Certificate for a completed order.

GET /orders/{id}/certificate
Path parameters
200 The response returns the Carbon Offset Certificate
404 The order or the certificate does not exist
429 Rate limit exceeded

# Get an order by idempotency key

Returns an order by idempotency key if it exists.

GET /orders/by-idempotency-key/{idempotencyKey}
Path parameters
200 The response returns an order
404 The order does not exist
429 Rate limit exceeded

# Calculate an order quote by mass

This endpoint does not create an order.

However, it processes the order as if it were placed returning estimated cost and bundles allocations.

POST /orders/by-mass/quote
Request Body Schema
200 Order quote processed successfully.
400 Bad Request
401 Unauthorized. The API Key is invalid or disabled.
409 Conflict Examples: 1. quantity not positive: the calculated quote results in non positive quantity
415 The request is not an application/json encoded request
429 Rate limit exceeded

# Calculate an order quote by value

This endpoint does not create an order.

However, it processes the order as if it were placed returning estimated cost and bundles allocations.

POST /orders/by-value/quote
Request Body Schema
200 Order quote processed successfully.
400 Bad Request
401 Unauthorized. The API Key is invalid or disabled.
409 Conflict Examples: 1. quantity not positive: the calculated quote results in non positive quantity
415 The request is not an application/json encoded request
429 Rate limit exceeded

← Projects →