bulk_cancel_order_m
Summary
| API Name | bulk_cancel_order_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 37 |
Description
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.
Inputs
| Name | Type | Length | Required | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||||||||||||
| Start of account_order object | ||||||||||||||||||||
| account_order | object | Yes | ||||||||||||||||||
| Name | Type | Length | Required | Description | ||||||||||||||||
| ▶bulk_input_idx | long | 8 | Yes |
Bulk input value provided to map to API responses. This will be populated in the response whether the cancellation was successful or not. |
||||||||||||||||
| ▶acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. If only the acct_no or client_acct_id is passed in with this array, all eligible orders for this account will be cancelled. Alternative required field: client_acct_id |
||||||||||||||||
| ▶client_acct_id | string | 50 | Yes |
Client-defined account identifier. If only the acct_no or client_acct_id is passed in with this array, all eligible orders for this account will be cancelled. Alternative required field: acct_no |
||||||||||||||||
| ▶order_no | long | 22 | No |
The unique identifier for an order in the context of a client_no and account_no. If both the acct_no or client_acct_id is passed in AND order_no or client_order_id is passed in with this array, only this unique eligible order for this account will be cancelled. Alternative field: client_order_id |
||||||||||||||||
| ▶client_order_id | string | 100 | No |
Client-defined order identifier. If both the acct_no or client_acct_id is passed in AND order_no or client_order_id is passed in with this array, only this unique eligible order for this account will be cancelled. Alternative field: order_no |
||||||||||||||||
| ▶master_plan_instance_no | long | 22 | No |
The unique identifier for a master plan instance in the context of a client_no and account_no. If both the acct_no or client_acct_id is passed in AND master_plan_instance_no or client_master_plan_instance_id is passed in with this array, all eligible orders for this account's master plan instance will be cancelled. Alternative field: client_master_plan_instance_id |
||||||||||||||||
| ▶client_master_plan_instance_id | string | 100 | No |
Client-defined master plan instance identifier. If both the acct_no or client_acct_id is passed in AND master_plan_instance_no or client_master_plan_instance_id is passed in with this array, all eligible orders for this account's master plan instance will be cancelled. Alternative field: master_plan_instance_no |
||||||||||||||||
| ▶order_status_directive | long | 2 | No |
Defines the eligible orders for cancellation based on status. Allowed values:
|
||||||||||||||||
| End of account_order object | ||||||||||||||||||||
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| Start of bulk_cancel_order_result object | ||||
| bulk_cancel_order_result | object | No |
Bulk cancel order results. Please note that the save/commit happens at bulk_input_idx level. |
|
| Name | Type | Length | Required | Description |
| ▶bulk_input_idx | long | No |
Bulk input value provided in API input. This will be populated whether the cancellation was successful or not. |
|
| ▶order_no | long | 22 | No |
Order number of the request if successfully cancelled. NULL indicates failure. |
| ▶client_order_id | string | No |
Client Order Identifier of the request if successfully cancelled. NULL indicates failure. |
|
| ▶bulk_error_code | long | No |
Aria-assigned error identifier. NULL indicates no error. |
|
| ▶bulk_error_msg | string | No |
Description of any error that occurred. NULL indicates no error. |
|
| End of bulk_cancel_order_result object | ||||