Sign in

v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Create Delivery

Create a delivery against an order.

post/deliveries

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Request body

order_idstring required

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

notesstring nullable required

A publicly visible note stored with the credit delivery.

Example request

{
  "credit_batch_quantities": [
    {
      "credit_batch_id": "ctb_1DRBTYA8Q1S07CBY",
      "credit_quantity_kg": 1000
    }
  ],
  "order_id": "ord_1FAN3S3WV1S0B842",
  "notes": "Delivered with care."
}

Response

Successful Response

idstring required
delivered_atstring date-time required
order_idstring required
urlstring required
notesstring nullable required

A publicly visible note stored with the credit delivery.

Example response

{
  "id": "dlv_1C454ZXA61S03Z9T",
  "order_id": "ord_1FAN3S3WV1S0B842",
  "from_supplier": {
    "id": "spl_1CC712KFS1S0YKPS",
    "organisation": {
      "id": "org_1GB56M1ST1S0GVNA",
      "name": "Isometric",
      "domain": "isometric.com"
    },
    "location": {
      "country_code": "GBR",
      "latitude": 51.5072,
      "longitude": -0.1276
    }
  },
  "to_organisation": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "credit_batch_size_total": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "notes": "Delivered with care."
}