v1

latestOpenAPI 3.0.2Apache 2.02026-07-175414.1 KB

Orders

Create a new order

Create an order for selected items (products).

When an order is created through through this endpoint, the data isn't yet ordered from the commercial data provider. The client MUST explicitly confirm the order through POST /orders/{order_id} whereupon the order is executed.

The order can contain additional parameters that specify how the items should be delivered. For example, it might be possible to set the projection, resampling method, bit depth etc. of the delivered data.

Back-ends SHOULD expose the available ordering parameters in GET /collections/{collection_id} in the order_parameters field, following the process_parameters schema of GET /service_types.

Returns Location and OpenEO-Identifier header with the link to the detailed information about the order.

post/orders

Request body

source_collection_idstring required

Unique identifier of the collection.

itemsOrderId[] required

Array of items IDs to order.

parametersOrderParameters required

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

Example request

{
  "items": [
    "fb6799ab"
  ],
  "parameters": {
    "resamplingKernel": "NN"
  }
}

Response

The order has been created successfully.