Home > Aria Crescendo Documentation > Aria Crescendo admintools api > get_inventory_item_details_m

get_inventory_item_details_m

Returns details of specified inventory item

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.
item_no int   Specifies the Inventory item number
  OR      
  client_sku string array 100 Client SKU of the NSO/Inventory item
  currency_cd string    
  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:

Values Description
true Translated fields will be fetched in all the locales defined.
false Translation information will not be fetched.
 

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
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
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
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  
brd_arrow.gif resource_type_no int The assigned identifier for a resource
brd_arrow.gif resource_units int Number of units of resource
brd_arrow.gif 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
brd_arrow.gif resource_name string The name of the resource referenced in resource_type_no
pricing hash  
brd_arrow.gif currency_cd string Specifies the currency code of Inventory item
brd_arrow.gif price float Specifies the price of Inventory item
brd_arrow.gif 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  
brd_arrow.gif thumbnail_image_url string Specifies the url for the thumbnail version of the image.
brd_arrow.gif image_text string Specifies text about the image.
brd_arrow.gif default_ind int Specifies whether the image is default or not. Allowed values are 1 - default and 0- non default.
brd_arrow.gif image_class_seq_no int Specifies Aria generated sequence number for the image.
brd_arrow.gif active int Specifies whether the image is active or not.
brd_arrow.gif 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  
brd_arrow.gif field_no int the field no
brd_arrow.gif field_value string the field value
brd_arrow.gif field_name string the field name
item_translations hash Array that contains all the translated values for a given locale.
brd_arrow.gif locale_name string Name of the locale.
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif item_no long Specifies the Inventory item number
brd_arrow.gif item_name string Specifies the inventory item name
brd_arrow.gif item_desc string Specifies description of Inventory item
schedule array This array contains the rate schedule information
brd_arrow.gifschedule_name string Name for the rate schedule to be created. Translatable.
brd_arrow.gifclient_rate_schedule_id string Client-defined unique identifier.
brd_arrow.gifcurrency_cd string Currency for the schedules to be created.
brd_arrow.gifis_default boolean This flag denotes if this rate schedule is the default one for this plan. 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.
tax_inclusive_rate string This flag denotes if this rate is inclusive of the taxes.

Allowable values for tax_inclusive_rate:

Values Description
0 Tax exclusive
1 Tax inclusive
tier array This array contains tiered pricing information for the given rate schedule.
brd_arrow.gifrate_schedule_name string Name of rate schedule this tier belongs to.
brd_arrow.gifclient_rate_schedule_id string Client-defined unique identifier for the rate schedule.
brd_arrow.gifamount float Tiered pricing rule that specifies rate per unit.
brd_arrow.giffrom int Tiered pricing rule that specifies "from" units.
brd_arrow.gifto int Tiered pricing rule that specifies to units.
brd_arrow.gifdescription string This field is used to display custom rate tier description. This will override the rate tier's description at service level.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®