POST api/orders/cancellations

Create cancellation instructions for multiple orders.

Request Information

URI Parameters

None.

Body Parameters

List of cancellation instructions.

Name	Description	Type	Additional information
OrderID	Order ID for this amendment. Required if the order is not international.	integer	None.
CreatorID	Person ID for whom this amendment is submitted. Required if the order is international.	integer	None.
PIN	User PIN. Use if PIN validation is required.	string	None.
IsInternationalOrder	Is International Order	boolean	None.
InternationalOrderUID	International Order UID for this amendment. Required if the order is international.	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "OrderID": 12345,
    "CreatorID": 98765,
    "PIN": "1234",
    "IsInternationalOrder": false,
    "InternationalOrderUID": null
  },
  {
    "OrderID": null,
    "CreatorID": 98765,
    "PIN": "1111",
    "IsInternationalOrder": true,
    "InternationalOrderUID": "5f567532-3e42-42c4-a43f-67adac038588"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCancellationCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <CancellationCreation>
    <CreatorID>98765</CreatorID>
    <InternationalOrderUID i:nil="true" />
    <IsInternationalOrder>false</IsInternationalOrder>
    <OrderID>12345</OrderID>
    <PIN>1234</PIN>
  </CancellationCreation>
  <CancellationCreation>
    <CreatorID>98765</CreatorID>
    <InternationalOrderUID>5f567532-3e42-42c4-a43f-67adac038588</InternationalOrderUID>
    <IsInternationalOrder>true</IsInternationalOrder>
    <OrderID i:nil="true" />
    <PIN>1111</PIN>
  </CancellationCreation>
</ArrayOfCancellationCreation>

Response Information

Resource Description

List of cancellation creation results.

Collection of CancellationCreationResult

Name	Description	Type	Additional information
OrderID	Order ID the cancellation instruction was for.	integer	None.
InternationalOrderUID	InternationalOrderUID the cancellation instruction was for.	globally unique identifier	None.
Success	Status of the cancellation.	boolean	None.
Errors	List of errors if the cancellation failed.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderID": 1234,
    "InternationalOrderUID": null,
    "Success": true,
    "Errors": null
  },
  {
    "OrderID": null,
    "InternationalOrderUID": "aac89331-46c1-4ee7-9c52-b83d832c0c0e",
    "Success": true,
    "Errors": null
  },
  {
    "OrderID": 2200,
    "InternationalOrderUID": null,
    "Success": false,
    "Errors": [
      "Order is not active."
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCancellationCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <CancellationCreationResult>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <InternationalOrderUID i:nil="true" />
    <OrderID>1234</OrderID>
    <Success>true</Success>
  </CancellationCreationResult>
  <CancellationCreationResult>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <InternationalOrderUID>aac89331-46c1-4ee7-9c52-b83d832c0c0e</InternationalOrderUID>
    <OrderID i:nil="true" />
    <Success>true</Success>
  </CancellationCreationResult>
  <CancellationCreationResult>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>Order is not active.</d3p1:string>
    </Errors>
    <InternationalOrderUID i:nil="true" />
    <OrderID>2200</OrderID>
    <Success>false</Success>
  </CancellationCreationResult>
</ArrayOfCancellationCreationResult>

Error Response Information

Resource Description

List of cancellation 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>