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 |
Field Name | Field Type | Description |
---|---|---|
items_basic_details | hash | |
![]() |
long | The unique ID of the item being retrieved |
![]() |
string | The name or label for this item |
![]() |
long | The service number associated with this item, which will be used during invoicing |
![]() |
string | The long description of the service associated with this item |
![]() |
string | Client SKU of the NSO/Inventory item. |
![]() |
long | The plan associated with this item to assign when the item is purchased |
![]() |
long | The months to stack for this item |
![]() |
double | The remaining number of units of this item |
![]() |
long | (DEPRECATED) The average user rating of this item |
![]() |
long | (DEPRECATED) The number of total ratings for this item |
![]() |
long | (DEPRECATED) The number of user reviews for this item |
![]() |
long | The type of item, see allowable values legend Allowable Values |
![]() |
string | The long description of the item |
![]() |
long | Whether or not this item is considered an active, in-stock item Allowable Values |
![]() |
string | Whether or not the item price can be modified at sale time Allowable Values |
![]() |
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) |
![]() |
string | The item name of the subunit represented by a single quantity of this item |
![]() |
string | (DEPRECATED) This field is no longer used |
![]() |
string | The system internal Chart-of-Accounts ID for this item |
![]() |
string | The client-specified Chart-of-Accounts ID for this item |
![]() |
long | Whether or not taxes apply to this item Allowable Values |
![]() |
long | If taxable, the tax group this item belongs to |
![]() |
long | (DEPRECATED) This field is no longer used, as there are no usage fees for items |
![]() |
string | The client-defined item ID to search for images |
![]() |
string | A multidimensional array of client-defined Service ID for this plan. |
![]() |
string | client-defined item plan ID the item appears on |
![]() |
string | An array containing usage_type_cd(s) to denote which usage type(s) to record. |
![]() |
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. |