Skip to content

Order

The Order class enables access to catalog and tasking orders tracking.

order = up42.initialize_order(order_id="ea36dee9-fed6-457e-8400-2c20ebd30f44")

Orders

info

The info attribute returns metadata of a specific order.

The returned data type is dict.

Example
order.info

order_details

The order_details attribute returns details of a specific tasking order. It doesn't work with catalog orders.

The returned data type is dict.

Example
order.order_details

status

The status attribute returns the order status.

The returned data type is str.

Example
order.status

is_fulfilled

The is_fulfilled attribute returns the following:

  • True, if the order has the FULFILLED status.
  • False, if the job has any other status.

The returned data type is bool.

Example
order.is_fulfilled

track_status()

The track_status() function allows you to track the order status until the order is fulfilled or failed.

The returned data type is str.

Arguments
Argument Overview
report_time int
The time interval for querying whether the order status has changed to FULFILLED or FAILED_PERMANENTLY, in seconds. The default value is 120.
Example
order.track_status(report_time=150)

Assets

get_assets()

The get_assets() function returns a list of order assets.

The returned data type is list[Asset].

Example
order.get_assets()