bulk_cancel_order_m Guide

Last updated
Save as PDF

The bulk_cancel_order_m API cancels one or more account holder's order(s) and stops all billing related to the order(s) if the following are true: The order(s) has not yet been billed and the order has not already been canceled. Please note that save/commit of cancelled orders will be at the bulk_input_idx level.

API Specification:	bulk_cancel_order_m
Required Fields:	<client_no> <auth_key> <bulk_input_idx> <acct_no> or <client_acct_id>

Additional Guidance

Input Fields

Field Name

Notes

<order_status_directive>

Defines the eligible orders for cancellation based on status.

Allowable values:

Values	Description
0	All Eligible
1	Order Held
2	Order Placed
3	Order Filled
4	Order Held and Order Placed only (default)
5	Order Held and Order Filled only
6	Order Placed and Order Filled only

Error Codes:

Error Code/Description	Associated Inputs
1001: unexpected error
1004: authentication error	<auth-key>, <client_no>
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)	<acct_no>, <client_acct_id>
1016: invalid input Additional Comments: This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.	<acct_no>, <order_status_directive>
3016: could not cancel order - order already cancelled or succesffuly billed
3032: Invalid Order Number
3104: No eligible or matching orders found to cancel	<account_order>
3105: Invalid Client Order Identifier	<account_order>, <client_order_id>
14053: Invalid Master Plan Instance number	<master_plan_instance_no>
14054: Invalid client Master Plan Instance identifier	<client_master_plan_instance_id>

API Specification:

Required Fields:

Additional Guidance

Error Codes: