Orders

Create Carbon Credits Order

Submits an order for a specified amount of carbon credits (in kilograms) or a designated total price (in SAR halalas). The order remains in the placed state until it is matched with available credits, at which point it transitions to the fulfilled state. If a total price is specified, the system calculates the corresponding amount of carbon credits based on the unit price of the selected portfolio. Since carbon credits must be purchased in whole kilograms, the final total price may vary slightly from the initially specified amount.

POST

orders

curl --request POST \
  --url https://carbon-engine.onrender.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "portfolioId": "<string>",
  "amount_kg": 123,
  "description": "<string>",
  "customer": "<string>"
}'

[
  {
    "_id": "<string>",
    "orderNumber": "<string>",
    "customer": "<string>",
    "description": "<string>",
    "price_sar_halalas": 123,
    "amount_kg": 123,
    "creditsPurchased": 123,
    "callbackUrl": "<string>",
    "state": "<string>",
    "portfolio": "<string>",
    "certificateUrl": "<string>",
    "projectRecords": [
      {
        "project_id": "<string>",
        "project_category_id": "<string>",
        "credit_batch_id": "<string>",
        "delta": 123,
        "recorded_on": "2023-11-07T05:31:56Z"
      }
    ],
    "invoice": {
      "amountDueSarHalalas": 123,
      "balanceAppliedSarHalalas": 123,
      "receiptUrl": "<string>"
    }
  }
]

Authorizations

Authorization

string

header

required

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

Body

application/json

Response

201

application/json

Order placed successfully

The response is of type object[].

Get Quote for Ground Transport Emissions Cancel Order

curl --request POST \
  --url https://carbon-engine.onrender.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "portfolioId": "<string>",
  "amount_kg": 123,
  "description": "<string>",
  "customer": "<string>"
}'

[
  {
    "_id": "<string>",
    "orderNumber": "<string>",
    "customer": "<string>",
    "description": "<string>",
    "price_sar_halalas": 123,
    "amount_kg": 123,
    "creditsPurchased": 123,
    "callbackUrl": "<string>",
    "state": "<string>",
    "portfolio": "<string>",
    "certificateUrl": "<string>",
    "projectRecords": [
      {
        "project_id": "<string>",
        "project_category_id": "<string>",
        "credit_batch_id": "<string>",
        "delta": 123,
        "recorded_on": "2023-11-07T05:31:56Z"
      }
    ],
    "invoice": {
      "amountDueSarHalalas": 123,
      "balanceAppliedSarHalalas": 123,
      "receiptUrl": "<string>"
    }
  }
]

Orders

Create Carbon Credits Order

POST

orders

curl --request POST \
  --url https://carbon-engine.onrender.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "portfolioId": "<string>",
  "amount_kg": 123,
  "description": "<string>",
  "customer": "<string>"
}'

[
  {
    "_id": "<string>",
    "orderNumber": "<string>",
    "customer": "<string>",
    "description": "<string>",
    "price_sar_halalas": 123,
    "amount_kg": 123,
    "creditsPurchased": 123,
    "callbackUrl": "<string>",
    "state": "<string>",
    "portfolio": "<string>",
    "certificateUrl": "<string>",
    "projectRecords": [
      {
        "project_id": "<string>",
        "project_category_id": "<string>",
        "credit_batch_id": "<string>",
        "delta": 123,
        "recorded_on": "2023-11-07T05:31:56Z"
      }
    ],
    "invoice": {
      "amountDueSarHalalas": 123,
      "balanceAppliedSarHalalas": 123,
      "receiptUrl": "<string>"
    }
  }
]

Authorizations

Authorization

string

header

required

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

Body

application/json

Response

201

application/json

Order placed successfully

The response is of type object[].

Get Quote for Ground Transport Emissions Cancel Order

curl --request POST \
  --url https://carbon-engine.onrender.com/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "portfolioId": "<string>",
  "amount_kg": 123,
  "description": "<string>",
  "customer": "<string>"
}'

[
  {
    "_id": "<string>",
    "orderNumber": "<string>",
    "customer": "<string>",
    "description": "<string>",
    "price_sar_halalas": 123,
    "amount_kg": 123,
    "creditsPurchased": 123,
    "callbackUrl": "<string>",
    "state": "<string>",
    "portfolio": "<string>",
    "certificateUrl": "<string>",
    "projectRecords": [
      {
        "project_id": "<string>",
        "project_category_id": "<string>",
        "credit_batch_id": "<string>",
        "delta": 123,
        "recorded_on": "2023-11-07T05:31:56Z"
      }
    ],
    "invoice": {
      "amountDueSarHalalas": 123,
      "balanceAppliedSarHalalas": 123,
      "receiptUrl": "<string>"
    }
  }
]

Create Carbon Credits Order

Authorizations

Body

Response

API Docs

Quotes

Orders

Projects

Portfolios

Create Carbon Credits Order

Authorizations

Body

Response