{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference async_process dataimport_order API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "dataimport_order",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Query orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/orders",
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter orders by status. Omit to get all orders."
              },
              {
                "name": "collectionId",
                "value": "",
                "type": "query",
                "description": "Filter orders by collectionId. Omit to get all orders."
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Upper limit to the number of items to retrieve. It cannot be larger than the endpoint-specific limit. If omitted, the endpoint-specific limit is used.\nFor more records, use *viewtoken* to page through."
              },
              {
                "name": "viewtoken",
                "value": "",
                "type": "query",
                "description": "When the total number of items is larger than *count*, the response contains *viewtoken*.\nThis *viewtoken* can be used in the next request to retrieve the next page of items.\n\nThe next page can be retrieved by repeating the query. However, replace your URL with the\nnext URL in the returned links object.\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Optional search query. Either a single word to search for or multiple words separated by the `|` (or) and `&` (and) operators. If omitted, all items are returned."
              },
              {
                "name": "deleted",
                "value": "",
                "type": "query",
                "description": "If set to `true` the response will only return those orders that had been deleted by the user."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Query orders"
        },
        {
          "info": {
            "name": "Create an order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/orders",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a non-confirmed data order object, equivalent to a quote. After creation you can review the contents of the order and its quota requirements, and then choose to confirm it or not.\n\nData can be ordered by specifying a query (all items matching the query will be ordered) or item IDs (the specified items will be ordered).\n"
        },
        {
          "info": {
            "name": "Get an order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/orders/:orderId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "Order ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get an order"
        },
        {
          "info": {
            "name": "Delete an order",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/orders/:orderId",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "Order ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "`CREATED` orders will be permanently deleted.\n\n `CANCELLED` , `DONE` or `FAILED` ones will be deleted for normal querying but will still be available.\n\n `PARTIAL` or `RUNNING` orders cannot be deleted."
        },
        {
          "info": {
            "name": "Confirm an order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://services.sentinel-hub.com/api/v1/dataimport/orders/:orderId/confirm",
            "params": [
              {
                "name": "orderId",
                "value": "",
                "type": "path",
                "description": "Order ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Confirm the order and start executing it. Requires sufficient quota for the order. Only orders with status CREATED can be confirmed.\n"
        }
      ]
    }
  ],
  "bundled": true
}