get_client_items_basic_m
Summary
| API Name | get_client_items_basic_m |
|---|---|
| Class | system_services_m |
| Update Version | 47 |
Description
Returns a list of inventory items associated with a client.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| filter_currency_cd | string | 3 | No |
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 | No |
Note: This field is deprecated. Aria no longer supports return_no_cost_items. |
||||||
| filter_item_no | long | 8 | No |
Aria-assigned unique identifier indicating Client Inventory Item. Alternative field: filter_client_sku |
||||||
| include_inactive_items | string | 8 | No |
Specifies whether inactive inventory items need to be included or not Allowed values:
|
||||||
| filter_client_item_id | string | 100 | No |
Note: This field is deprecated. Aria no longer supports filter_client_item_id. |
||||||
| purchase_scope | long | 8 | No |
Purchase scope for inventory item, default is null (both 0 and 1) Allowed values:
|
||||||
| filter_client_sku | string | 100 | No |
The client defined SKU for this item Alternative field: filter_item_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| items_basic_details | object | No | ||
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
items_basic_details fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| item_no | long | No |
The unique ID of the item being retrieved |
|||||||||
| item_label | string | No |
The name or label for this item |
|||||||||
| service_no | long | No |
The service number associated with this item, which will be used during invoicing |
|||||||||
| service_desc | string | No |
The long description of the service associated with this item |
|||||||||
| client_sku | string | No | ||||||||||
| item_plan | long | No |
The plan associated with this item to assign when the item is purchased |
|||||||||
| item_months | long | No |
The months to stack for this item |
|||||||||
| stock_level | double | No |
The remaining number of units of this item |
|||||||||
| avg_ratings | long | No |
(DEPRECATED) The average user rating of this item |
|||||||||
| num_ratings | long | No |
(DEPRECATED) The number of total ratings for this item |
|||||||||
| num_reviews | long | No |
(DEPRECATED) The number of user reviews for this item |
|||||||||
| item_type | long | No |
The type of item, see allowable values legend Allowed values:
|
|||||||||
| item_desc | string | No |
The long description of the item |
|||||||||
| active_ind | long | No |
Whether or not this item is considered an active, in-stock item Allowed values:
|
|||||||||
| modify_price_ind | string | No |
Whether or not the item price can be modified at sale time Allowed values:
|
|||||||||
| subunit_qty | double | No |
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 | No |
The item name of the subunit represented by a single quantity of this item |
|||||||||
| service_type | string | No |
(DEPRECATED) This field is no longer used |
|||||||||
| coa_id | string | No |
The system internal Chart-of-Accounts ID for this item |
|||||||||
| client_coa_code | string | No |
The client-specified Chart-of-Accounts ID for this item |
|||||||||
| taxable_ind | long | No |
Whether or not taxes apply to this item Allowed values:
|
|||||||||
| tax_group | long | No |
If taxable, the tax group this item belongs to |
|||||||||
| usage_type | long | No |
(DEPRECATED) This field is no longer used, as there are no usage fees for items |
|||||||||
| client_item_id | string | 100 | No |
Note: This field is deprecated. Aria no longer supports client_item_id. |
||||||||
| client_service_id | string | 100 | No |
A multidimensional array of client-defined Service ID for this plan. |
||||||||
| client_item_plan_id | string | 100 | No |
client-defined item plan ID the item appears on |
||||||||
| usage_type_cd | string | 100 | No |
An array containing usage_type_cd(s) to denote which usage type(s) to record. |
||||||||
| purchase_scope | long | No |
Purchase scope for inventory item, default is null (both 0 and 1) Allowed values:
|