Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

CreateOrder

Creates an order for an Outpost.

Request Syntax


POST /orders HTTP/1.1
Content-type: application/json

{
   "LineItems": [ 
      { 
         "CatalogItemId": "string",
         "Quantity": number
      }
   ],
   "OutpostIdentifier": "string",
   "PaymentOption": "string",
   "PaymentTerm": "string",
   "QuoteIdentifier": "string",
   "QuoteOptionIdentifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

LineItems

The line items that make up the order.

Type: Array of LineItemRequest objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: No

OutpostIdentifier

The ID or the Amazon Resource Name (ARN) of the Outpost.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 180.

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$

Required: Yes

PaymentOption

The payment option.

Type: String

Valid Values: ALL_UPFRONT | NO_UPFRONT | PARTIAL_UPFRONT

Required: Yes

PaymentTerm

The payment terms.

Type: String

Valid Values: THREE_YEARS | ONE_YEAR | FIVE_YEARS

Required: No

QuoteIdentifier

The ID of the quote to use for the order.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:quote/)?oq-[a-f0-9]{17}$

Required: No

QuoteOptionIdentifier

The ID of the quote option to use for the order.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 21.

Pattern: ^oqo-[a-f0-9]{17}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Order": { 
      "LineItems": [ 
         { 
            "AssetInformationList": [ 
               { 
                  "AssetId": "string",
                  "MacAddressList": [ "string" ]
               }
            ],
            "CatalogItemId": "string",
            "LineItemId": "string",
            "PreviousLineItemId": "string",
            "PreviousOrderId": "string",
            "Quantity": number,
            "ShipmentInformation": { 
               "ShipmentCarrier": "string",
               "ShipmentTrackingNumber": "string"
            },
            "Status": "string"
         }
      ],
      "OrderFulfilledDate": number,
      "OrderId": "string",
      "OrderSubmissionDate": number,
      "OrderType": "string",
      "OutpostId": "string",
      "PaymentOption": "string",
      "PaymentTerm": "string",
      "QuoteIdentifier": "string",
      "QuoteOptionIdentifier": "string",
      "Status": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Order

Information about this order.

Type: Order object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have permission to perform this operation.

HTTP Status Code: 403

ConflictException

Updating or deleting this resource can cause an inconsistent state.

ResourceId: The ID of the resource causing the conflict.
ResourceType: The type of the resource causing the conflict.

HTTP Status Code: 409

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

NotFoundException

The specified request is not valid.

HTTP Status Code: 404

ServiceQuotaExceededException

You have exceeded a service quota.

HTTP Status Code: 402

ValidationException

A parameter is not valid.

HTTP Status Code: 400

Examples

Example 1: Create an order from a quote

This example creates an order using a quote and quote option.

Sample Request


aws outposts create-order --outpost-identifier op-1234567890example --quote-identifier oq-1234567890abcdef0 --quote-option-identifier oqo-1234567890abcdef0 --payment-option ALL_UPFRONT --payment-term THREE_YEARS

Sample Response


{
  "Order": {
    "OutpostId": "op-1234567890example",
    "QuoteIdentifier": "oq-1234567890abcdef0",
    "QuoteOptionIdentifier": "oqo-1234567890abcdef0",
    "OrderId": "oo-1234567890abcdef0",
    "Status": "PREPARING",
    "LineItems": [
      {
        "LineItemId": "ooi-1234567890abcdef0",
        "Quantity": 1,
        "Status": "PREPARING"
      }
    ],
    "PaymentOption": "ALL_UPFRONT",
    "PaymentTerm": "THREE_YEARS",
    "OrderSubmissionDate": "2026-06-15T10:30:00Z",
    "OrderType": "OUTPOST"
  }
}

Example 2: Create an order with line items

This example creates an order by specifying line items directly.

Sample Request


aws outposts create-order --outpost-identifier op-1234567890example --line-items CatalogItemId=OR-A1B2C3D,Quantity=1 --payment-option ALL_UPFRONT --payment-term THREE_YEARS

Sample Response


{
  "Order": {
    "OutpostId": "op-1234567890example",
    "OrderId": "oo-2345678901abcdef0",
    "Status": "PREPARING",
    "LineItems": [
      {
        "CatalogItemId": "OR-A1B2C3D",
        "LineItemId": "ooi-2345678901abcdef0",
        "Quantity": 1,
        "Status": "PREPARING"
      }
    ],
    "PaymentOption": "ALL_UPFRONT",
    "PaymentTerm": "THREE_YEARS",
    "OrderSubmissionDate": "2026-06-15T10:30:00Z",
    "OrderType": "OUTPOST"
  }
}