POST api/orders

Create a set of orders.

Request Information

URI Parameters

None.

Body Parameters

List of order instructions

Collection of OrderCreation

Name	Description	Type	Additional information
clientID	Unique client identifier.	integer	None.
registrationReference	External registration reference.	string	None.
securityCode	ASX code for the order.	string	Required
buySell	Buy / sell indicator.	enBuySell	Required
priceType	Order price type.	enOrderPriceType	Required
price	Order price in dollars. ie. 11.45. Required for limit orders.	decimal number	None.
quantity	Quantity of the order (either quantity or trade value is required).	integer	None.
tradeValue	Trade value of the order (either quantity or trade value is required).	decimal number	None.
validityType	Order validity type.	enOrderValidityType	Required
expiryDate	Order expiry date. Required if order validity type is GoodTillDate.	string	None.
creatorID	The person ID whom this order is for. Required if you are submitting this instruction on behalf of a person.	integer	None.
reference	External reference for an order. Use this field to link an order with one on your system.	string	None.
miscellaneousTags	Use this field to add any number of tags onto an order for processing on your system.	Collection of string	None.
PIN	User PIN. Use this if PIN validation is required.	string	None.
CustomBrokerageFee	Custom Brokerage Fee for dollar override.	decimal number	None.
CustomBrokeragePercent	Custom Brokerage Percent for percent override..	decimal number	None.
ClientBrokerageScheduleID	Client Brokerage Schedule identifier.	integer	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "clientID": 12345,
    "registrationReference": null,
    "securityCode": "BHP",
    "buySell": 1,
    "priceType": 1,
    "price": 1.25,
    "quantity": 500,
    "tradeValue": null,
    "validityType": 3,
    "expiryDate": null,
    "creatorID": 12345,
    "reference": null,
    "miscellaneousTags": [
      "TAG1",
      "TAG2",
      "TAG3"
    ],
    "PIN": "1234",
    "CustomBrokerageFee": 66.0,
    "CustomBrokeragePercent": 0.154,
    "ClientBrokerageScheduleID": 884433
  },
  {
    "clientID": 67890,
    "registrationReference": null,
    "securityCode": "CBA",
    "buySell": 2,
    "priceType": 3,
    "price": null,
    "quantity": 250,
    "tradeValue": null,
    "validityType": 6,
    "expiryDate": null,
    "creatorID": 12345,
    "reference": null,
    "miscellaneousTags": [
      "TAG1",
      "TAG2",
      "TAG3"
    ],
    "PIN": "2222",
    "CustomBrokerageFee": null,
    "CustomBrokeragePercent": null,
    "ClientBrokerageScheduleID": null
  }
]

application/xml, text/xml

Sample:

<ArrayOforder xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <order>
    <clientID>12345</clientID>
    <registrationReference i:nil="true" />
    <securityCode>BHP</securityCode>
    <buySell>Buy</buySell>
    <priceType>Limit</priceType>
    <price>1.25</price>
    <quantity>500</quantity>
    <tradeValue i:nil="true" />
    <validityType>DayOnly</validityType>
    <expiryDate i:nil="true" />
    <creatorID>12345</creatorID>
    <reference i:nil="true" />
    <miscellaneousTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>TAG1</d3p1:string>
      <d3p1:string>TAG2</d3p1:string>
      <d3p1:string>TAG3</d3p1:string>
    </miscellaneousTags>
    <PIN>1234</PIN>
    <CustomBrokerageFee>66</CustomBrokerageFee>
    <CustomBrokeragePercent>0.154</CustomBrokeragePercent>
    <ClientBrokerageScheduleID>884433</ClientBrokerageScheduleID>
  </order>
  <order>
    <clientID>67890</clientID>
    <registrationReference i:nil="true" />
    <securityCode>CBA</securityCode>
    <buySell>Sell</buySell>
    <priceType>MarketToLimit</priceType>
    <price i:nil="true" />
    <quantity>250</quantity>
    <tradeValue i:nil="true" />
    <validityType>GoodTillCancel</validityType>
    <expiryDate i:nil="true" />
    <creatorID>12345</creatorID>
    <reference i:nil="true" />
    <miscellaneousTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>TAG1</d3p1:string>
      <d3p1:string>TAG2</d3p1:string>
      <d3p1:string>TAG3</d3p1:string>
    </miscellaneousTags>
    <PIN>2222</PIN>
    <CustomBrokerageFee i:nil="true" />
    <CustomBrokeragePercent i:nil="true" />
    <ClientBrokerageScheduleID i:nil="true" />
  </order>
</ArrayOforder>

Response Information

Resource Description

List of order creation results

Collection of OrderCreationResult

Name	Description	Type	Additional information
orderID	Unique order identifier.	integer	None.
reference	External reference for an order set by the submitter.	string	None.
success	Indicates if the order was created succesfully.	boolean	None.
errors	List of errors associated with the order creation request (if applicable).	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "orderID": 0,
    "reference": "YOUR_REF_1",
    "success": false,
    "errors": [
      "Not enough funds",
      "Invalid security code"
    ]
  },
  {
    "orderID": 12345,
    "reference": "YOUR_REF_2",
    "success": true,
    "errors": null
  }
]

application/xml, text/xml

Sample:

<ArrayOfOrderCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OrderCreationResult>
    <errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Not enough funds</d3p1:string>
      <d3p1:string>Invalid security code</d3p1:string>
    </errors>
    <orderID>0</orderID>
    <reference>YOUR_REF_1</reference>
    <success>false</success>
  </OrderCreationResult>
  <OrderCreationResult>
    <errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <orderID>12345</orderID>
    <reference>YOUR_REF_2</reference>
    <success>true</success>
  </OrderCreationResult>
</ArrayOfOrderCreationResult>

Error Response Information

Resource Description

List of order creation results

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>