Monitor orders

Monitor the status of your orders using the API.


Overview

After placing the order, a unique order identifier is added to UP42 storage. You can access your storage using the API to monitor the progress of each order. The delivery timeframe depends on whether the order is tasking or catalog data.

You can also view and monitor orders using the console.

See orders

To see a list of tasking and catalog orders, call the /v2/orders endpoint.

Request

GET /v2/orders HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}
Query parameterOverview
workspaceIdstring
The workspace ID. Use to get objects from a specific workspace. Otherwise, objects from the entire account will be returned.
typestring
The order type:
  • TASKING
  • ARCHIVE
To get orders of all types, don't use the parameter.
statusarray of strings
Search for orders with any of the provided statuses:
  • CREATED
  • BEING_PLACED
  • PLACED
  • PLACEMENT_FAILED
  • DELIVERY_INITIALIZATION_FAILED
  • BEING_FULFILLED
  • DOWNLOAD_FAILED
  • DOWNLOADED
  • FULFILLED
  • FAILED_PERMANENTLY
displayNamestring
Search for orders that contain this string in their name.
tagsarray of strings
Search for assets with any of the provided tags.
sizeinteger
The number of results on a result page. The default value is 20.
pageinteger
The result page number. To get the first page, set the parameter to 0. The default value is 0.
sortstring
The results sorting method that arranges elements in ascending or descending order based on a chosen field. The format is <field name>,<asc or desc>. The default value is createdAt,desc.

Response


See response example
{
  "content": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspaceId": "a19e9ab6-afad-461f-8043-ce19cfd0985b",
      "accountId": "69353acb-f942-423f-8f32-11d6d67caa77",
      "type": "TASKING",
      "dataProductId": "613ad1f5-4148-4460-a316-1a97e46058f9",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "createdBy": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "INTERNAL"
      },
      "updatedBy": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "INTERNAL"
      },
      "tags": ["project-7"],
      "displayName": "BlackSky NY Central Park",
      "orderDetails": {
        "acquisitionStart": "2019-08-24T14:15:22Z",
        "acquisitionEnd": "2019-08-24T14:15:22Z",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [-73.981842, 40.771133],
              [-73.958855, 40.796415],
              [-73.958855, 40.796415],
              [-73.981842, 40.771133]
            ]
          ]
        },
        "extraDescription": "August project description",
        "subStatus": "FEASIBILITY_WAITING_UPLOAD"
      },
      "status": "CREATED"
    },
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "workspaceId": "a19e9ab6-afad-461f-8043-ce19cfd0985b",
      "accountId": "69353acb-f942-423f-8f32-11d6d67caa77",
      "type": "ARCHIVE",
      "dataProductId": "ec016f4c-332c-4190-b18b-13fb12519c40",
      "createdAt": "2022-08-30T06:51:46.607408Z",
      "updatedAt": "2022-08-30T06:52:29.993842Z",
      "createdBy": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "USER"
      },
      "updatedBy": {
        "id": "system",
        "type": "INTERNAL"
      },
      "displayName": "WorldDEM NY Central Park",
      "tags": [],
      "orderDetails": {
        "aoi": {
          "type": "Polygon",
          "coordinates": [
            [
              [-73.981842, 40.771133],
              [-73.958855, 40.796415],
              [-73.958855, 40.796415],
              [-73.981842, 40.771133]
            ]
          ],
          "crs": {
            "type": "name",
            "properties": {
              "name": "EPSG:4326"
            }
          }
        }
      },
      "status": "FULFILLED"
    }
  ]
}

ParameterOverview
content.idstring
The order ID.
content.
workspaceId
string
The workspace ID.
content.
accountId
string
The account ID.
content.typestring
The order type:
  • TASKING
  • ARCHIVE
content.
dataProductId
string or null
The data product ID.
content.
createdAt
string
The timestamp when the order was created.
content.
updatedAt
string
The timestamp when the order was last updated.
content.
createdBy
object
The ID and type of the user who performed the action.
content.
createdBy.id
string
The ID of the user who performed the action.
content.
createdBy.type
string
The type of user who performed the action:
  • INTERNAL
  • ADMIN
  • API_KEY
  • USER
content.
orderDetails
object
Details about the order. The response depends on whether the order is for catalog or tasking data.
content.statusarray of strings
The order status:
  • CREATED
  • BEING_PLACED
  • PLACED
  • PLACEMENT_FAILED
  • DELIVERY_INITIALIZATION_FAILED
  • BEING_FULFILLED
  • DOWNLOAD_FAILED
  • DOWNLOADED
  • FULFILLED
  • FAILED_PERMANENTLY

See an order

To see information about a particular order, call the /v2/orders/{order-id} endpoint with the order ID as a path parameter.

Request

GET /v2/orders/{order-id} HTTP/1.1
Host: api.up42.com
Authorization: Bearer {token}

Response

The response is an object from the /v2/orders endpoint content array.


See response example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspaceId": "a19e9ab6-afad-461f-8043-ce19cfd0985b",
  "accountId": "69353acb-f942-423f-8f32-11d6d67caa77",
  "type": "TASKING",
  "dataProductId": "613ad1f5-4148-4460-a316-1a97e46058f9",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "INTERNAL"
  },
  "updatedBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "INTERNAL"
  },
  "tags": ["project-7"],
  "displayName": "BlackSky NY Central Park",
  "orderDetails": {
    "acquisitionStart": "2019-08-24T14:15:22Z",
    "acquisitionEnd": "2019-08-24T14:15:22Z",
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        [
          [-73.981842, 40.771133],
          [-73.958855, 40.796415],
          [-73.958855, 40.796415],
          [-73.981842, 40.771133]
        ]
      ]
    },
    "extraDescription": "August project description",
    "subStatus": "FEASIBILITY_WAITING_UPLOAD"
  },
  "status": "CREATED"
}