| items_basic |
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 |
The client-defined product code for this 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 for item_type
| Values |
Description |
| 0 |
Inventory Item |
| 1 |
Months to stack |
| 2 |
Resource Item |
|
| 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 for active_ind
| Values |
Description |
| 0 |
Inactive |
| 1 |
Active |
|
| 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 |
|
| 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 for taxable_ind
| Values |
Description |
| 0 |
taxable |
| 1 |
non-taxable |
|
| 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_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. |
| 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. |
