Amazon Outposts Orders API

The Orders API from Amazon Outposts — 3 operation(s) for orders.

GitHub OpenAPI

Operations 3

POST /orders Create Order #
GET /orders/{OrderId} Get Order #
POST /orders/{OrderId}/cancel Cancel Order #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-outposts:amazon-outposts-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-outposts-orders-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Outposts Orders API
  version: '2019-12-03'
  description: Generated from AWS's published Smithy model for AWS Outposts. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://outposts.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /orders:
    post:
      operationId: CreateOrder
      summary: Create Order
      description: Creates an order for an Outpost.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrderOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrderInput'
      tags:
      - Orders
  /orders/{OrderId}:
    get:
      operationId: GetOrder
      summary: Get Order
      description: Gets information about the specified order.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderOutput'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrderInput'
      tags:
      - Orders
  /orders/{OrderId}/cancel:
    post:
      operationId: CancelOrder
      summary: Cancel Order
      description: Cancels the specified order for an Outpost.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelOrderOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOrderInput'
      tags:
      - Orders
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: outposts
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CancelOrderInput:
      type: object
      properties:
        OrderId:
          type: string
          description: The ID of the order.
      required:
      - OrderId
    CancelOrderOutput:
      type: object
      properties: {}
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the resource causing the conflict.
        ResourceType:
          type: string
          enum:
          - OUTPOST
          - ORDER
          description: The type of the resource causing the conflict.
    CreateOrderInput:
      type: object
      properties:
        OutpostIdentifier:
          type: string
          description: The ID or the Amazon Resource Name (ARN) of the Outpost.
        QuoteIdentifier:
          type: string
          description: The ID of the quote to use for the order.
        QuoteOptionIdentifier:
          type: string
          description: The ID of the quote option to use for the order.
        LineItems:
          type: array
          items:
            $ref: '#/components/schemas/LineItemRequest'
          description: The line items that make up the order.
        PaymentOption:
          type: string
          enum:
          - ALL_UPFRONT
          - NO_UPFRONT
          - PARTIAL_UPFRONT
          description: The payment option.
        PaymentTerm:
          type: string
          enum:
          - THREE_YEARS
          - ONE_YEAR
          - FIVE_YEARS
          description: The payment terms.
      required:
      - OutpostIdentifier
      - PaymentOption
    CreateOrderOutput:
      type: object
      properties:
        Order:
          $ref: '#/components/schemas/Order'
    GetOrderInput:
      type: object
      properties:
        OrderId:
          type: string
          description: The ID of the order.
      required:
      - OrderId
    GetOrderOutput:
      type: object
      properties:
        Order:
          $ref: '#/components/schemas/Order'
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    LineItem:
      type: object
      properties:
        CatalogItemId:
          type: string
          description: The ID of the catalog item.
        LineItemId:
          type: string
          description: The ID of the line item.
        Quantity:
          type: integer
          description: The quantity of the line item.
        Status:
          type: string
          enum:
          - PREPARING
          - BUILDING
          - SHIPPED
          - DELIVERED
          - INSTALLING
          - INSTALLED
          - ERROR
          - CANCELLED
          - REPLACED
          description: The status of the line item.
        ShipmentInformation:
          $ref: '#/components/schemas/ShipmentInformation'
        AssetInformationList:
          type: array
          items:
            $ref: '#/components/schemas/LineItemAssetInformation'
          description: Information about assets.
        PreviousLineItemId:
          type: string
          description: The ID of the previous line item.
        PreviousOrderId:
          type: string
          description: The ID of the previous order.
    LineItemAssetInformation:
      type: object
      properties:
        AssetId:
          type: string
          description: The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts
            server configuration.
        MacAddressList:
          type: array
          items:
            type: string
          description: The MAC addresses of the asset.
    LineItemRequest:
      type: object
      properties:
        CatalogItemId:
          type: string
          description: The ID of the catalog item.
        Quantity:
          type: integer
          description: The quantity of a line item request.
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    Order:
      type: object
      properties:
        OutpostId:
          type: string
          description: The ID of the Outpost in the order.
        QuoteIdentifier:
          type: string
          description: The ID of the quote associated with the order.
        QuoteOptionIdentifier:
          type: string
          description: The ID of the quote option associated with the order.
        OrderId:
          type: string
          description: The ID of the order.
        Status:
          type: string
          enum:
          - RECEIVED
          - PENDING
          - PROCESSING
          - INSTALLING
          - FULFILLED
          - CANCELLED
          - PREPARING
          - IN_PROGRESS
          - DELIVERED
          - COMPLETED
          - ERROR
          description: 'The status of the order. PREPARING - Order is received and being prepared. IN_PROGRESS - Order is
            either being built or shipped. To get more details, see the line item status. DELIVERED - Order was delivered
            to the Outpost site. COMPLETED - Order is complete. CANCELLED - Order is cancelled. ERROR - Customer should contact
            support. The following status are deprecated: RECEIVED, PENDING, PROCESSING, INSTALLING, and FULFILLED.'
        LineItems:
          type: array
          items:
            $ref: '#/components/schemas/LineItem'
          description: The line items for the order
        PaymentOption:
          type: string
          enum:
          - ALL_UPFRONT
          - NO_UPFRONT
          - PARTIAL_UPFRONT
          description: The payment option for the order.
        OrderSubmissionDate:
          type: string
          format: date-time
          description: The submission date for the order.
        OrderFulfilledDate:
          type: string
          format: date-time
          description: The fulfillment date of the order.
        PaymentTerm:
          type: string
          enum:
          - THREE_YEARS
          - ONE_YEAR
          - FIVE_YEARS
          description: The payment term.
        OrderType:
          type: string
          enum:
          - OUTPOST
          - REPLACEMENT
          description: The type of order.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    ShipmentInformation:
      type: object
      properties:
        ShipmentTrackingNumber:
          type: string
          description: The tracking number of the shipment.
        ShipmentCarrier:
          type: string
          enum:
          - DHL
          - DBS
          - FEDEX
          - UPS
          - EXPEDITORS
          description: The carrier of the shipment.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/outposts/service/2019-12-03/outposts-2019-12-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)