GET api/bfg/v1/orders/{orderID}/amendments
Create an order amendment or cancellation for the specified order.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| orderID |
Order ID to amend or cancel. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
<see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Order.CreateOrderAmendmentResult" /> with common result fields always populated. <see cref="P:TPP.B2B.Webservices2.Contracts2.BFG.Order.CreateOrderAmendmentResult.Amendment" /> is set only for amendment requests.
Collection of OrderAmendmentResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderAmendmentID | integer |
None. |
|
| OrderID | integer |
None. |
|
| AmendmentType | byte |
None. |
|
| PriceType | byte |
None. |
|
| Price | decimal number |
None. |
|
| ExpiryDate | date |
None. |
|
| Quantity | integer |
None. |
|
| DateTimeCreated | date |
None. |
|
| DateTimeCompleted | date |
None. |
|
| DateTimeAuthorised | date |
None. |
|
| NotesForOperator | string |
None. |
|
| NotesForClient | string |
None. |
|
| RejectionReason | string |
None. |
|
| DateTimeRequested | date |
None. |
|
| SecurityCode | string |
None. |
|
| BuySell | byte |
None. |
|
| CreatorName | string |
None. |
|
| TakerName | string |
None. |
|
| AuthoriserName | string |
None. |
|
| AuthoriserNotes | string |
None. |
|
| OrderAmendStatus | byte |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"OrderAmendmentID": 1,
"OrderID": 2,
"AmendmentType": 64,
"PriceType": 64,
"Price": 1.0,
"ExpiryDate": "2026-11-17T11:17:45.1158302+11:00",
"Quantity": 4,
"DateTimeCreated": "2026-11-17T11:17:45.1158302+11:00",
"DateTimeCompleted": "2026-11-17T11:17:45.1158302+11:00",
"DateTimeAuthorised": "2026-11-17T11:17:45.1158302+11:00",
"NotesForOperator": "sample string 6",
"NotesForClient": "sample string 7",
"RejectionReason": "sample string 8",
"DateTimeRequested": "2026-11-17T11:17:45.1158302+11:00",
"SecurityCode": "sample string 9",
"BuySell": 64,
"CreatorName": "sample string 11",
"TakerName": "sample string 12",
"AuthoriserName": "sample string 13",
"AuthoriserNotes": "sample string 14",
"OrderAmendStatus": 64
},
{
"OrderAmendmentID": 1,
"OrderID": 2,
"AmendmentType": 64,
"PriceType": 64,
"Price": 1.0,
"ExpiryDate": "2026-11-17T11:17:45.1158302+11:00",
"Quantity": 4,
"DateTimeCreated": "2026-11-17T11:17:45.1158302+11:00",
"DateTimeCompleted": "2026-11-17T11:17:45.1158302+11:00",
"DateTimeAuthorised": "2026-11-17T11:17:45.1158302+11:00",
"NotesForOperator": "sample string 6",
"NotesForClient": "sample string 7",
"RejectionReason": "sample string 8",
"DateTimeRequested": "2026-11-17T11:17:45.1158302+11:00",
"SecurityCode": "sample string 9",
"BuySell": 64,
"CreatorName": "sample string 11",
"TakerName": "sample string 12",
"AuthoriserName": "sample string 13",
"AuthoriserNotes": "sample string 14",
"OrderAmendStatus": 64
}
]
application/xml, text/xml
Sample:
<ArrayOfOrderAmendmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
<OrderAmendmentResponse>
<AmendmentType>64</AmendmentType>
<AuthoriserName>sample string 13</AuthoriserName>
<AuthoriserNotes>sample string 14</AuthoriserNotes>
<BuySell>64</BuySell>
<CreatorName>sample string 11</CreatorName>
<DateTimeAuthorised>2026-11-17T11:17:45.1158302+11:00</DateTimeAuthorised>
<DateTimeCompleted>2026-11-17T11:17:45.1158302+11:00</DateTimeCompleted>
<DateTimeCreated>2026-11-17T11:17:45.1158302+11:00</DateTimeCreated>
<DateTimeRequested>2026-11-17T11:17:45.1158302+11:00</DateTimeRequested>
<ExpiryDate>2026-11-17T11:17:45.1158302+11:00</ExpiryDate>
<NotesForClient>sample string 7</NotesForClient>
<NotesForOperator>sample string 6</NotesForOperator>
<OrderAmendStatus>64</OrderAmendStatus>
<OrderAmendmentID>1</OrderAmendmentID>
<OrderID>2</OrderID>
<Price>1</Price>
<PriceType>64</PriceType>
<Quantity>4</Quantity>
<RejectionReason>sample string 8</RejectionReason>
<SecurityCode>sample string 9</SecurityCode>
<TakerName>sample string 12</TakerName>
</OrderAmendmentResponse>
<OrderAmendmentResponse>
<AmendmentType>64</AmendmentType>
<AuthoriserName>sample string 13</AuthoriserName>
<AuthoriserNotes>sample string 14</AuthoriserNotes>
<BuySell>64</BuySell>
<CreatorName>sample string 11</CreatorName>
<DateTimeAuthorised>2026-11-17T11:17:45.1158302+11:00</DateTimeAuthorised>
<DateTimeCompleted>2026-11-17T11:17:45.1158302+11:00</DateTimeCompleted>
<DateTimeCreated>2026-11-17T11:17:45.1158302+11:00</DateTimeCreated>
<DateTimeRequested>2026-11-17T11:17:45.1158302+11:00</DateTimeRequested>
<ExpiryDate>2026-11-17T11:17:45.1158302+11:00</ExpiryDate>
<NotesForClient>sample string 7</NotesForClient>
<NotesForOperator>sample string 6</NotesForOperator>
<OrderAmendStatus>64</OrderAmendStatus>
<OrderAmendmentID>1</OrderAmendmentID>
<OrderID>2</OrderID>
<Price>1</Price>
<PriceType>64</PriceType>
<Quantity>4</Quantity>
<RejectionReason>sample string 8</RejectionReason>
<SecurityCode>sample string 9</SecurityCode>
<TakerName>sample string 12</TakerName>
</OrderAmendmentResponse>
</ArrayOfOrderAmendmentResponse>