v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Order

Information about a specific order.

get/orders/{id}

Path parameters

idstring required

Example:ord_1FAN3S3WV1S0B842

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

Response

Successful Response

idstring required

effective_contract_datestring date required

fulfilled_atstring date-time nullable required

status'placed' | 'in_progress' | 'completed' required

Example response

{
  "id": "ord_1FAN3S3WV1S0B842",
  "buyer_organisation": {
    "id": "org_1GB56M1ST1S0GVNA",
    "name": "Isometric",
    "domain": "isometric.com"
  },
  "supplier": {
    "id": "spl_1CC712KFS1S0YKPS",
    "organisation": {
      "id": "org_1GB56M1ST1S0GVNA",
      "name": "Isometric",
      "domain": "isometric.com"
    },
    "location": {
      "country_code": "GBR",
      "latitude": 51.5072,
      "longitude": -0.1276
    }
  },
  "credits_ordered": {
    "credits": 125.632,
    "credit_kgs": 125632
  },
  "credits_delivered": {
    "credits": 125.632,
    "credit_kgs": 125632
  }
}