Sign in

v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB
Order

Get an order

Get an order by it's ID with it's associated orderitems.

get/v0/orders/{id}

Path parameters

idstring required

Order ID

Response

OK

created_atstring
created_bystring

uuid of the user who created the order

idstring
org_idstring
paid_atstring
status'PAID' | 'REFUND' | 'UNPAID' | 'PAYMENT_IN_PROGRESS'
total_amountnumber
transaction_idstring
updated_atstring
updated_bystring

uuid of the user who last updated the order

user_idstring

Example response

{
  "created_at": "2020-01-01T00:00:00+00:00",
  "created_by": "47435e2b-d8c4-41ff-9de9-2be3bfc92270",
  "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "order_items": [
    {
      "area": 1000,
      "bandset": {
        "bands": [
          {
            "name": "B001",
            "wavelength": 473
          }
        ],
        "bandset_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276"
      },
      "base_amount": 10000,
      "cloud_delivery": {
        "config": "9af9ca14-8c0f-4b7b-ab5e-3a29fc7325b6",
        "path": "path/subdirectory1/"
      },
      "created_at": "2024-05-27T06:50:20.056549Z",
      "created_by": "b64d2c37-89c3-404d-8395-dedb0fe9131c",
      "end_date": "2020-10-28T00:00:00Z",
      "final_amount": 12000,
      "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "last_feasibility_check": "2024-05-27T06:50:20.056549Z",
      "name": "order item 1",
      "number_of_bands": 2,
      "occurrences": [
        {
          "end": "2020-01-01T00:00:00+00:00",
          "start": "2020-01-01T00:00:00+00:00"
        }
      ],
      "order_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "org_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "project_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "start_date": "2020-10-22T00:00:00Z",
      "tokens_used": 100,
      "transaction_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "updated_at": "2024-05-27T06:50:20.056549Z",
      "updated_by": "274a30f5-9ff2-4cc7-8680-7b2e076b9faf",
      "usecase": "agriculture",
      "user_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276"
    }
  ],
  "org_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
  "total_amount": 1000,
  "transaction_id": "3671066b-c4fd-4201-8e02-470cb6bc088e",
  "updated_at": "2020-01-01T00:00:00+00:00",
  "updated_by": "47435e2b-d8c4-41ff-9de9-2be3bfc92270",
  "user_id": "90afd20d-8447-4636-a60d-73102008856c"
}