Home > Aria6 User Documentation > Aria6 admintools api > get_inventory_item_details
get_inventory_item_details
get_inventory_item_details
Returns details of specified inventory item
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. |
| item_no | int | Specifies the Inventory item number | |
| OR | ||||
| client_item_id | string | 100 | Client defined unique identifier | |
| currency_cd | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
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. |
| item_no | int | Specifies the Inventory item number |
| client_item_id | string | Client defined unique identifier |
| item_type | int | Item Type for the inventory item. Valid values are: 0 - Inventory Item, 1 - Months To Stack(deprecated), 2 - Resource Item |
| item_name | string | Specifies the inventory item name |
| item_desc | string | Specifies description of Inventory item |
| active_ind | int | Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active |
| service_no | int | Specifies Service number for the Inventory item |
| client_service_id | string | Client defined unique identifier |
| invoice_advancement_months | int | Specifies months of invoice advancement for the Inventory item |
| plan_no | int | Specifies Master Plan number for the Inventory item |
| client_plan_id | string | Client defined unique identifier |
| client_sku | string | SKU specified by client for the inventory item |
| modify_price_ind | string | Specifies if CSR's may modify Inventory item price. Valid values are: Y - Yes and N - No |
| subunit_qty | float | Subunit Quantity |
| subunit_label | string | Subunit Label |
| days_to_expiry | int | Specifies the number of days to expiration for resources on this SKU |
| resources | hash | |
 resource_type_no | int | The assigned identifier for a resource |
| resource_units | int | Number of units of resource |
| days_to_expiry | int | Specifies the number of days to expiration for resources on this SKU. If item_type=2 then this field is required |
| resource_name | string | The name of the resource referenced in resource_type_no |
| pricing | hash | |
| currency_cd | string | Specifies the currency code of Inventory item |
| price | float | Specifies the price of Inventory item |
| price_per_unit | float | Specifies sub unit price. This will be null if item type is not 0 or if item type is 0 but subunit_qty is not specified |
| stock_level | float | |
| image | hash | |
| thumbnail_image_url | string | Specifies the url for the thumbnail version of the image. |
| image_text | string | Specifies text about the image. |
| default_ind | int | Specifies whether the image is default or not. Allowed values are 1 - default and 0- non default. |
| image_class_seq_no | int | Specifies Aria generated sequence number for the image. |
| active | int | Specifies whether the image is active or not. |
| main_image_url | string | Specifies the url for the main image. |
| item_class | int | Specifies which class the inventory item belongs to. |
| supplemental_obj_fields | hash | |
| field_no | int | the field no |
| field_value | string | the field value |
| field_name | string | the field name |
| schedule | hash | |
| schedule_name | string | Name for the rate schedule. |
| currency_cd | string | Currency for the schedule. |
| client_rate_schedule_id | string | Client defined unique id |
| is_default | int | This flag denotes if this rate schedule is the default one for currency of the schedule. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0. Allowable Values |
| tax_inclusive_rate | string | This flag denotes if this rate is inclusive of the taxes. Allowable Values |
| tier | hash | |
| from | int | Tiered pricing rule that specifies “from” units. |
| to | int | Tiered pricing rule that specifies “to” units. |
| description | string | This field is used to display custom rate tier description. |
| amount | float | Tiered pricing rule that specifies rate per unit. |
- © Copyright 2021 Aria Developer Central