Sign in
Orders

Full metadata for an order

Get full metadata of the order.

Back-ends can optionally link to the spatial and temporal extent information and other metadata about the items using the relation type item, preferrably by implementing and linking to GET /collections/{collection_id}/items/{item_id}.

get/orders/{order_id}

Response

Full order information.

idstring required

Unique identifier of the order at the back-end, which MUST match the specified pattern.

order:idstring

Identifier of the order at the data provider.

order:status'orderable' | 'ordered' | 'pending' | 'shipping' | 'succeeded' | 'failed' | 'canceled' required

The status of the order.

  • orderable: The item or asset is orderable via the provider scenario.
  • ordered: The item or asset is ordered and the provider is preparing to make it available.
  • pending: The item or asset is ordered but wait for an activation before being able for shipping.
  • shipping The item or asset order are being processed by the provider to provide you with the asset(s).
  • succeeded: The provider has delivered your order and asset(s) are available.
  • failed: The provider is not able to deliver the order.
  • canceled The order has been canceled.
order:datestring date-time required

The order time. Formatted as a RFC 3339 date-time.

order:expiration_datestring date-time

The validity time of the order. Formatted as a RFC 3339 date-time.

source_collection_idstring required

Unique identifier of the source collection.

target_collection_idstring required

Unique identifier of the target collection. Can be the same as source_collection_id.

costsMoney required— unresolved $ref
parametersOrderParameters

Key-value pairs of available order_parameters as listed at GET /collections/{collection_id} for filtering available items.

itemsItemId[]

List of ordered item IDs.

linksLink[] — unresolved $ref

Links related to this order, e.g. to metadata for ordered items listed in items.

It is highly RECOMMENDED to provide links with the following rel (relation) types:

  1. item: A link back to a valid STAC Item that has been ordered. Could be a link to GET /collections/{collection_id}/items/{item_id}.

  2. order: A link pointing to a dcoument describing the ordering terms and conditions of the data provider.

For additional relation types see also the lists of common relation types in openEO.

Changes