Order Creation API

Shubhavi
Shubhavi
  • Updated

Aurora provides multiple APIs to order an image. The steps for ordering an image are:

  1. Exploring archives or tasking a capture

  2. Creating an order and getting the price

  3. Placing an order successfully

 

Order Creation API

 

This API is used for creating an order on Aurora. It can be used either to order an archive image or to task the satellite with a new image.

  • Users can also configure the delivery location and notification webhook (if the user wants to get notified about the order status in their system) as optional parameters.

  • Users can also enable or disable email status notifications.
    In the API request payload, users can choose either archive or schedule to create an order. For archive, only

    archive_image_id needs to be passed, and for schedule, all the fields in “schedule” need to be passed.

    The output provides the quotation for the image requested or scheduled, along with an order_id. Users need to pass this order_id into the place order API to place the order.

  • Sample Request

    curl --location 'https://p-platform-gateway.pixxel.dev/orderdesk/order' \

    --header 'Authorization: Bearer xxx' \ --header 'Content-Type: application/json' \ --data '{

    "AOI": { "geometry": {

    "type": "Polygon", "coordinates": [

    [
    [

    34.24935725683071 ],

    [
    102.429055626998,

    34.231334710970195 ],

    [
    102.39815657914643, 34.231334710970195

    ], [

    34.24935725683071 ],

    [
    102.429055626998, 34.24935725683071

    ] ]

    ] },

    "product_type": "VNIR 5nm", "level_of_product": "L2a", "constellation": "Firefly", "off_nadir_angle": 50, "cloud_cover": 40, "spectral_bands": [

    "B01", "B02", "B09"

    ],
    "mosaicking": true, "name": "Test Order", "mode_of_delivery": "s3", "s3_delivery": {

102.429055626998,

102.39815657914643,

"access_key": "xxx", "secret_key": "xxx",
"bucket": "xxx",
"folder": "path/", "provider_name": "aws/azure"

},
"Email"True,

"webhook_notification_delivery": {

"url": "https://company.notificarion/webhook" },

"type_of_image": "archive/schedule", "archive_image_id": "xxx", "schedule": {

"start_date": "20210101", "end_date": "20220101", "recurring": true, "repeats": "4",

"end_on": "20220101",

"end_after": 15 }

} }

'

Sample Response

{

"product_type": "VNIR 5nm", "level_of_product": "L2a", "constellation": "Firefly", "off_nadir_angle": 50, "cloud_cover": 40, "order_id": "asd", "total_amount": 1230, "discount" : 140 ,

"tax": 50
"amount to be paid": 1140, "status": "10"

}

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.