get_inventory_items_m
Summary
| API Name | get_inventory_items_m |
|---|---|
| Class | administration_services_m |
| Update Version | 6.38 |
Description
Returns list of inventory items created for client
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||
| include_translations | string | 5 | No |
Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowed values:
|
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error |
|
| error_msg | string | No |
Textual description of any error that occurred. "OK" if there was no error. |
|
| inventory_items | object | No |
The inventory_items associated with this method. |
inventory_items.installment_terms fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| installment_term_no | long | No |
Aria-assigned unique identifier for client installment term |
|
| client_installment_term_id | string | No |
Specifies client installment term id |
|
| installment_term_name | string | 100 | No |
Specifies installment term name |
| is_default | int | 1 | No |
The value of 1 is defaulted for the first installment term denoting it is the default. For subsequent installment terms, the default is set to 0. Alternate boolean values are accepted. |
inventory_items.item_translations fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
| item_no | long | 100 | Yes |
Aria-assigned unique inventory item number |
| item_name | string | 100 | Yes |
Specifies the inventory item name |
inventory_items fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| item_no | long | 100 | Yes |
Aria-assigned unique inventory item number |
| item_name | string | 100 | Yes |
Specifies the inventory item name |
| item_type | int | 1 | Yes |
Item Type for the inventory item. Valid values are: 0 - Inventory Item, 1 - Months To Stack, 2 - Resource Item, 3 - Fee |
| client_sku | string | 30 | Yes |
SKU specified by client for the inventory item |
| active_ind | int | 1 | Yes |
Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active |
| purchase_scope | int | 1 | No |
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 | No | ||
| client_item_id | string | 100 | No |
Client defined unique identifier Note: This field was deprecated in version 43. |
| installment_terms | object | No |
The installment_terms associated with this method. |
|
| item_translations | object | No |
Array that contains all the translated values for a given locale. |