Skip to main content

Ordering Output Delivery Options

Orders can be delivered to the following output options by specifying them in the output_configs array.

"output_configs": [
  {an output object},
  {another output object}
]

Note the API originally accepted a single output_config object, however this formatting will be deprecated in the future. An output_configs array should be used instead.

Download delivery​

With the download option, you will receive a link to download the file. Download links are valid for seven days. This output is specifically for API orders and is not related to download functionality in the Orders tab of the Vantor Hub application.

{
"type": "download",
"format": "zip"
}

The format of the file can be zip or tar. If an email notification was configured for the order, you will receive a link to the download in the delivery notification email. The download link is also included in the responses of the Get Order Details and Get Order Events endpoints.

Example download link in Order Details response

A completed order that is ready to download will include the following field in the response:

 'status_details': {'total_size_mb': 0.142,
  'total_file_count': 3,
  'message': 'Delivered order successfully',
  'deliveries': [
    {
      'instructions': 'Please click the included links to download your ordered products.',
      'links': ['<DOWNLOAD LINK WITH PRESIGNED URL>'],
      'archive_format': 'zip',
      'type': 'download'
    }
  ]
},
Example download link in Order Events response

The final event in a completed order contains a message field that includes the download URL within some inline JSON.

{'date_created': '2025-03-07T22:04:49Z',
  'order_id': '6666274678718784704',
  'pipeline_id': 'insights/object-detection',
  'message': "Order status updated from IN_PROGRESS to SUCCESS. Details: {'message': 'Delivered order successfully', 'total_size_mb': 0.142, 'total_file_count': 3, 'deliveries': [{'type': 'download', 'archive_format': 'zip', 'instructions': 'Please click the included links to download your ordered products.', 'links': ['<DOWNLOAD LINK WITH PRESIGNED URL>']}]}",
  'event_code': 'status_updated'}

Cloud storage delivery​

Files can be delivered directly to cloud storage locations. You will need to configure your storage to allow writing files there.

AWS S3​

{
  "type": "amazon_s3",
  "bucket" "your_bucket",
  "prefix": "your/prefix"
  "role_arn" "optional IAM ARN to assume"
}

role_arn is optional and can be used as an alternate way to grant delivery access to your bucket. See the Amazon AWS Setup Guide for more information on setting up delivery to S3 buckets.

Azure Cloud Storage​

{
  "type": "azure_blob_storage",
  "sas_url": "Azure SAS URL string goes here",
  "container": "my-container",
  "prefix": "your/prefix"
}

See the Azure Setup Guide for more information on setting up delivery to Azure storage containers.

Google Cloud Storage​

{
  "type": "google_cloud_storage",
  "service_credentials": "... base64-encoded credentials string ...",
  "bucket": "my-bucket",
  "prefix": "your/prefix"
}

See the Google Cloud Storage Setup Guide for more information on setting up delivery to Azure storage containers.

Vantor Hub UI​

Orders placed from the API can also be sent to Vantor Hub UI.

{
  "type": "mgp_order_manager"
}

The delivered files can be accessed as if the order was placed in the UI. Once the initial API delivery has completed users can download the order from the UI or send it manually to additional cloud storage locations. Note that the Vantor Hub UI only holds delivered files for two weeks.