external
Archives
Bandset
Catalog
Report
Order
Create an order
Create a new order with tasking or/and archive orderitems
POST
/
v0
/
orders
Copy
curl --request POST \
--url https://api.pixxel.space/v0/orders \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"dry_run": false,
"order_items": [
{
"bandset": {
"bandset_id": "<string>"
},
"cloud_cover": 20,
"cloud_delivery": {
"config": "d5f40033-4abd-48a1-a2f1-276df6edfeaf",
"path": "my-bucket/my-folder"
},
"delivery_speed": "STANDARD",
"end_date": "2020-10-28T00:00:00Z",
"geometry": {
"features": [
{
"geometry": {
"coordinates": [
[
[
123
]
]
],
"type": "Polygon"
},
"type": "Feature"
}
],
"type": "FeatureCollection"
},
"item_ids": [
"<string>"
],
"name": "Order Item 1",
"no_of_occurrences": 0,
"off_nadir": 20,
"project_id": "1234567890",
"recurrence": "ONCE",
"start_date": "2020-10-22T00:00:00Z",
"usecase": "agriculture"
}
]
}'
Copy
{
"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",
"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",
"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",
"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"
}
],
"org_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
"paid_at": "",
"status": "PAID",
"total_amount": 1000,
"transaction_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
"updated_at": "2020-01-01T00:00:00+00:00",
"updated_by": "47435e2b-d8c4-41ff-9de9-2be3bfc92270",
"user_id": "e31ab6f8-d359-4c6a-83c6-bfa32449bb01"
}
Authorizations
Body
application/json
Request Body
The body is of type object
.
Response
201
application/json
Created
The response is of type object
.
Copy
curl --request POST \
--url https://api.pixxel.space/v0/orders \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"dry_run": false,
"order_items": [
{
"bandset": {
"bandset_id": "<string>"
},
"cloud_cover": 20,
"cloud_delivery": {
"config": "d5f40033-4abd-48a1-a2f1-276df6edfeaf",
"path": "my-bucket/my-folder"
},
"delivery_speed": "STANDARD",
"end_date": "2020-10-28T00:00:00Z",
"geometry": {
"features": [
{
"geometry": {
"coordinates": [
[
[
123
]
]
],
"type": "Polygon"
},
"type": "Feature"
}
],
"type": "FeatureCollection"
},
"item_ids": [
"<string>"
],
"name": "Order Item 1",
"no_of_occurrences": 0,
"off_nadir": 20,
"project_id": "1234567890",
"recurrence": "ONCE",
"start_date": "2020-10-22T00:00:00Z",
"usecase": "agriculture"
}
]
}'
Copy
{
"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",
"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",
"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",
"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"
}
],
"org_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
"paid_at": "",
"status": "PAID",
"total_amount": 1000,
"transaction_id": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01",
"updated_at": "2020-01-01T00:00:00+00:00",
"updated_by": "47435e2b-d8c4-41ff-9de9-2be3bfc92270",
"user_id": "e31ab6f8-d359-4c6a-83c6-bfa32449bb01"
}
Assistant
Responses are generated using AI and may contain mistakes.