Home > Aria Crescendo Documentation > Aria Crescendo admintools api > get_inventory_items_m
get_inventory_items_m
get_inventory_items_m
Returns list of inventory items created for 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 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
 |
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. | ||||||
| locale_no | int | 38 | Aria-assigned unique identifier of the locale used for translations. | |||||||
| OR | ||||||||||
| locale_name | string | 32 | Name of the locale to which the translations belong. | |||||||
| include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.
Allowable values for include_translations:
|
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error |
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. |
| inventory_items | hash | |
 item_no |
int | Aria-assigned unique inventory item number |
| item_name |
string | Specifies the inventory item name |
| item_type |
int | Item Type for the inventory item. Valid values are: 0 - Inventory Item, 1 - Months To Stack, 2 - Resource Item |
| client_sku |
string | SKU specified by client for the inventory item |
| active_ind |
int | Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active |
| purchase_scope |
int | Specifies purchase scope for inventory item. Valid values are: 0 - No purchase restrictions and 1 - Can be purchased with qualifying plans only |
| stock_level |
float | |
| item_translations |
hash | Array that contains all the translated values for a given locale. |
| locale_name |
string | Name of the locale |
| locale_no |
int | Aria-assigned unique identifier of the locale used for translations. |
| item_no |
long | Aria-assigned unique inventory item number |
| item_name |
string | Specifies the inventory item name |
- © Copyright 2023 Aria Developer Central