GET
/
v0
/
order-items
/
{id}
curl --request GET \
  --url https://api.pixxel.space/v0/order-items/{id} \
  --header 'Authorization: <api-key>'
{
  "area": 1000,
  "bandset": {
    "bands": [
      {
        "name": "B001",
        "wavelength": 473
      }
    ],
    "bandset_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
    "custom": [
      [
        123
      ]
    ]
  },
  "base_amount": 10000,
  "cloud_cover": 0,
  "cloud_delivery": {
    "config": "config",
    "path": "/path/subdirectory1"
  },
  "created_at": "2024-05-27T06:50:20.056549Z",
  "created_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
  "delivery_speed": "STANDARD/EXPEDITED",
  "end_date": "2020-10-28T00:00:00Z",
  "feasibility_status": "FAILED/WEAK_SUCCESS/SUCCESS",
  "final_amount": 12000,
  "id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "image_type": "VNIR",
  "images": [
    {
      "geometry": "<any>",
      "item_id": "<string>"
    }
  ],
  "last_feasibility_check": "2024-05-27T06:50:20.056549Z",
  "name": "order item 1",
  "no_of_occurrences": 0,
  "number_of_bands": 2,
  "occurrences": [
    {
      "end": "2020-01-01T00:00:00+00:00",
      "start": "2020-01-01T00:00:00+00:00"
    }
  ],
  "off_nadir": 0,
  "order_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "org_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "payment_status": "PAID/PARTIAL-REFUND/REFUND/UNPAID/PARTIAL-MONTHLY",
  "project_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "recurrence": "ONCE",
  "start_date": "2020-10-22T00:00:00Z",
  "status": "DRAFT/ACTIVE/COMPLETED/CANCELLED/FAILED/PARTIALLY_COMPLETED",
  "tasks": [
    {
      "created_at": "2024-05-27T06:50:20.056549Z",
      "created_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
      "delivery_status": "SUCCESSFUL",
      "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",
      "status": "COMPLETED",
      "tokens_used": 10,
      "transaction_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
      "type": "ARCHIVE",
      "updated_at": "2024-05-27T06:50:20.056549Z",
      "updated_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01"
    }
  ],
  "tokens_used": 100,
  "transaction_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "type": "TASKING/ARCHIVE/RECURRING",
  "updated_at": "2024-05-27T06:50:20.056549Z",
  "updated_by": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
  "uplifts": [
    {
      "amount": 123,
      "item_id": "<string>",
      "percentage": 123,
      "subtitle": "<string>",
      "title": "<string>"
    }
  ],
  "usecase": "agriculture",
  "user_id": "47435e2b-d8c4-41ff-9de9-2be3bfc92276",
  "validation_errors": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

OrderItem ID

Response

200
application/json
OK
​
area
integer

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

Example:

1000

​
bandset
object

bandset configuration for the current order

​
base_amount
number

base amount of the order item without any uplifts or discounts

Example:

10000

​
cloud_cover
integer

maximum cloud cover percentage for the tasking order

Example:

0

​
cloud_delivery
object

cloud delivery configuration for the automated delivery of the current order

​
created_at
string

timestamp of the creation of the order item

Example:

"2024-05-27T06:50:20.056549Z"

​
created_by
string

uuid of the user who created the order item

Example:

"e31ab6f8-d359-4c6a-83c6-bfa32229bb01"

​
delivery_speed
enum<string>

delivery speed of the tasking order

Available options:
STANDARD,
EXPEDITED,
NOT_APPLICABLE
Example:

"STANDARD/EXPEDITED"

​
end_date
string

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

Example:

"2020-10-28T00:00:00Z"

​
feasibility_status
enum<string>

(only for tasking) feasibility status of the order showing the probability of the actual capture

Available options:
NOT_APPLICABLE,
FAILED,
WEAK_SUCCESS,
SUCCESS,
UNSPECIFIED
Example:

"FAILED/WEAK_SUCCESS/SUCCESS"

​
final_amount
number

final amount of the order item after applying uplifts and discounts

Example:

12000

​
id
string

unique identifier of the order item

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92276"

​
image_type
enum<string>

image type for the tasking order

Available options:
VNIR,
SWIR,
VSWIR
Example:

"VNIR"

​
images
object[]

list of images associated with the order item

​
last_feasibility_check
string

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

Example:

"2024-05-27T06:50:20.056549Z"

​
name
string

name of the order item

Example:

"order item 1"

​
no_of_occurrences
integer

number of occurrences of the recurring order.

Example:

0

​
number_of_bands
integer

number of bands in the tasking order

Example:

2

​
occurrences
object[]

list of intervals of recurring orders.

​
off_nadir
integer

maximum off nadir angle for the tasking order

Example:

0

​
order_id
string

UUID of the order

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92276"

​
org_id
string

UUID of the organization

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92276"

​
payment_status
enum<string>

payment status of the order item

Available options:
PAID,
PARTIAL-REFUND,
REFUND,
UNPAID,
PARTIAL-MONTHLY
Example:

"PAID/PARTIAL-REFUND/REFUND/UNPAID/PARTIAL-MONTHLY"

​
project_id
string

UUID of the project

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92276"

​
recurrence
enum<string>

recurrence of the order item, (only for tasking and recurring orders)

Available options:
ONCE,
WEEKLY,
BIWEEKLY,
MONTHLY,
BIMONTHLY,
QUARTERLY,
NOT_APPLICABLE
Example:

"ONCE"

​
start_date
string

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

Example:

"2020-10-22T00:00:00Z"

​
status
enum<string>

status of the order item

Available options:
DRAFT,
ACTIVE,
COMPLETED,
CANCELLED,
FAILED,
PARTIALLY_COMPLETED
Example:

"DRAFT/ACTIVE/COMPLETED/CANCELLED/FAILED/PARTIALLY_COMPLETED"

​
tasks
object[]

list of tasks associated with the order item

​
tokens_used
integer

tokens used by the order item, populated only after payment

Example:

100

​
transaction_id
string

transaction id assorciated with the order item

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92276"

​
type
enum<string>

type of the order item

Available options:
TASKING,
ARCHIVE,
RECURRING
Example:

"TASKING/ARCHIVE/RECURRING"

​
updated_at
string

timestamp of the last update of the order item

Example:

"2024-05-27T06:50:20.056549Z"

​
updated_by
string

uuid of the user who last updated the order item

Example:

"e31ab6f8-d359-4c6a-83c6-bfa32229bb01"

​
uplifts
object[]

list of uplifts/discounts applied to the order

​
usecase
string

usecase for which this order was requested

Example:

"agriculture"

​
user_id
string

UUID of the user

Example:

"47435e2b-d8c4-41ff-9de9-2be3bfc92276"

​
validation_errors
object[]

list of validation errors for the order item

Previous
List all orders
Next