GET api/bfg/v1/orders/{orderId}
Gets a single client order (<c>SH_GetClientOrderByOrderId</c>).
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
OrderResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderID | integer |
None. |
|
| DomesticFacilityID | integer |
None. |
|
| SecurityCode | string |
None. |
|
| Exchange | byte |
None. |
|
| CurrencyCode | string |
None. |
|
| BuySell | byte |
None. |
|
| Quantity | integer |
None. |
|
| QuantityBooked | integer |
None. |
|
| QuantityFilled | integer |
None. |
|
| Status | integer |
None. |
|
| DateTimeCreated | date |
None. |
|
| VWAP | decimal number |
None. |
|
| PriceType | byte |
None. |
|
| Price | decimal number |
None. |
|
| TotalCost | decimal number |
None. |
|
| Brokerage | decimal number |
None. |
|
| CreatorName | string |
None. |
|
| ExpiryDate | date |
None. |
|
| DateTimeCompleted | date |
None. |
|
| NotesForClient | string |
None. |
|
| OrderGiver | string |
None. |
|
| ContractNoteIds | string |
None. |
|
| LastAmendmentType | byte |
None. |
Response Formats
application/json, text/json
Sample:
{
"OrderID": 1,
"DomesticFacilityID": 2,
"SecurityCode": "sample string 3",
"Exchange": 64,
"CurrencyCode": "sample string 5",
"BuySell": 64,
"Quantity": 7,
"QuantityBooked": 8,
"QuantityFilled": 9,
"Status": 10,
"DateTimeCreated": "2026-11-17T11:17:40.2298219+11:00",
"VWAP": 1.0,
"PriceType": 64,
"Price": 1.0,
"TotalCost": 1.0,
"Brokerage": 1.0,
"CreatorName": "sample string 13",
"ExpiryDate": "2026-11-17T11:17:40.2298219+11:00",
"DateTimeCompleted": "2026-11-17T11:17:40.2298219+11:00",
"NotesForClient": "sample string 14",
"OrderGiver": "sample string 15",
"ContractNoteIds": "sample string 16",
"LastAmendmentType": 64
}
application/xml, text/xml
Sample:
<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order"> <Brokerage>1</Brokerage> <BuySell>64</BuySell> <ContractNoteIds>sample string 16</ContractNoteIds> <CreatorName>sample string 13</CreatorName> <CurrencyCode>sample string 5</CurrencyCode> <DateTimeCompleted>2026-11-17T11:17:40.2298219+11:00</DateTimeCompleted> <DateTimeCreated>2026-11-17T11:17:40.2298219+11:00</DateTimeCreated> <DomesticFacilityID>2</DomesticFacilityID> <Exchange>64</Exchange> <ExpiryDate>2026-11-17T11:17:40.2298219+11:00</ExpiryDate> <LastAmendmentType>64</LastAmendmentType> <NotesForClient>sample string 14</NotesForClient> <OrderGiver>sample string 15</OrderGiver> <OrderID>1</OrderID> <Price>1</Price> <PriceType>64</PriceType> <Quantity>7</Quantity> <QuantityBooked>8</QuantityBooked> <QuantityFilled>9</QuantityFilled> <SecurityCode>sample string 3</SecurityCode> <Status>10</Status> <TotalCost>1</TotalCost> <VWAP>1</VWAP> </OrderResponse>