Create an order

POST

orders

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"
    }
  ]
}'

{
  "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/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",
      "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

Authorization

string

header

required

Body

application/json

Request Body

order_items

object[]

required

order_items.project_id

string

required

Example:

"1234567890"

order_items.usecase

string

required

Example:

"agriculture"

order_items.bandset

object

order_items.cloud_cover

integer

(tasking) default: 20

Example:

20

order_items.cloud_delivery

object

order_items.delivery_speed

enum<string>

(tasking) default: STANDARD

Available options:

STANDARD,

EXPEDITED,

NOT_APPLICABLE

Example:

"STANDARD"

order_items.end_date

string

(required for tasking) end date of your tasking order, the utc date will be considered as the end date.

Example:

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

order_items.geometry

object

(required for tasking) Example

{
 "type": "FeatureCollection",
 "features": [
   {
     "type": "Feature",
     "properties": {},
     "geometry": {
       "coordinates": [
         [
           [
             -102.41263671019601,
             34.221627630943814
           ],
           [
             -102.41263671019601,
             34.189892538147575
           ],
           [
             -102.28599400714128,
             34.189892538147575
           ],
           [
             -102.28599400714128,
             34.221627630943814
           ],
           [
             -102.41263671019601,
             34.221627630943814
           ]
         ]
       ],
       "type": "Polygon"
     }
   }
 ]
}

order_items.item_ids

string[]

(required for archive orders)

order_items.name

string

Maximum length: 100

Example:

"Order Item 1"

order_items.no_of_occurrences

integer

(tasking) in case of recurring orders ie , either one of no_of_occurrences or end_date should be specified.

Example:

0

order_items.off_nadir

integer

(tasking) default: 20

Example:

20

order_items.recurrence

enum<string>

(required for tasking)

Available options:

ONCE,

WEEKLY,

BIWEEKLY,

MONTHLY,

BIMONTHLY,

QUARTERLY,

NOT_APPLICABLE

Example:

"ONCE"

order_items.start_date

string

(required for tasking) start date of your tasking order, the utc date will be considered as the start date.

Example:

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

dry_run

boolean

default is false

Example:

false

Response

201

application/json

Created

created_at

string

Example:

"2020-01-01T00:00:00+00:00"

created_by

string

uuid of the user who created the order

Example:

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

string

Example:

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

order_items

object[]

order_items.area

integer

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

Example:

1000

order_items.bandset

object

bandset configuration for the current order

order_items.base_amount

number

base amount of the order item without any uplifts or discounts

Example:

10000

order_items.cloud_cover

integer

maximum cloud cover percentage for the tasking order

Example:

0

order_items.cloud_delivery

object

cloud delivery configuration for the automated delivery of the current order

order_items.created_at

string

timestamp of the creation of the order item

Example:

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

order_items.created_by

string

uuid of the user who created the order item

Example:

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

order_items.delivery_speed

enum<string>

delivery speed of the tasking order

Available options:

STANDARD,

EXPEDITED,

NOT_APPLICABLE

Example:

"STANDARD/EXPEDITED"

order_items.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"

order_items.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"

order_items.final_amount

number

final amount of the order item after applying uplifts and discounts

Example:

12000

order_items.id

string

unique identifier of the order item

Example:

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

order_items.image_type

enum<string>

image type for the tasking order

Available options:

VNIR,

SWIR,

VSWIR

Example:

"VNIR"

order_items.images

object[]

list of images associated with the order item

order_items.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"

order_items.name

string

name of the order item

Example:

"order item 1"

order_items.no_of_occurrences

integer

number of occurrences of the recurring order.

Example:

0

order_items.number_of_bands

integer

number of bands in the tasking order

Example:

2

order_items.occurrences

object[]

list of intervals of recurring orders.

order_items.off_nadir

integer

maximum off nadir angle for the tasking order

Example:

0

order_items.order_id

string

UUID of the order

Example:

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

order_items.org_id

string

UUID of the organization

Example:

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

order_items.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"

order_items.project_id

string

UUID of the project

Example:

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

order_items.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"

order_items.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"

order_items.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"

order_items.tokens_used

integer

tokens used by the order item, populated only after payment

Example:

100

order_items.transaction_id

string

transaction id assorciated with the order item

Example:

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

order_items.type

enum<string>

type of the order item

Available options:

TASKING,

ARCHIVE,

RECURRING

Example:

"TASKING/ARCHIVE/RECURRING"

order_items.updated_at

string

timestamp of the last update of the order item

Example:

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

order_items.updated_by

string

uuid of the user who last updated the order item

Example:

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

order_items.uplifts

object[]

list of uplifts/discounts applied to the order

order_items.usecase

string

usecase for which this order was requested

Example:

"agriculture"

order_items.user_id

string

UUID of the user

Example:

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

org_id

string

Example:

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

paid_at

string

Example:

""

status

enum<string>

payment status of the order PAID/UNPAID/PAYMENT_IN_PROGRESS

Available options:

PAID,

REFUND,

UNPAID,

PAYMENT_IN_PROGRESS

Example:

"PAID"

total_amount

number

Example:

1000

transaction_id

string

Example:

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

updated_at

string

Example:

"2020-01-01T00:00:00+00:00"

updated_by

string

uuid of the user who last updated the order

Example:

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

user_id

string

Example:

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

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

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"
    }
  ]
}'

{
  "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/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",
      "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"
}

external

Archives

Bandset

Catalog

Order

Project

Report

Stores

Create an order

Authorizations

Body

Response