The Planet Tasking API is a REST based API, which can be integrated into any service, regardless of the language used. Below are some examples of how to integrate the most commonly used aspects of the Tasking API Archive orders creation.
The creation is different from orders.
Archive Order Specifics¶
Archive orders are used to request SkySat collects that are already in the archive. As soon as an Archive order is created, it is going to be immediately fulfilled with the capture containing the requested SkySat collects. From that moment on, the SkySatCollects and related SkySatScenes can be downloaded via the usual flow, similar to regular Tasking orders. Archive orders' captures cannot be the target of Capture Review. Archive orders also cannot be edited or cancelled.
Prerequisites to Archive Order Creation¶
Before creating an Archive order, it is required to have in place a list of desired SkySat collects, which are intersecting with requested geometry. To get the list of SkySat collects, use the following request to DataApi:
curl --request POST --url 'https://api.planet.com/data/v1/quick-search' \
--header 'accept: application/json' \
--header 'authorization: api-key <YOUR_API_KEY>' \
--header 'content-type: application/json' \
--data '{
"filter": {
"type": "AndFilter",
"config": [
{
"type": "GeometryFilter",
"field_name": "geometry",
"config": {
"type": "Point",
"coordinates": [
47.817578706298946,
22.0761858843631
]
}
},
{
"type": "DateRangeFilter",
"field_name": "acquired",
"config": {
"gte": "2023-10-30T14:17:21.376Z",
"lte": "2024-10-30T14:17:21.377Z"
}
}
]
},
"item_types": [
"SkySatCollect"
]
}'
Archive order creation¶
The creation of a Archive order is done via a POST request to the Tasking API /orders endpoint. The creation of an Archive order can be as simple as the following request example:
curl --request POST --url 'https://api.planet.com/tasking/v2/orders/' \
--header 'accept: application/json' \
--header 'authorization: api-key <YOUR_API_KEY>' \
--header 'content-type: application/json' \
--data '{
'name': 'Archive Order 01',
'geometry': {
"type": "Point",
"coordinates": [
47.817578706298946,
22.0761858843631
]
},
'requested_item_ids': ['item_id_1', 'item_id_2'],
'product': 'Archive Tasking',
'pl_number: 'PL-YOUR-CONTRACT-NUMBER'
}
The field to take note of is the requested_item_ids field. This field should contain the list of SkySat collects that you want to be included in the Archive order.
They need to be available in Archive and intersect with the geometry of the order.
We are continually working to improve our technical documentation and support. Please help by sharing your experience with us.