Orders in SDK

Overview

Create tasking and catalog orders.

Constants

Constant	Description	Value
`OrderType`	Order types: `TASKING`: Tasking orders. `ARCHIVE`: Catalog orders.	`Literal["TASKING", "ARCHIVE"]`
`OrderDetails`	Order details of both order types.	`Union[ArchiveOrderDetails, TaskingOrderDetails]`

Class: OrderParamsV2

A class that represents the schema for the order parameters.

Attributes

Attribute	Description
`dataProduct`	str The data product ID.
`displayName`	str A human-readable name that describes the order.
`params`	Dict[str, Any] Order parameters.
`featureCollection`	Dict[str, Any] A GeoJSON FeatureCollection representing the order’s geometry.
`tags`	List[str] A list of tags that categorize the order. A tag can consist of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`).

Class: OrderSorting

A class that contains predefined sorting fields.

Attributes

Attribute	Description
`created_at`	utils.SortingField Sorts by creation date. The default order is ascending.
`updated_at`	utils.SortingField Sorts by update date. The default order is ascending.
`type`	utils.SortingField Sorts by order type. The default order is catalog orders first, tasking second.
`status`	utils.SortingField Sorts by order status. The default order is ascending.

1
# Sort by creation date, from the most recent to the earliest
2
orders_sorted = up42.Order.all(sort_by=up42.OrderSorting.created_at.desc)
3

4
# Sort by the last update date, from the most recent to the earliest
5
# orders_sorted = up42.Order.all(sort_by=up42.OrderSorting.updated_at.desc)
6

7
# Sort by order type, tasking first, catalog second
8
# orders_sorted = up42.Order.all(sort_by=up42.OrderSorting.type.desc)
9

10
# Sort by order status, in the order of progression
11
# orders_sorted = up42.Order.all(sort_by=up42.OrderSorting.status.asc)
12

13
# Define output for one of the sorting examples
14
for order in list(orders_sorted)[:5]: # Print first 5 results
15
    print(f"- Order ID:   {order.id}")
16
    print(f"  Status:     {order.status}")
17
    print(f"  Type:       {order.type}")
18
    print(f"  Created at: {order.info['createdAt']}\n")

Class: ArchiveOrderDetails

A data class that represents catalog order details.

Attributes

Attribute	Description
`aoi`	dict Geometry in the GeoJSON format.
`image_id`	Optional[str] The ID of the image scene.

1
# Select a catalog order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order info
5
order = up42.Order.get(order_id=order_id)
6
details = order.details
7
tags = order.tags
8

9
# Define output from the Order class
10
print(f"Order details for ID: {order.id}")
11
print(f"Display name:       {order.display_name}")
12
print(f"Status:             {order.status}")
13
print(f"Type:               {order.type}")
14
print(f"Data product ID:    {order.data_product_id}")
15
print(f"Tags:               {', '.join(tags) if tags else 'No tags'}")
16

17
# Define output from the ArchiveOrderDetails class
18
print("\nCatalog-specific details:")
19
print(f"  Image ID:         {details.image_id}")
20
print(f"  Geometry:         {details.aoi}")

Class: TaskingOrderDetails

A data class that represents tasking order details.

Attributes

Attribute	Description
`acquisition_start`	str The date and time when the sensor started the acquisition process.
`acquisition_end`	str The date and time when the sensor finished the acquisition process.
`geometry`	dict Geometry in the GeoJSON format.
`extra_description`	Optional[str] An additional order description.
`sub_status`	Optional[OrderSubStatus] An additional status for the tasking order.

1
# Select a tasking order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order info
5
order = up42.Order.get(order_id=order_id)
6
details = order.details
7
tags = order.tags
8

9
# Define output from the Order class
6 collapsed lines
10
print(f"Order details for ID: {order.id}")
11
print(f"Display name:       {order.display_name}")
12
print(f"Status:             {order.status}")
13
print(f"Type:               {order.type}")
14
print(f"Data product ID:    {order.data_product_id}")
15
print(f"Tags:               {', '.join(tags) if tags else 'No tags'}")
16

17
# Define output from the TaskingOrderDetails class
18
print("\nTasking-specific details:")
19
print(f"  Substatus:            {details.sub_status}")
20
print(f"  Acquisition start:    {details.acquisition_start}")
21
print(f"  Acquisition end:      {details.acquisition_end}")
22
print(f"  Extra description:    {details.extra_description}")
23
print(f"  Geometry:             {details.geometry}")

Class: Order

A data class that represents an order in the system.

Attributes

Attribute	Description
`id`	str The order ID.
`display_name`	str A human-readable name that describes the order.
`status`	OrderStatus The order status.
`workspace_id`	str The workspace ID.
`account_id`	str The account ID.
`type`	OrderType The order type.
`details`	Optional[OrderDetails] Order details.
`data_product_id`	Optional[str] The data product ID.
`tags`	Optional[list[str]] A list of tags that categorize the order. A tag can consist of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`).

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order info
5
order = up42.Order.get(order_id=order_id)
6
tags = order.tags
7

8
# Define output
9
print(f"Order details for ID: {order.id}")
10
print(f"Display name:       {order.display_name}")
11
print(f"Status:             {order.status}")
12
print(f"Type:               {order.type}")
13
print(f"Data product ID:    {order.data_product_id}")
14
print(f"Tags:               {', '.join(tags) if tags else 'No tags'}")

Properties

order_details

This property is deprecated and will be removed in 3.0.0. Use Order.details.

Retrieves the details of a specific order. Returns dict.

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order info
5
order = up42.Order.get(order_id=order_id)
6
order.order_details

order_id

This property is deprecated and will be removed in 3.0.0. Use Order.id.

Retrieves the order ID. Returns str.

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order info
5
order = up42.Order.get(order_id=order_id)
6
order.order_id

is_fulfilled

Checks if the order is fulfilled. Returns bool:

True: The order has the FULFILLED status.
False: The order has any other status.

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order info
5
order = up42.Order.get(order_id=order_id)
6
order.is_fulfilled

Methods

get

Retrieves a specific order by its ID. Returns Order.

Parameter	Description
`order_id`	str The order ID.

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order info
5
order = up42.Order.get(order_id=order_id)

all

Retrieves all orders, with optional filtering. Returns Iterator["Order"]. Use itertools.islice to offset and limit the results.

Parameter	Description
`workspace_id`	Optional[str] The workspace ID. Use to get jobs from a specific workspace. Otherwise, jobs from the entire account will be returned.
`order_type`	Optional[OrderType] The type of orders to return. To get orders of all types, omit the parameter.
`status`	Optional[List[OrderStatus]] Order statuses. Use to search for orders with any of the provided statuses.
`sub_status`	Optional[List[OrderSubStatus]] Order sub-statuses. Use to search for orders with any of the provided sub-statuses.
`display_name`	Optional[str] Additional search terms. Use to search for orders that contain the provided search query in their name.
`tags`	Optional[List[str]] A list of tags that categorize the order.
`sort_by`	Optional[utils.SortingField] The results sorting method that arranges elements in ascending or descending order based on a chosen field. To view the list of possible values, see `OrderSorting`.

1
# Search for orders
2
orders = up42.Order.all(
3
    order_type="TASKING",
4
    status=["FULFILLED", "PLACED"],
5
    sort_by=up42.OrderSorting.status.asc,
6
)
7

8
# Define output
9
for order in orders:
10
    print(f"- Order ID:       {order.id}")
11
    print(f"  Display name:   {order.display_name}")
12
    print(f"  Status:         {order.status}")
13
    print(f"  Type:           {order.type}")
14
    tag_string = ", ".join(order.tags) if order.tags else "No tags"
15
    print(f"  Tags:           {tag_string}\n")

get_assets

This method is deprecated and will be removed in 3.0.0.

Retrieves assets from orders that have FULFILLED or BEING_FULFILLED statuses. Returns List[asset.Asset].

Use this function to retrieve multiple assets from the same order. To search across all assets in your storage, use the get_assets function from the Storage class.

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Fetch order assets
5
order = up42.Order.get(order_id=order_id)
6
order.get_assets()

track

Tracks the order status by retrying until the status changes to FULFILLED or FAILED_PERMANENTLY. It will query the order every 120 seconds.

Parameter	Description
`report_time`	float An interval between queries, in seconds. The default value is `120`.

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Track status
5
order = up42.Order.get(order_id=order_id)
6
order.track(report_time=150)

track_status

This method is deprecated and will be removed in 3.0.0. Use Order.track.

Tracks the order status by retrying until the status changes to FULFILLED or FAILED_PERMANENTLY. It will query the order every 120 seconds. Returns str.

Parameter	Description
`report_time`	float An interval between queries, in seconds. The default value is `120`.

1
# Select an order
2
order_id = "3bf00b63-7188-4b04-aa27-d78e4cd32c01"
3

4
# Track status
5
order = up42.initialize_order(order_id=order_id)
6
order.track_status(report_time=150)

Orders in SDK

Order tasking and catalog imagery using the SDK.

Overview

Constants

Class: OrderParamsV2

Attributes

Class: OrderSorting

Attributes

Class: ArchiveOrderDetails

Attributes

Class: TaskingOrderDetails

Attributes

Class: Order

Attributes

Properties

order_details

order_id

is_fulfilled

Methods

get

all

get_assets

track

track_status

Learn more

API docs | Tasking

Console docs | Tasking

API docs | Catalog

Console docs | Catalog