POST
/
deliveries
curl --request POST \
  --url https://api.sandbox.isometric.com/registry/v0/deliveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "credit_batch_quantities": [
    {
      "credit_batch_id": "pfx_1H0G39139CF0DZB2",
      "credit_quantity_kg": 1000
    }
  ],
  "notes": "Delivered with care.",
  "order_id": "pfx_1H0G39139CF0DZB2"
}'
{
  "credit_batch_size_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "delivered_at": "2023-11-07T05:31:56Z",
  "from_supplier": {
    "id": "abc_1H0G39139CF0DZB2",
    "organisation": {
      "domain": "isometric.com",
      "id": "abc_1H0G39139CF0DZB2",
      "name": "Isometric"
    },
    "pathway": "biomass_carbon_removal_and_storage"
  },
  "id": "abc_1H0G39139CF0DZB2",
  "notes": "Delivered with care.",
  "order_id": "pfx_1H0G39139CF0DZB2",
  "to_organisation": {
    "domain": "isometric.com",
    "id": "abc_1H0G39139CF0DZB2",
    "name": "Isometric"
  }
}

Authorizations

Authorization
string
headerrequired

An JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Body

application/json
credit_batch_quantities
object[]
required

A list of credit batch IDs and kilogram amounts of each to deliver.

notes
string | null
required

A publicly visible note stored with the credit delivery.

order_id
string
required

The ID of the order you wish to fulfil with the specified credit batch amounts.

Response

200 - application/json
credit_batch_size_total
object
required
delivered_at
string
required
from_supplier
object
required
id
string
required
notes
string | null
required

A publicly visible note stored with the credit delivery.

order_id
string
required
to_organisation
object
required

Was this page helpful?

Credit BatchDelivery