Maxar Technologies Orders API

The Orders API from Maxar Technologies — 2 operation(s) for orders.

Documentation

Specifications

Other Resources

OpenAPI Specification

maxar-technologies-orders-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Vantor Hub Account Services Accounts Orders API
  description: Administrative account-management API for Vantor Hub customers — manage users, roles, organisation entitlements, credit balances and API keys. Profile derived from public Vantor Hub docs (hub.vantor.com/docs/admin) and Maxar Geospatial Platform `account_service` SDK conventions; field shapes should be confirmed against live Hub responses.
  version: 1.0.0
servers:
- url: https://api.maxar.com/admin/v1
  description: Vantor Hub production
security:
- bearerAuth: []
tags:
- name: Orders
paths:
  /orders:
    get:
      tags:
      - Orders
      summary: List Orders
      operationId: listOrders
      parameters:
      - name: status
        in: query
        schema:
          type: string
          enum:
          - pending
          - in_progress
          - complete
          - failed
          - cancelled
      - name: limit
        in: query
        schema:
          type: integer
          default: 25
      responses:
        '200':
          description: Orders
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'
    post:
      tags:
      - Orders
      summary: Place Order
      operationId: placeOrder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRequest'
      responses:
        '201':
          description: Order created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
  /orders/{orderId}:
    get:
      tags:
      - Orders
      summary: Get Order
      operationId: getOrder
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
    delete:
      tags:
      - Orders
      summary: Cancel Order
      operationId: cancelOrder
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Cancelled
components:
  schemas:
    OrderRequest:
      type: object
      required:
      - aoi
      - items
      properties:
        name:
          type: string
        aoi:
          type: object
          description: GeoJSON geometry
        items:
          type: array
          items:
            type: object
            properties:
              catalog_id:
                type: string
              collection:
                type: string
        delivery:
          type: object
          properties:
            type:
              type: string
              enum:
              - s3
              - gcs
              - download
            destination:
              type: string
        output_format:
          type: string
          enum:
          - geotiff
          - jpeg2000
          - nitf
    Order:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
          - pending
          - in_progress
          - complete
          - failed
          - cancelled
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        cost:
          type: number
        currency:
          type: string
        items:
          type: array
          items:
            type: object
            properties:
              catalog_id:
                type: string
              status:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT