Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors 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"
}

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: Yes

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

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",
      "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 Errors.

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.

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