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": "ctb_1DRBTYA8Q1S07CBY",
      "credit_quantity_kg": 1000
    }
  ],
  "notes": "Delivered with care.",
  "order_id": "ord_1FAN3S3WV1S0B842"
}'
{
  "credit_batch_size_total": {
    "credit_kgs": 125632,
    "credits": 125.632
  },
  "delivered_at": "2023-11-07T05:31:56Z",
  "from_supplier": {
    "id": "spl_1CC712KFS1S0YKPS",
    "location": {
      "country_code": "<string>",
      "country_name": "<string>"
    },
    "organisation": {
      "domain": "isometric.com",
      "id": "org_1GB56M1ST1S0GVNA",
      "name": "Isometric"
    }
  },
  "id": "dlv_1C454ZXA61S03Z9T",
  "notes": "Delivered with care.",
  "order_id": "ord_1FAN3S3WV1S0B842",
  "to_organisation": {
    "domain": "isometric.com",
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric"
  },
  "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

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

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.

Maximum 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 - 36
Example:

"ord_1FAN3S3WV1S0B842"

Response

200
application/json
Successful Response
​
credit_batch_size_total
object
required
​
delivered_at
string
required
​
from_supplier
object
required
​
id
string
required
Required string length: 20 - 36
Example:

"dlv_1C454ZXA61S03Z9T"

​
notes
string | null
required

A publicly visible note stored with the credit delivery.

Maximum length: 256
Example:

"Delivered with care."

​
order_id
string
required
Required string length: 20 - 36
Example:

"ord_1FAN3S3WV1S0B842"

​
to_organisation
object
required
​
url
string
required

Was this page helpful?