cancel_order_m
Summary
| API Name | cancel_order_m |
|---|---|
| Class | transaction_services_m |
| Update Version | 34 |
Description
Cancels a non-subscription order (NSO) for a specified account, preventing any future billing for that order. An NSO is a one-time purchase of inventory items (as opposed to recurring subscription charges). This call succeeds only if the order has not yet been invoiced and has not already been canceled. To cancel orders that have already been billed, use void_invoice_m or issue_refund_to_acct_m instead.
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 for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
| order_no | long | 22 | Yes |
The unique identifier for an order in the context of an client_no and account_no. |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
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. |