Ordering API Quickstart
This API quickstart guide walks you through a standard workflow using the Ordering API endpoints.
Prerequisites
MGP Account credentials
To access the Ordering API, you need an MGP account. You will use the username and password for this account to get a token, described in the next section.
- Don't have an MGP account yet? Contact Maxar Sales.
- Forgot your password? Visit https://account.maxar.com and choose "forgot password."
Get credentials
The Ordering API requires authentication.
You can use an API Key or an OAuth Bearer Token
Optional: Grant MGP write access to your cloud storage location
If you plan to deliver your order directly to cloud storage, MGP needs write access to your storage location. Learn how to grant write access to your cloud storage location:
Base URLs
The base URL for the account service is account.maxar.com. The base URL for the Ordering API is api.maxar.com
1. Get a list of orderable content types if needed
Each content type is processed through a dedicated pipeline. This request will return a list of available pipelines and their schema. You can limit the number of pipelines returned by adding a number to the optional "limit" variable.
In the response, take note of your preferred pipeline's "namespace" and "name". These two attributes are needed for the next steps.
GET List Pipelines API request
2. Get details for a content type if needed
To view the schema for a specific content type' pipeline, submit a GET Pipeline request. The URL requires the "namespace" and "name" as path parameters . This information can be found in the response from step 1. The "settings schema" in the response describes the settings to include in your order request.
3. Construct an order request body
Use the Intro to Ordering guide to learn how to construct an order request body. You can use this request body to make a /validate, /estimate, or /order request.
4. Validate/Estimate an Order request (Optional)
Before you place an order, you can validate it or get a usage estimate. Use the request body you constructed in step 3 to create your order request, and then send it to the /validate or /estimate endpoint.
Note: The responses for these requests are specific to the content type you order. The responses are described in the ordering examples for each content type.
Estimate usage for an order request
5. Place an Order
Use the request body you constructed in step 3 to create your order request, and then send it to the /order endpoint.
6. Get the details or events for an Order
View the details and events about your order by submitting either the GET Order Details or GET Order Events calls with the Order ID.
GET Order Details returns the order request body and additional details.
GET Order Events returns a list of events/status updates for the order. This information is available for one week after the order is complete.
6. Cancel an Order
An order can be canceled until the delivery process begins. This request requires your Order ID.
Response Codes
Below is a list of HTTP responses for each request type.
| API Request | Responses |
|---|---|
GET List Pipelines | 200 OK, 500 Internal Server Error |
GET Pipeline Details | 200 OK, 403 Forbidden, 404 Not Found, 500 Internal Server Error |
POST Validate Order | 202 Accepted, 400 Bad Request, 400 Invalid Body, 403 Forbidden, 404 Not Found, 500 Internal Server Error |
POST Estimate Order | 200 OK, 400 Bad Request, 400 Invalid Body, 404 Not Found, 500 Internal Server Error |
POST Place Order | 202 Accepted, 400 Bad Request, 400 Invalid Body, 403 Forbidden, 404 Not Found, 500 Internal Server Error |
GET Order Details | 200 OK, 403 Forbidden, 404 Not Found, 500 Internal Server Error |
GET Order Events | 200 OK, 403 Forbidden, 404 Not Found, 500 Internal Server Error |
POST Cancel Order | 202 Accepted, 400 Bad Request, 403 Forbidden, 404 Not Found, 500 Internal Server Error |
For a list of all HTTP response codes and their definitions, see the HTTP status code glossary.