How Can I Cancel an Order?

Orders may be cancelled while they are in a queued state. After an order moves into a running state, it may no longer be cancelled.

You can cancel a single order with the following request:

PUT https://api.planet.com/compute/ops/orders/v2/{order_id}

Example Request*

PUT https://api.planet.com/compute/ops/orders/v2/f12bc37d-ffce-423e-9a9a-deb34a423b82

Example Response

{
  "_links": {
    "_self": "https://api.planet.com/compute/ops/orders/v2/f12bc37d-ffce-423e-9a9a-deb34a423b82"
  },
  "created_on": "2019-11-15T16:13:53.232Z",
  "error_hints": [],
  "id": "f12bc37d-ffce-423e-9a9a-deb34a423b82",
  "last_message": "Cancel success",
  "last_modified": "2019-11-15T16:16:00.512Z",
  "name": "test-single-cancel",
  "products": [
    {
      "item_ids": [
        "20160603_130605_0c66"
      ],
      "item_type": "PSScene3Band",
      "product_bundle": "visual"
    },
    {
      "item_ids": [
        "20191026_171453_0f17",
        "20191025_171719_0f25"
      ],
      "item_type": "PSScene4Band",
      "product_bundle": "analytic"
    }
  ],
  "state": "cancelled"
}

More information can be found here: https://developers.planet.com/apis/orders/scenes/#cancel-an-order

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.