Skip to main content

Orders API Reference

API docs by Redocly

Planet Orders API (2.0.0)

Download OpenAPI specification:Download

The Orders API permits complex asset orders.

Orders

List Orders

Returns all order requests.

Authorizations:
BasicAuthApiKeyAuth
query Parameters
page_marker
string

Paging marker.

page_size
integer

Number of orders per page.

state
Array of strings
Items Enum: "queued" "running" "failed" "success" "partial" "cancelled"

Filter orders by state on ListOrders. Accepts multiple values treated as a logical OR via multiple query parameters, e.g. ?state=queued&state=running.

source_type
Array of strings

Filter orders by source_type (scenes and/or basemaps) on ListOrders. Accepts multiple values treated as a logical OR via:

  1. comma-separated list, e.g. ?source_type=scenes,basemaps
  2. multiple query parameters, e.g. ?source_type=scenes&source_type=basemaps All source types can be included with ?source_type=all. Defaults to only returning scenes orders for backwards-compatibility.
name
string

Filter orders by name

name__contains
string

Filter orders by name containing a string

created_on
string

Filter orders by created_on interval or instant. The time can be a closed interval (e.g. 2024-01-01T00:00:00.00Z/2024-02-01T00:00:00.00Z for the month of January), an open interval (e.g. 2024-01-01T00:00:00.00Z/.. for all results in January or later and ../2024-01-01T00:00:00.00Z for all results before January), or an instant (e.g. 2024-01-01T00:00:00.00Z). Start times for intervals are inclusive, and end times are exclusive.

last_modified
string

Filter orders by last_modified interval or instant. The time can be a closed interval (e.g. 2024-01-01T00:00:00.00Z/2024-02-01T00:00:00.00Z for the month of January), an open interval (e.g. 2024-01-01T00:00:00.00Z/.. for all results in January or later and ../2024-01-01T00:00:00.00Z for all results before January), or an instant (e.g. 2024-01-01T00:00:00.00Z). Start times for intervals are inclusive, and end times are exclusive.

hosting
boolean

Only return orders that contain a hosting block (e.g. SentinelHub hosting)

sort_by
string

Fields to sort orders by. Multiple fields can be specified separated by commas. The sort direction can be specified by appending ' ASC' or ' DESC' to the field name. The default sort direction is ascending.

When multiple fields are specified, the sort order is applied in the order the fields are listed.

If no sort_by parameter is provided, orders will be sorted by created_on DESC by default.

Supported fields: name, created_on, state, last_modified

Examples:

  • sort_by=name
  • sort_by=name DESC
  • sort_by=name,state DESC,last_modified

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "orders": [
    ]
}

Create Order

Orders products.

Authorizations:
BasicAuthApiKeyAuth
header Parameters
X-Planet-App
string

Identify the client making this request

Request Body schema: application/json
required

Order details.

name
required
string

A name given to this Order request.

subscription_id
integer
Default: 0

apply this orders against this quota subscription

Array of scenesSource (object) or basemapsSource (object)

The products from the Data or Basemaps API to order.

object (Delivery)

How should ordered products be delivered?

object (Notifications)

How would you like to be notified when order is complete?

order_type
string
Default: "full"
Enum: "partial" "full"

accept order if requested products are not available (partial)?

source_type
string
Default: "scenes"
Enum: "scenes" "basemaps"

Source imagery type for all products. Default is scenes.

Array of harmonizeObject (object) or coregisterObject (object) or toarObject (object) or clipObject (object) or reprojectObject (object) or bandmathObject (object) or compositeObject (object) or tileObject (object) or cloud_filterObject (object) or file_formatObject (object) or mergeObject (object) or clipBasemapsObject (object) or file_formatBasemapsObject (object)
object (Metadata)

Metadata settings

object (Hosting)

Specify a data hosting location. A hosting location removes the need to specify a delivery location. Specifying both is not allowed. If hosting is specified, no direct download links will be generated. This location cannot be updated after an order has been created.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "subscription_id": 0,
  • "products": [
    ],
  • "delivery": {
    },
  • "notifications": {
    },
  • "order_type": "partial",
  • "source_type": "scenes",
  • "tools": [
    ],
  • "metadata": {
    },
  • "hosting": {
    }
}

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "subscription_id": 0,
  • "tools": [
    ],
  • "metadata": {
    },
  • "products": [
    ],
  • "created_on": "string",
  • "last_modified": "string",
  • "state": "queued",
  • "last_message": "string",
  • "error_hints": [
    ],
  • "delivery": {
    },
  • "notifications": {
    },
  • "order_type": "partial",
  • "source_type": "scenes",
  • "hosting": {
    }
}

Get Order

Get order request details by Id.

Authorizations:
BasicAuthApiKeyAuth
path Parameters
order_id
required
string <uuid>

The Order ID (a UUID).

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "subscription_id": 0,
  • "tools": [
    ],
  • "metadata": {
    },
  • "products": [
    ],
  • "created_on": "string",
  • "last_modified": "string",
  • "state": "queued",
  • "last_message": "string",
  • "error_hints": [
    ],
  • "delivery": {
    },
  • "notifications": {
    },
  • "order_type": "partial",
  • "source_type": "scenes",
  • "hosting": {
    }
}

Cancel an order

Cancel a queued order by Id.

Authorizations:
BasicAuthApiKeyAuth
path Parameters
order_id
required
string <uuid>

The Order ID (a UUID).

Responses

Response samples

Content type
application/json
{
  • "_links": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "subscription_id": 0,
  • "tools": [
    ],
  • "metadata": {
    },
  • "products": [
    ],
  • "created_on": "string",
  • "last_modified": "string",
  • "state": "queued",
  • "last_message": "string",
  • "error_hints": [
    ],
  • "delivery": {
    },
  • "notifications": {
    },
  • "order_type": "partial",
  • "source_type": "scenes",
  • "hosting": {
    }
}

Cancel Orders in bulk

Cancel Orders in bulk

Authorizations:
BasicAuthApiKeyAuth
Request Body schema: application/json
required

Bulk cancel details; empty body attempts to cancel all Orders in a pre-running state.

order_ids
Array of strings <uuid> (OrderID) [ 1 .. 10000 ] items [ items <uuid > ]

Optional array of Order IDs to attempt to cancel

Responses

Request samples

Content type
application/json
{
  • "order_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Aggregated Order Stats

Provides aggregated counts of Active Orders for the User and the User's Organization.

Authorizations:
BasicAuthApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "organization": {
    }
}

Download Order

Download ordered asset.

query Parameters
token
required
string

Download token.

header Parameters
X-Planet-App
string

Identify the client making this request

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Get OpenAPI spec

Returns this OpenAPI spec

Responses

Response samples

Content type
application/json
{ }

Get json spec for product bundles

Returns the json spec for product bundles

Responses

Response samples

Content type
application/json
{ }
Last updated on