Sentinel Hub · Schema

Order

Satellite ImageryGeospatialRemote SensingEarth ObservationNDVISentinelLandsatMODISOGCSTAC

Properties

Name	Type	Description
id	string	Order ID
name	string	Order name. It's also used as a name for a new BYOC collection, if no collection is given in collectionId field.
accountId	string	Account ID
collectionId	string	BYOC collection ID. If given at order creation, requested data is imported into referenced collection, which must be compatible with the data being ordered - that is, must either be empty or contain t
status	object
sqkm	number	Total size of the order in km² or minimum order area, whichever is greater
input	object	Specification of the ordered data

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.sentinel-hub.com/schemas/Order",
  "title": "Order",
  "type": "object",
  "properties": {
    "id": {
      "description": "Order ID",
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "name": {
      "description": "Order name. It's also used as a name for a new BYOC collection, if no collection is given in collectionId field.",
      "type": "string"
    },
    "accountId": {
      "description": "Account ID",
      "type": "string",
      "format": "uuid",
      "readOnly": true
    },
    "collectionId": {
      "description": "BYOC collection ID. If given at order creation, requested data is imported into referenced collection, which must be compatible with the data being ordered - that is, must either be empty or contain the same bands as the data being ordered.\n\nIf not given at order creation, a new BYOC collection is created when the order is confirmed and its ID is returned in the response from the `confirm` endpoint.\n",
      "type": "string",
      "format": "uuid"
    },
    "status": {
      "$ref": "#/components/schemas/OrderStatus"
    },
    "sqkm": {
      "description": "Total size of the order in km<sup>2</sup> or minimum order area, whichever is greater",
      "type": "number",
      "readOnly": true
    },
    "input": {
      "type": "object",
      "description": "Specification of the ordered data"
    }
  }
}