Get delivery

GET /delivery/v1/deliveries/{id}

After submitting a delivery request with createDelivery, you can call the getDelivery operation with a specific delivery ID to get the status of the delivery. When the status changes to SUCCESS, you can download the requested bundle file from the specified delivery location.

Delivery object

The delivery object is returned in an API response to give the current status of the specified delivery request.

Property Description

id

ID of the delivery request.

status

A string value that provides the current status of the bundle request (PENDING, SUCCESS, or FAILED).

url

Delivery location in URL format (for example, https://bucket-name.s3.region.amazonaws.com/file-name).

itemIDs

An array of STAC item IDs, which specifies the products included in the delivery.

deliveryLocations

An array of delivery locations where the products are delivered.

notifications

(Optional) A notifications object for receving callbacks through a Webhook.

Example

Request

Enter the following curl command, remembering to replace the ${VARNAME} variables with the appropriate values:

curl --location "${API_BASE_URL}/api/delivery/v1/deliveries/${DELIVERY_ID}" \
--header "Accept: application/json, application/problem+json" \
--header "Authorization: Bearer ${API_ACCESS_TOKEN}"

Response

On success, returns a 200 status code and a JSON object containing the delivery object, which includes the delivery status and a URL to download the bundled products (if the status is SUCCESS).

{
  "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "status": "SUCCESS",
  "url": "https://bucket-name.s3.region.amazonaws.com/file-name",
  "itemIDs": [
    "XXXX-XXXX",
    "XXXX-XXXX"
  ],
  "deliveryLocations": [
    {
      "configID": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "path": "path",
      "subpath": "subpath"
    }
  ],
  "notifications": {
    "webhook": {
      "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
  }
}