v1

latestOpenAPI 3.0.2Apache 2.02026-07-175414.1 KB
Orders

Confirm an order

Confirm the order, execute the purchase and ingest the data into a target collection.

When an order is created through POST /order, the data isn't yet ordered from the commercial data provider. The client MUST explicitly confirm the order whereupon the order is executed, the costs are deducted from the client's account and the data is ingested in the target collection.

The target collection is the collection through which the ordered data is made available. The source and the target collection can be the same or different, it's up to the back-end if the ordered data id ingested into a new target collection or the existing source collection. Additionally, if the back-end creates new target collections, it can provide access to the union of all purchased products through the source collection.

This endpoint only has an effect if order:status is orderable.

If the user doesn't have sufficient funds, the endpoint should return an error and order:status should not change.

Otherwise, the order:status changes from orderable to ordered until a new order status (e.g. succeeded or failed) becomes available.

post/orders/{order_id}

Response

The order has been confirmed successfully.