Order States¶
Order state represents the state of the order in its lifecycle.
Queued¶
The order is accepted and in the queue to run. Orders start in a “queued” state before they move to a “running” state. Within an organization, orders in the “queued” state are moved into “running” in round-robin order by API key, across all of the organization’s active orders. This ensures no single organizational user can impact order delivery times for other users in their organization. Each organization can keep up to 10,000 orders total in the queue.
The time an order stays in “running” depends on:
- The size of the order (assets per order). While orders with more assets take longer to run, the Orders API is designed to service a bulk ordering use case. As such, orders with more assets have a shorter per-asset running time. Wherever possible, Planet recommends ordering fewer orders with more assets per order, to keep per-item running times low.
- The raster processing tools included in the order. Read more about tools in the Tools & Toolchains page.
- Some asset types coincide with longer running times. For example,
scenesordersitem_typesthat may take longer running times include REOrthoTile and SkySatCollect.
Success¶
The order is complete and was successful. All requested data were delivered.
Partial¶
The order is complete and was partially successful. This state is valid for order_type partialorders.
Generally, orders with a state of partial indicate that some requested items were not delivered because assets were not available, the requester lacked permission to download those assets, or for an indeterminant reason.
Failed¶
The order failed. Orders may fail due to permission issues, lack of availability of certain asset types (especially if the order_type is full), or other validation issues or internal errors. Any available details on order failure are supplied in the error_hints field.
Cancelled¶
The order was cancelled and will not be completed.
We are continually working to improve our technical documentation and support. Please help by sharing your experience with us.