Skip to main content
Create order with emissions

Authorizations

X-API-Key
string
header
required

Body

application/json

OrderParams

Order Params

customer_id
string
required

Your customer ID. This is used to identify the customer in your system.

order_date
string<date>
required

The date of the Order (YYYY-MM-DD)

order_id
string
required

Your order ID. This is used to identify the order in your system.

tenure_start_date
string<date>
required

The start date of the order (YYYY-MM-DD)

items
OrderItemSchema · object[]

Response

OrderResponse

created_at
string<date-time>

Order creation date

customer_id
string

Customer ID

emission_unit
string

Unit of GHG emission

Example:

"kgCO2e"

items
ItemSchema · object[]

List of items in the order

order_date
string<date>

Order date

order_id
string

Order ID

status
string

Order status

Example:

"created"

tenure_start_date
string<date>

Order's tenure start date

total_emission
number

Total GHG emission of the order