Documentation

Create Delivery

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": "<string>",
      "credit_quantity_kg": 123
    }
  ],
  "notes": "Delivered with care.",
  "order_id": "<string>"
}
'

{
  "credit_batch_size_total": {
    "credit_kgs": 123,
    "credits": 123
  },
  "delivered_at": "2023-11-07T05:31:56Z",
  "from_supplier": {
    "id": "<string>",
    "location": {
      "country_code": "<string>",
      "country_name": "<string>",
      "latitude": 0,
      "longitude": 0,
      "description": "<string>"
    },
    "long_description": "<string>",
    "organisation": {
      "domain": "isometric.com",
      "id": "<string>",
      "name": "<string>"
    },
    "short_description": "<string>"
  },
  "id": "<string>",
  "notes": "Delivered with care.",
  "order_id": "<string>",
  "to_organisation": {
    "domain": "isometric.com",
    "id": "<string>",
    "name": "<string>"
  },
  "url": "<string>"
}

POST

deliveries

Create Delivery

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": "<string>",
      "credit_quantity_kg": 123
    }
  ],
  "notes": "Delivered with care.",
  "order_id": "<string>"
}
'

{
  "credit_batch_size_total": {
    "credit_kgs": 123,
    "credits": 123
  },
  "delivered_at": "2023-11-07T05:31:56Z",
  "from_supplier": {
    "id": "<string>",
    "location": {
      "country_code": "<string>",
      "country_name": "<string>",
      "latitude": 0,
      "longitude": 0,
      "description": "<string>"
    },
    "long_description": "<string>",
    "organisation": {
      "domain": "isometric.com",
      "id": "<string>",
      "name": "<string>"
    },
    "short_description": "<string>"
  },
  "id": "<string>",
  "notes": "Delivered with care.",
  "order_id": "<string>",
  "to_organisation": {
    "domain": "isometric.com",
    "id": "<string>",
    "name": "<string>"
  },
  "url": "<string>"
}

Authorizations

Authorization

string

header

required

A 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 A secret token identifying the client connecting to the API

Body

application/json

credit_batch_quantities

CreditBatchQuantity · object[]

required

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

Minimum array length: 1

Show child attributes

credit_batch_quantities.credit_batch_id

string

required

Required string length: 20 - 37

credit_batch_quantities.credit_quantity_kg

integer

required

A representation of a credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.

notes

string | null

required

A publicly visible note stored with the credit delivery.

Maximum string length: 256

Example:

"Delivered with care."

order_id

string

required

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

Required string length: 20 - 37

Response

Successful Response

credit_batch_size_total

CreditQuantity · object

required

Show child attributes

credit_batch_size_total.credit_kgs

integer

required

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e. This field can handle bigint values.

credit_batch_size_total.credits

number

required

A 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.

delivered_at

string<date-time>

required

from_supplier

Supplier · object

required

Show child attributes

from_supplier.id

string

required

Required string length: 20 - 37

from_supplier.location

Location · object

required

Show child attributes

from_supplier.location.country_code

string

required

from_supplier.location.country_name

string

required

from_supplier.location.latitude

number

required

Required range: -90 <= x <= 90

from_supplier.location.longitude

number

required

Required range: -180 <= x <= 180

from_supplier.location.description

string | null

from_supplier.long_description

string | null

required

from_supplier.organisation

Organisation · object

required

Show child attributes

from_supplier.organisation.domain

string | null

required

Example:

"isometric.com"

from_supplier.organisation.id

string

required

Required string length: 20 - 37

from_supplier.organisation.name

string

required

from_supplier.short_description

string | null

required

string

required

Required string length: 20 - 37

notes

string | null

required

A publicly visible note stored with the credit delivery.

Maximum string length: 256

Example:

"Delivered with care."

order_id

string

required

Required string length: 20 - 37

to_organisation

Organisation · object

required

Show child attributes

to_organisation.domain

string | null

required

Example:

"isometric.com"

to_organisation.id

string

required

Required string length: 20 - 37

to_organisation.name

string

required

url

string

required

Deliveries by Order Get Stripe Configuration

⌘I

Overview

Certify

Registry

Create Delivery

Authorizations

Headers

Body

Response