Order Details

GET 
/orders/:id

Retrieve the details and status of an order.

Request

Path Parameters

id integerrequired
REQUIRED. The ID given to the order.
Example: 6189393522526776583

Responses

200

OK

application/json

Schema

Schema

data objectrequired
id string
date_created string
date_modified string
user_id string
pipeline_id string
settings object
output_configs object[]
Sets delivery notifications
Array [
oneOf
Amazon S3
type stringrequired
Possible values: [amazon_s3]
bucket stringrequired
prefix stringrequired
role_arn string
Google Cloud Storage
type stringrequired
Possible values: [google_cloud_storage]
bucket stringrequired
prefix stringrequired
service_credentials stringrequired
Azure Blob Storage
type stringrequired
Possible values: [azure_blob_storage]
container stringrequired
prefix stringrequired
sas_url stringrequired
File Download
type stringrequired
Possible values: [download]
format stringrequired
Possible values: [zip, tar]
MGP Order Manager
type stringrequired
Possible values: [mgp_order_manager]
]
notifications object[]
Sets order notifications
Array [
oneOf
HTTP Callback
config object
headers object
internal_auth_provider string
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [http]
Amazon SNS
config object
requires_message_deduplication_id booleanrequired
requires_message_group_id booleanrequired
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [sns]
Email
level string
Possible values: [FINAL_ONLY, INTERMEDIATE, INITIAL_FINAL, ON_FAIL]
target stringrequired
type stringrequired
Possible values: [email]
]
metadata object
status string
status_details object
process_details object
order_links object
links objectrequired
request string
request_timestamp stringrequired
response_timestamp stringrequired
request_duration numberrequired

Example (from schema)

{
  "data": {
    "id": "99926034175760632",
    "date_created": "2022-12-01T23:19:02Z",
    "date_modified": "2022-12-01T23:19:04Z",
    "user_id": "144445555",
    "pipeline_id": "imagery/analysis-ready",
    "settings": {
      "acquisitions": [
        "03cf5011-7fd0-49ab-8bcf-36d7e2a1075f-inv"
      ],
      "aoi": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              47.8,
              29.25
            ],
            [
              47.8,
              29.27
            ],
            [
              47.81,
              29.27
            ],
            [
              47.81,
              29.25
            ],
            [
              47.8,
              29.25
            ]
          ]
        ]
      },
      "ard_settings": {
        "bundle_adjust": true,
        "healthy_vegetation_mask": false,
        "water_mask": false
      }
    },
    "output_configs": [
      {
        "type": "amazon_s3",
        "bucket": "example-bucket",
        "prefix": "example-prefix"
      }
    ],
    "notifications": [
      {
        "type": "email",
        "target": "email@myemail.com",
        "level": "FINAL"
      }
    ],
    "metadata": {
      "project_id": "your project name"
    },
    "status": "RECEIVED",
    "status_details": {},
    "process_details": {},
    "order_links": {
      "order_details_url": "https://api.maxar.com/ordering/v1/orders/99926034175760632",
      "order_events_url": "https://api.maxar.com/ordering/v1/orders/99926034175760632/events"
    }
  },
  "links": {
    "request": true
  },
  "request_timestamp": "2022-12-01T23:19:02Z",
  "response_timestamp": "2022-12-01T23:19:06Z",
  "request_duration": 4
}

Loading...