Home > Aria Crescendo Documentation > Aria Crescendo core api > get_client_items_basic_m
get_client_items_basic_m
get_client_items_basic_m
Returns a list of inventory items associated with a client.
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. |
| filter_currency_cd | string | 3 | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | |
| return_no_cost_items | string | 5 | A boolean value that asserts the API call should include no-cost items in its returned results (true/1=yes, false/0=no). (DEPRECATED) | |
| filter_item_no | long | 8 | Aria-assigned unique identifier indicating Client Inventory Item. | |
| OR | ||||
| filter_client_item_id | string | 100 | Client assigned unique identifier indicating client Inventory Item. | |
| include_inactive_items | string | 8 | Specifies whether inactive inventory items need to be included or not Allowable Values | |
| purchase_scope | long | 8 | Purchase scope for inventory item, default is null (both 0 and 1) Allowable Values |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| items_basic_details | hash | |
 item_no |
long | The unique ID of the item being retrieved |
| item_label |
string | The name or label for this item |
| service_no |
long | The service number associated with this item, which will be used during invoicing |
| service_desc |
string | The long description of the service associated with this item |
| client_sku |
string | Client SKU of the NSO/Inventory item. |
| item_plan |
long | The plan associated with this item to assign when the item is purchased |
| item_months |
long | The months to stack for this item |
| stock_level |
double | The remaining number of units of this item |
| avg_ratings |
long | (DEPRECATED) The average user rating of this item |
| num_ratings |
long | (DEPRECATED) The number of total ratings for this item |
| num_reviews |
long | (DEPRECATED) The number of user reviews for this item |
| item_type |
long | The type of item, see allowable values legend Allowable Values |
| item_desc |
string | The long description of the item |
| active_ind |
long | Whether or not this item is considered an active, in-stock item Allowable Values |
| modify_price_ind |
string | Whether or not the item price can be modified at sale time Allowable Values |
| subunit_qty |
double | Allows the client to associate a quantity of an arbitrary virtual item which is associated with a single unit of this item (e.g. 500 gold pieces) |
| subunit_label |
string | The item name of the subunit represented by a single quantity of this item |
| service_type |
string | (DEPRECATED) This field is no longer used |
| coa_id |
string | The system internal Chart-of-Accounts ID for this item |
| client_coa_code |
string | The client-specified Chart-of-Accounts ID for this item |
| taxable_ind |
long | Whether or not taxes apply to this item Allowable Values |
| tax_group |
long | If taxable, the tax group this item belongs to |
| usage_type |
long | (DEPRECATED) This field is no longer used, as there are no usage fees for items |
| client_item_id |
string | The client-defined item ID to search for images |
| client_service_id |
string | A multidimensional array of client-defined Service ID for this plan. |
| client_item_plan_id |
string | client-defined item plan ID the item appears on |
| usage_type_cd |
string | An array containing usage_type_cd(s) to denote which usage type(s) to record. |
| purchase_scope |
long | Purchase scope for inventory item, default is null (both 0 and 1) Allowable Values |
| 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. |
- © Copyright 2022 Aria Developer Central