Ordering

Last Updated: July 15, 2025

eAPI's ordering capability is quite simple. To order imagery, we first recommend conducting a search request. The results of the search can be used to obtain an image id. The image id will be used when an order is placed.

Order Endpoint¶

POST

https://eapi.maxar.com/e1so/order

Note: To try out the Order API from your browser, view the eAPI's Order Rapidoc webpage.

You will need a valid web token to make requests.

Request Body Parameters¶

Parameter	Description
deliveryType	Delivery Type for the imagery order (S3 only).
s3Delivery	S3 delivery specifications.
bucket	S3 bucket that will receive the delivery.
prefix	Prefix (directory) that delivery will be copied to. Will be created if it does not exist. As of Apr 3, 2024 this is a mandatory field.
inventoryId	Image Id for the order.

Example:

curl -X POST "https://eapi.maxar.com/e1so/order" \
 -H "Accept: application/json" \
 -H "Authorization: Bearer <ADD_YOUR_ACCESS_TOKEN>” \
 -H "Content-Type: application/json" \
 --data-raw '{
          "order": {
            "deliveries": {
              "deliveryType": "S3",
              "s3Delivery": {
                "bucket": "<ADD_YOUR_S3_BUCKET>",
                "prefix": "<ADD_YOUR_S3_BUCKET_PREFIX>"
              }
            },
            "inventoryId": "10200100D0C03400"
        }
}'

Submission return types¶

Successful¶

A successful image order will return a JSON object with information pertaining to the order.

Field	Description
submissionId	Unique order identifier.
submissionTime	The time eAPI started processing the order.

Example:

{
  "submissionId": "858d66d6-2bf4-4a3a-94e7-89725a22e871-e1so",
  "submissionTime": "2023-01-05T18:44:35.617021Z"
}

Unsuccessful¶

There are a few return types for unsuccessful submissions.

Malformed JSON¶

JSON that is malformed will also cause issues when submitting an order. Illustrations of this are missing brackets or commas, single instead of double quotes, and failure to provide all of the necessary parameters.

Example:

{
  "title": "The application has encountered an unknown error.",
  "status": 500,
  "detail": "Unexpected character ('\"' (code 34)): was expecting comma to separate Object entries\n at [Source: REDACTED (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled); line: 11, column: 5]",
  "instance": "/e1so/order",
  "traceId": "a93145cd-09c1-4db5-9202-ac9f02ee1031"
}

Image Inventory ID Issue¶

eAPI will check to make sure that the image being ordered exists in the catalog. If it does not exist an error will be returned.

Example:

{
  "title": "Something went wrong with your request, please try again.",
  "status": 400,
  "detail": "The provided inventoryId: 10200110C126EC00 does not exist. Please correct and retry.",
  "instance": "/e1so/order",
  "traceId": "69d5c668-3e21-4afb-bff6-43b2bdb3f0ca"
}

S3 Bucket Issues¶

Sometimes a user may incorrectly configure the S3 bucket in the order request. A bucket that does not exist, or that does not have proper S3 copy permissions for eAPI will cause this error to occur.

Example:

{
  "title": "Something went wrong with your request, please try again.",
  "status": 400,
  "detail": "The provided S3 bucket eapi-user-bucket-test does not have the required permissions or does exist. Please correct and retry.",
  "instance": "/e1so/order",
  "traceId": "5295536d-10b3-4542-9ed4-d9c35dc785d9"
}

AOI Ordering¶

Place an order for an AOI by providing the AOI as point pair and an inventory id the AOI intersects. You will receive only the scenes (or segments) of the full strip that satisfy the provided AOI rather than the full strip. The AOI must have an area smaller than 4 square kilometers. AOI ordering is not currently supported for third-party imagery. (This includes blacksky, capella, iceye, skysat, or umbra collections.)

Request Body Parameters¶

Parameter	Description
deliveryType	Delivery Type for the imagery order (S3 only).
s3Delivery	S3 delivery specifications.
bucket	S3 bucket that will receive the delivery.
prefix	Prefix (directory) that delivery will be copied to. Will be created if it does not exist.
inventoryId	Image Id for the order.
minimumLongitude	Min X coordinate.
minimumLatitude	Min Y coordinate.
maximumLongitude	Max X coordinate.
maximumLatitude	Max Y coordinate.

Example:

curl -X POST "https://eapi.maxar.com/e1so/order" \
 -H "Accept: application/json" \
 -H "Authorization: Bearer <ADD_YOUR_ACCESS_TOKEN>” \
 -H "Content-Type: application/json" \
 --data-raw '{
          "order": {
            "deliveries": {
              "deliveryType": "S3",
              "s3Delivery": {
                "bucket": "<ADD_YOUR_S3_BUCKET>",
                "prefix": "<ADD_YOUR_S3_BUCKET_PREFIX>"
              }
            },
            "inventoryId": "10300100E53C7B00",
            "AOI": {
                "minimumLongitude": 141.4622904762923,
                "minimumLatitude": 43.06815390116839,
                "maximumLongitude": 141.60963152320784,
                "maximumLatitude": 43.16113448030026
            }
        }
}'

Submission return types¶

Successful¶

A successful image order will return a JSON object with information pertaining to the order.

Field	Description
submissionId	Unique order identifier.
submissionTime	The time eAPI started processing the order.

Example:

{
  "submissionId": "858d66d6-2bf4-4a3a-94e7-89725a22e871-e1so",
  "submissionTime": "2023-01-05T18:44:35.617021Z"
}

Unsuccessful¶

There are a few return types for unsuccessful submissions of AOI orders in addition to the unsuccessful submission return types that are possible with regular orders.

Third-Party Vendors¶

AOI ordering is not currently supported for third-party imagery. This includes blacksky, capella, iceye, skysat, or umbra collections. Any AOI orders placed for these collections will be rejected, and you will be prompted to resubmit your order without an AOI.

Example:

{
  "title": "Something went wrong with your request, please try again.",
  "status": 400,
  "detail": "We currently do not support AOI orders for third-party inventory ids. Please correct and retry.",
  "instance": "/e1so/order",
  "traceId": "479eef89-22f5-4472-9747-15f881153849"
}

AOI Out Of Bounds/Malformed¶

If the provided AOI does not intersect the inventory id geometry or the AOI is incorrectly formatted the following error will occur. Check the AOI body for missing or misspelled key value pairs and verify that the chosen AOI intersects the provided inventory id.

Example:

{
  "title": "Something went wrong with your request, please try again.",
  "status": 400,
  "detail": "The provided AOI may be malformed or is not contained in inventoryId: 10300100E53C7B00. Please correct and retry.",
  "instance": "/e1so/order",
  "traceId": "764228f1-e901-42fd-b512-1bf605fe8af9"
}

AOI with area smaller than 4 square kilometers¶

The AOI must not have an area less than 4 square kilometers. If the provided AOI has an area smaller than 4 square kilometers, the following error will occur. Check the AOI coordinates so it has an area greater than 4 square kilometers and submit the order again.

Example:

{
  "title": "Something went wrong with your request, please try again.",
  "status": 400,
  "detail": "The submitted order’s AOI was less than 4.0 square kilometers. Please increase AOI size to be greater than 4.0 square kilometers and submit again.",
  "instance": "/e1so/order",
  "traceId": "764228f1-e901-42fd-b512-1bf605fe8af9"
}

🆕 Ordering Imagery Over Israel¶

Orders for imagery that intersect Israel with the 500m buffer that have a native GSD greater than .4m will succeed. If the order has a native GSD less than .4m, your order will still process and submit, resulting in a failed order by the factory. In this instance, we recommend the user retry ordering an image at a GSD greater than .4m.

For more information reference Searching for imagery over Israel

Order Status Check¶

Once an order has been submitted, you can check the status of it by using this endpoint. It will provide details on the eAPI order workflow process. The endpoint allows users to view the lifecycle of the order as it traverses through eAPI.

POST

https://eapi.maxar.com/e1so/order/status

Example:

curl -X GET "https://eapi.maxar.com/e1so/order/status?submissionId=90d13987-745c-4de4-8efe-69cdfd49ac3d-e1so" \
 -H "accept: application/json"\
 -H "authorization: Bearer <ADD_YOUR_ACCESS_TOKEN>" \

Example response

{
  "submissionId": "90d13987-745c-4de4-8efe-69cdfd49ac3d-e1so",
  "status": "COMPLETE",
  "message": "Cache order",
  "updated": "2023-01-10T17:45:06.559890Z"
}

Order Status Response Object¶

Key	Description
submissionId	Unique order identifier.
status	See table below for statuses and their definitions.
message	Additional information about the current status.
updated	Time the status was last updated.

The order statuses below are not listed in sequential order. Rather, all possible statuses are defined for reference purposes. An attempt has been made to put them in an order that makes sense. Case in point, cache fulfillment and error statuses will not always occur with every order.

Order Status Definitions¶

Status	Definition
RECEIVED	Order was received by the Maxar Image factory.
VALID	Order was validated by the Maxar Image factory.
REJECTED	Order was rejected by the Maxar Image factory.
ACTIVE	Order is being processed by the eAPI service.
CACHING	Order information is being added to the eAPI catalog and cache.
CACHE_FULFILLMENT	Order was found in the eAPI cache and will enter the fulfillment process.
PREPARING_FOR_DELIVERY	Order is being fulfilled from the eAPI cache.
DELIVERING	Order is being copied to the user delivery destination.
COMPLETE	Order has been successfully copied to the user delivery destination.
ERROR	There was an issue processing the order. Contact eAPI Mission Support Team

Delivery expectations¶

Image delivery times vary. Typical fulfillment times for images that are in the Maxar Catalog's online library (less than 30 days old), as well as third-party vendor imagery (including blacksky, capella, iceye, skysat, and umbra) will usually be delivered within under an hour. However, some images can take a day or more to fulfill. Delivery expectations for AOI orders follow this same convention. If you have questions regarding your order please contact the eAPI Mission Support Team.

Maxar eAPI (Mission) Support Team
Phone: 866-810-2297
eapisupport@maxar.com
Hours - 8:00am to 5:00pm EST

Online status check¶

eAPI recently added the ability to view the online status of an image. This allows a user to find out if an image is in eAPI's internal cache, online (in Maxar's online library), or in the Maxar offline library. The endpoint can be used before placing an order to help gauge how long it might take to fulfill the order.

View RapidDocs page for this endpoint.

Note: Please keep in mind the list below is presented as rough estimates and delivery times can vary within each category.

Images in eAPI's internal cache will usually be returned quickly. Typically in 3 to 5 minutes.
Images in Maxar's online library (less than 30 days old), as well as third-party vendor imagery (including blacksky, capella, iceye, skysat, and umbra) will usually be delivered within under an hour.
Images that are not in the eAPI internal cache and are not in the Maxar online library can take a day or more to fulfill.

GET

https://eapi.maxar.com/e1so/online/status

Example:

curl -X GET "https://eapi.maxar.com/e1so/online/status?inventoryId=10200110C126EC00" \
 -H "accept: application/json"\
 -H "authorization: Bearer <ADD_YOUR_ACCESS_TOKEN>"

Example response:

{
  "Status": [
    {
      "inventoryId": "10200110C126EC00",
      "name": "wv1.80652.09964.ba.p",
      "cached": true,
      "online": false,
      "message": "string" <Optional Return>
    }
  ]
}

Online status response object¶

Key	Description
inventoryId	Maxar image inventory ID
name	Unique image name
cached	Available in eAPI internal cache (True/False)
online	Available in Maxar online holdings (True/False)
message	Populated if image is not found

Delivery directory structure¶

Images ordered from eAPI will delivered to a directory with the same name as the submissionId that was returned when the order was placed. If a prefix was included in the order request, the submissionId directory will be nested directly below the prefix value specified.

Directory structure

<YOUR_S3_BUCKET_ROOT_DIRECTORY>/<YOUR_S3_PREFIX>/858d66d6-2bf4-4a3a-94e7-89725a22e871-e1so

Example: Image delivery

Image Support Data¶

All Imagery Products are delivered with a set of metadata files called Image Support Data (ISD). The number and types of files delivered varies depending on the product ordered. The ISD files can be viewed as a collection point for all useful ancillary data. The table below lists the Image Support Data files that are delivered with each product type

File Name	Extension
Top-Level Index (Readme) File	.TXT
Top-Level Index (XML) File	.XML
Layout File	.JPG
Geographic Location Map Files	.shx, .shp, .dbf
Product Component Index (Subdirectory Readme) File	.TXT
License File	.TXT
Image Metadata File	.IMD
Product Browse File	.JPG
Tile Map File	.TIL
Attitude File	.ATT
Ephemeris File	.EPH
Geometric Calibration File	.GEO
RPC00B File	.RPB
XML File	.XML

Image Support Data File Description¶

Products include Image Support Data (ISD) at two levels: one set of Delivery ISD, and one set of Product Component ISD for each product option ordered. The number of product components depends on the layout of the order polygon with respect to scene or strip boundaries. If the order polygon is entirely contained within a single scene or strip, then only one product component will be delivered. If an order polygon crosses strip or scene boundaries, then the imagery product will be divided into multiple product components. Product options include panchromatic, multispectral, or pan-sharpened.

The Delivery ISD (one set per delivery) consists of:¶

Top-Level Index (Readme) File. This file contains a list of names of the product files and the ISD files, along with copyright information for the entire product delivery.
Top-Level Index XML File. This file contains the same information as the Top Level Index (README) file but in XML format.
Layout File. This file spatially illustrates how the delivery order is spread out across the media including product and order polygon extents. The map includes volume and product labels. The file is in the standard JPEG format. Media volume information is not included for electronic deliveries.
Geographic Location Map Files. These files spatially illustrate the product layout in a similar way to the layout file except in shapefile format. The files represent the order polygon, strip boundaries, product boundaries, and tile boundaries.
Manifest File. The file contains the directory listing of the files delivered with the product.

The Product Component ISD (one set per product component option) consists of:¶

Product Component Index (Subdirectory Readme) File. The README file provides copyright information and the names of the ISD files for a single product within a delivery.
License File. The license file contains the text of the selected license.
Image Metadata File. The image metadata file describes key attributes about the image product, including product level, corner coordinates, and projection information, and time of acquisition.
Product Browse File. The product browse file is a JPEG compressed browse image of the delivered product.
Tile Map. The tile map file assists the customer in determining what tile to ingest to look at a specific part of the order polygon.
Attitude File. The attitude file includes the time of first data point, the number of points, and the interval between the points and attitude information.
Ephemeris File. The ephemeris file includes the time of first data point, the number of points, and the interval between the points and ephemeris information.
Geometric Calibration File. The geometric calibration file contains the standard photogrammetric parameters of a virtual camera that models the corresponding camera and optical system for Basic Imagery products.
RPC00B File. The RPC00B file contains the RPC information, which can be used to rectify the image. This is a mathematical mapping from object space coordinates to image space coordinates.
XML File. This file contains the same information as the combined README, Licensing, Image Metadata, Tile Map and RPC00B files, in XML format. For Basic Imagery Products, the attitude, ephemeris, and geometric calibration file are included as well.

File Layout¶

This section describes the structure by which the Image Support Data (ISD) files are organized for delivery. The Figure below displays the layout as it applies to delivery of imagery and ISD files for all media types.

File Structre Layout

Figure "File Structure Layout"

File Structre Layout

Figure "Product Component ISD"