Order templates in SDK

Use templates to create tasking and catalog orders.


Overview

Order new or archive geospatial data.

View repository

Constants
ConstantDescriptionValue
UnitTypeThe type of unit.Literal["SQ_KM", "SCENE"]

Class: OrderError

A data class that represents errors encountered during order cost estimation or creation.

Attributes
AttributeDescription
indexint
The failed geometry index number.
messagestr
The error message associated with the failed geometry.
detailsstr
Error message details.

Class: OrderReference

A data class that represents references to orders in the system.

Attributes
AttributeDescription
indexint
A sequence identifier for the order reference.
idstr
The order ID.

Properties

order

Retrieves the full details of the order associated with the reference.

Class: OrderCost

A data class that represents the cost details of an order.

Attributes
AttributeDescription
indexint
The geometry index number. Indexing starts from zero.
creditsfloat
The estimated cost of the geometry, in credits.
sizefloat
The size of the geometry.
unitUnitType
The unit of measurement used to calculate the size.

Class: Estimate

A data class that represents the estimated cost of a tasking or catalog order batch.

Attributes
AttributeDescription
itemslist[Union[OrderCost, OrderError]]
A list of geometries in the estimation. It might include successful cost details (OrderCost) or errors encountered during the estimation (OrderError).
creditsfloat
The estimate of the order batch cost, in credits.
sizefloat
The size of the order batch in square kilometers or the number of scenes needed to cover the requested geometry.
unitUnitType
The unit of measurement used to calculate the size.

Class: BatchOrderTemplate

A data class that defines a template for creating and estimating batch orders.

Attributes
AttributeDescription
data_product_idstr
The data product ID.
display_namestr
A human-readable name that describes the order.
tagslist[str]
A list of tags that categorize the order. A tag can consist of letters, numbers, spaces, and special characters (., -, _, /, :). If the list is empty, tags will be removed.
featuresgeojson.FeatureCollection
A GeoJSON feature collection.
paramsdict
Order parameters.

Methods

place

Submits a batch order. Returns list[Union[OrderReference, OrderError]].