Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
![]() |
standing_order_no | long | 8 | Unique ID for this standing order. |
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |
order | hash | An array containing related order history records. |
![]() |
long | Order number for this history record |
![]() |
double | Monetary amount for this order. |
![]() |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
![]() |
string | Status of this order |
![]() |
long | The unique identifier of a given invoice. |
![]() |
string | Date the order was created |
![]() |
string | Date the order was modified |
![]() |
string | Comments about this order. |
![]() |
string | Client-defined order ID |
![]() |
long | Unique transaction ID for this order |
![]() |
string | The client-defined receipt ID given at the creation of this order |
![]() |
string | The client-defined receipt ID given at the modification of this order |
![]() |
string | Alternate contact details for orders. |