POST
/
v1
/
quotes
/
ground-freight
curl --request POST \
  --url https://carbon-engine.onrender.com/v1/quotes/ground-freight \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "freight_mass_kg": 123,
  "distance_km": 123,
  "portfolio_id": "<string>"
}'
{
  "amount_kg": 123,
  "price_sar_halalas": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
freight_mass_kg
number
required

Mass of freight, in kg

​
distance_km
number
required

Distance of ground freight shipment, in km

​
portfolio_id
string | null

Optional ID of the portfolio to use for the quote. The quote will be for an order fulfilled from this portfolio. If not specified, the account's default portfolio will be used.

Response

200
application/json
Fetched ground freight quote successfully
​
amount_kg
number

Amount of carbon credits the quote is for, in kilograms

​
price_sar_halalas
number

Price charged for the credits, in halalas (integer)