Home > Aria6 User Documentation > Aria6 core api > get_client_items_basic


Returns a list of inventory items associated with a client.

Note: The previously existing input and/or output fields <client_item_id>, <client_item_id_out> and/or <filter_client_item_id> were removed from this API call in Release 47.

Input Arguments

Req Field Name Field Type Max Length Description
Asterisk_0807a.jpg client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
Asterisk_0807a.jpg 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).
  filter_item_no long 8 Aria-assigned unique identifier indicating Client Inventory Item.
  filter_client_sku string 100 Client assigned SKU indicating client Inventory Item.
  include_inactive_items string 8 Specifies whether inactive inventory items need to be included or not  

Allowable values for include_inactive_items

Values Description
true Inactive inventory items will be included
false Inactive inventory items will not be included

Output Arguments

Field Name Field Type Description
items_basic hash  
brd_arrow.gif item_no long The unique ID of the item being retrieved
brd_arrow.gif item_label string The name or label for this item
brd_arrow.gif service_no long The service number associated with this item, which will be used during invoicing
brd_arrow.gif service_desc string The long description of the service associated with this item
brd_arrow.gif client_sku string The client-defined product code for this item
brd_arrow.gif item_plan long The plan associated with this item to assign when the item is purchased
brd_arrow.gif item_months long The months to stack for this item
brd_arrow.gif stock_level double The remaining number of units of this item
brd_arrow.gif avg_ratings long (DEPRECATED) The average user rating of this item
brd_arrow.gif num_ratings long (DEPRECATED) The number of total ratings for this item
brd_arrow.gif num_reviews long (DEPRECATED) The number of user reviews for this item
brd_arrow.gif item_type long The type of item, see allowable values legend 

Allowable values for item_type

Values Description
0 Inventory Item
1 Months to stack
2 Resource Item
brd_arrow.gif item_desc string The long description of the item
brd_arrow.gif active_ind long Whether or not this item is considered an active, in-stock item 

Allowable values for active_ind

Values Description
0 Inactive
1 Active
brd_arrow.gif modify_price_ind string Whether or not the item price can be modified at sale time 

Allowable values for modify_price_ind

Values Description
Y Yes
N No
brd_arrow.gif 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)
brd_arrow.gif subunit_label string The item name of the subunit represented by a single quantity of this item
brd_arrow.gif service_type string (DEPRECATED) This field is no longer used
brd_arrow.gif coa_id string The system internal Chart-of-Accounts ID for this item
brd_arrow.gif client_coa_code string The client-specified Chart-of-Accounts ID for this item
brd_arrow.gif taxable_ind long Whether or not taxes apply to this item 

Allowable values for taxable_ind

Values Description
0 taxable
1 non-taxable
brd_arrow.gif tax_group long If taxable, the tax group this item belongs to
brd_arrow.gif usage_type long (DEPRECATED) This field is no longer used, as there are no usage fees for items
brd_arrow.gif client_service_id string A multidimensional array of client-defined Service ID for this plan.
brd_arrow.gif client_item_plan_id string client-defined item plan ID the item appears on
brd_arrow.gif usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
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.
Last modified


This page has no custom tags.


This page has no classifications.