v1

latestOpenAPI 3.0.02026-08-0455133277.1 KB

Order

Get an orderItem

Get an orderitem by it's ID, it will also return the list of tasks associated with the ID.

get/v0/order-items/{id}

Path parameters

idstring required

OrderItem ID

Response

areainteger

UTM based area of the current order in sq. km.

base_amountnumber

base amount of the order item without any uplifts or discounts

cloud_coverinteger

maximum cloud cover percentage for the tasking order

created_atstring

timestamp of the creation of the order item

created_bystring

uuid of the user who created the order item

delivery_speed'STANDARD' | 'NOT_APPLICABLE'

end_datestring

end date of your tasking order, the utc date will be considered as the end date.

feasibility_status'NOT_APPLICABLE' | 'FAILED' | 'WEAK_SUCCESS' | 'SUCCESS' | 'UNSPECIFIED'

final_amountnumber

final amount of the order item after applying uplifts and discounts

idstring

unique identifier of the order item

image_type'VNIR' | 'SWIR' | 'VSWIR'

last_feasibility_checkstring

(only for tasking) timestamp of the feasibility status. Feasibility status can change wrt time for the same order.

namestring

name of the order item

no_of_occurrencesinteger

number of occurrences of the recurring order.

number_of_bandsinteger

number of bands in the tasking order

off_nadirinteger

maximum off nadir angle for the tasking order

order_idstring

UUID of the order

org_idstring

UUID of the workspace

payment_status'PAID' | 'PARTIAL-REFUND' | 'REFUND' | 'UNPAID' | 'PARTIAL-MONTHLY'

project_idstring

UUID of the project

recurrence'ONCE' | 'MONTHLY' | 'BIMONTHLY' | 'QUARTERLY' | 'NOT_APPLICABLE'

start_datestring

start date of your tasking order, the utc date will be considered as the start date.

tokens_usedinteger

tokens used by the order item, populated only after payment

transaction_idstring

transaction id assorciated with the order item

type'TASKING' | 'ARCHIVE' | 'RECURRING'

updated_atstring

timestamp of the last update of the order item

updated_bystring

uuid of the user who last updated the order item

usecasestring

usecase for which this order was requested

user_idstring

UUID of the user

validation_errorsobject[]

list of validation errors for the order item

Example response

{
  "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",
  "tasks": [
    {
      "created_at": "2024-05-27T06:50:20.056549Z",
      "created_by": "e3ff4960-2d5a-4737-90dd-9cfb31bfa71e",
      "end_date": "25-05-2024",
      "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "number_of_strips": 4,
      "order_item_id": "TD1_006800_20230528_L2A_20230615_03001067",
      "start_date": "15-05-2024",
      "tokens_used": 10,
      "transaction_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "updated_at": "2024-05-27T06:50:20.056549Z",
      "updated_by": "77345b90-0677-4889-b4d8-2ddb93c0467f"
    }
  ],
  "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"
}