Registry API
Order Deliveries
- Documentation
- Homepage
- Registry
- GETBeneficiaries
- GETCredit Batch
- POSTCreate Delivery
- GETDelivery
- GETDelivery Credit Batches
- GETIssuance
- GETIssuance Credit Batches
- GETOrder
- GETOrder Deliveries
- GETCurrent Organisation
- GETOrganisation
- GETOrganisation Credit Balance
- GETOrganisation Credit Batches
- GETProject
- POSTCreate Retirement
- GETRetirement
- GETRetirement Credit Batches
- GETCurrent Supplier
- GETSupplier
- GETSupplier Deliveries
- GETSupplier Issuances
- GETSupplier Orders
- GETSupplier Projects
- GETTransferees
- POSTCreate Transfer
- GETTransfer
- GETTransfer Credit Batches
Registry API
Registry API
Order Deliveries
GET
/
orders
/
{id}
/
deliveries
Authorization
string
*
Bearer
Authorization
Required
string
An JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
x-client-secret
Client secret · string
*
x-client-secret
Required
string
A secret token identifying the client connecting to the API
Add Example Value
id
string
*
id
Required
string
last
Last · integer
last
integer
before
string
before
string
first
First · integer
first
integer
after
string
after
string
curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/orders/{id}/deliveries \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'
{
"nodes": [
{
"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"
}
}
],
"page_info": {
"end_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true,
"start_cursor": "<string>"
},
"total_count": 123
}
Authorizations
Authorization
string
headerrequiredAn JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
Headers
x-client-secret
string
requiredA secret token identifying the client connecting to the API
Path Parameters
id
string
requiredQuery Parameters
last
integer
default: 10before
string | null
first
integer
default: 10after
string | null
Response
200 - application/json
nodes
object[]
requirednodes.credit_batch_size_total
object
requirednodes.credit_batch_size_total.credit_kgs
integer
requiredA representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
nodes.credit_batch_size_total.credits
number
requiredA representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
nodes.delivered_at
string
requirednodes.from_supplier
object
requirednodes.from_supplier.id
string
requirednodes.from_supplier.organisation
object
requirednodes.from_supplier.organisation.domain
string | null
requirednodes.from_supplier.organisation.id
string
requirednodes.from_supplier.organisation.name
string
requirednodes.from_supplier.pathway
enum<string>
requiredAvailable options:
biomass_carbon_removal_and_storage
, enhanced_weathering
, ocean_alkalinity_enhancement
, direct_air_capture
, carbon_mineralization
, electrolytic_marine_co2_removal
nodes.id
string
requirednodes.notes
string | null
requiredA publicly visible note stored with the credit delivery.
nodes.order_id
string
requirednodes.to_organisation
object
requirednodes.to_organisation.domain
string | null
requirednodes.to_organisation.id
string
requirednodes.to_organisation.name
string
requiredpage_info
object
requiredpage_info.end_cursor
string | null
requiredpage_info.has_next_page
boolean
requiredpage_info.has_previous_page
boolean
requiredpage_info.start_cursor
string | null
requiredtotal_count
integer
requiredWas this page helpful?
curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/orders/{id}/deliveries \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'
{
"nodes": [
{
"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"
}
}
],
"page_info": {
"end_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true,
"start_cursor": "<string>"
},
"total_count": 123
}