Home > Aria Crescendo Documentation > Aria Crescendo object query api > get_order_details_m
get_order_details_m
get_order_details_m
Table of contents
Gets order details for all accounts matching specified query
Input Arguments
| 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. |
|
query_string | string | 1000 | The criteria which all returned objects must match. Different objects have a different set of searchable criteria.Fields marked with "*Query" in the returns section can be used as part of the query_string. Valid operations for the query string include "=", "!=", "<", "<=", ">=", ">", "IS NULL", "IS NOT NULL", "LIKE", and "NOT LIKE". You must leave a space before and after each operation. The first operand must always be a field name, and the second operand must always be a value (except for "IS NULL" and "IS NOT NULL", where the second operand is implicitly "NULL"). If the second operand contains a space, less than, greater than, or equals sign, then it must be enclosed in double quotes. The second operand may not contain double quotes. Multiple conditions must be joined with either "AND" or "OR". Additionally, any queryable field can also be used to order the results, by appending "ORDER BY" to the query, followed by a field name and either "ASC" or "DESC". |
| username | string | 30 | DeprecatedThe login name of the user making this request. It is the same name that is used to log in to the Aria Administration and Configuration Tool. | |
| password | string | 1000 | DeprecatedThe password of the user making this request. It is the same password that is used to log in to the Aria Administration and Configuration Tool. | |
| limit | long | 12 | The maximum number of objects to be returned by this call. Note that Aria recommends a maximum limit of less than 1,000. Higher limits may take much longer to return data. If you do not specify a value, or specify a value of "0", this field defaults to 100. Specifying a value of "-1" returns a count of the number of matching records, but does not return any records. | |
| offset | long | 12 | The number of records to skip. Note that both "0" and NULL will cause the interface not to skip any records. |
Querystring Keys
| Key Name | Description |
|---|---|
| order_no | The Aria assigned ID of the order |
| acct_no | The Aria assigned ID of the account |
| user_id | The client defined user_id for the account |
| invoice_no | The Aria assigned ID of the invoice on which this order appears |
| amount | Monetary value of the order |
| last_updated | Most recent date on which the order was updated |
| order_status | Status code associated with the order |
| po_num | Purchase Order Number for this order. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error |
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
| starting_record | long | This indicates the number of objects that were (or would be) skipped before beginning output. |
| total_records | long | This is the total number of objects that matched the provided criteria. |
| order_details | hash | Detailed order information for any accounts matching the query |
 order_no |
long | The Aria assigned ID of the order |
| acct_no |
long | The Aria assigned ID of the account |
| user_id |
string | The client defined user_id for the account |
| invoice_no |
string | The Aria assigned ID of the invoice on which this order appears |
| create_date |
string | The date on which the order was created |
| amount |
double | Monetary value of the order |
| currency_cd |
string | The 3-character ISO-compliant currency code for the monetary value of the order |
| last_updated |
string | Most recent date on which the order was updated |
| order_status |
string | Status code associated with the order |
| po_num |
string | Purchase order number for this order. |
| fulfilled_date |
string |
Date on which the order is fulfilled. This can be a past, present, or future date. |
| order_item |
hash | List of details associated with the order line item(s) |
| sku |
string | Client-defined SKU (stock keeping unit) identifier for an inventory item |
| description |
string | Description of an inventory item |
| units |
double | Number of units of an inventory item in the order |
| unit_price |
double | Price of each inventory item in the order |
| subtotal |
double | Total cost for the quantity of each inventory item purchased: units x unit_price |
- © Copyright 2022 Aria Developer Central