Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo admintools api > update_inventory_item_m

update_inventory_item_m

Update an existing 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 8 Specifies the Inventory item number
OR
client_item_id string 100 Specifies Client defined unique id for the item
item_type int 1 Item Type for the inventory item. Valid values are: 0 - Inventory Item, 1 - Months To Stack (Deprecated), 2 - Resource Item
item_name string 100 Specifies the inventory item name. Translatable.
item_desc string 300 Specifies description of Inventory item. Translatable.
service_no int 8 Specifies Service number for the Inventory item
OR
client_service_id string 100 Specifies Client defined unique id for the service
service array
service_no int 8 Specifies Service number for the Inventory item
OR
client_service_id string 100 Specifies Client defined unique id for the service
name string 100 Specifies Service name for the Inventory item
gl_cd string 30 Specified chart of access code
taxable int 1 Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable.
tax_group int 8 Specifies tax group associated with service. This will be null if taxable_ind is set to 0. If taxable_ind is 1 then this field is required
commodity_cd string 20 Commodity Code
price float array 11 This attribute is not in use. It is just a placeholder.
client_sku string 30 SKU specified by client for the inventory item
currency_cd string Specifies the currency code for Inventory item. It is case insensitive ( ex. both usd and USD will work ) REST input arrays are "|" separated lists of a single data type
item_price string 12 Specifies the price for Inventory item for currencies.. REST input arrays are "|" separated lists of a single data type Count of value passed for the 'price_per_unit' parameter should be the same as 'currency_cd'.
active_ind int 1 Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active
purchase_scope int 1 Specifies purchase scope for inventory item. Valid values are: 0 - No purchase restrictions and 1 - Can be purchased with qualifying plans only
tax_inclusive_ind string 1 This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates. REST input arrays are "|" separated lists of a single data type Count of value passed for the 'tax_inclusive_ind' parameter should be the same as 'currency_cd'.
modify_price_ind string 1 Specifies if CSR's may modify Inventory item price. Valid values are: Y - Yes and N - No
subunit_qty int 12 Subunit Quantity If item_type=0 and subunit_label is not null then this field is required
subunit_label string 100 Subunit Label If item_type=0 and quantity_per_item is not null then this field is required. Translatable.
queued_active_ind int 1 Specifies whether to queue the activation or not. Valid values are 0 - No, 1- Yes
queued_active_date string 10 Specifies date to activate or deactivate the item
do_auto_create_service_credit int 1 Specifies whether to automatically create service credit or not. Valid values are 0 - No, 1- Yes
days_to_expiry int 3 Specifies the number of days to expiration for resources on this SKU
resource_type_no string The assigned identifier for a resource. This should not be null if item_type = 2 REST input arrays are "|" separated lists of a single data type
resource_units string Number of units of resource. This should not be null if item_type = 2 REST input arrays are "|" separated lists of a single data type
stock_level_track int Specifies whether the stock level can be adjusted or not. Allowed values are 1 or 0
stock_level_adjust float Specifies the number to adjust the stock level with
image array
default_image_url string 1000 Specifies the main image url for the image
thumbnail_image_url string 1000 Specifies the thumbnail url for the image
image_text string 50 Specifies the description of the image
default_ind int 1 Specifies whether this is the default image or not
active int 1 Specifies whether this image is active or not
parent_class int array 8 Specifies the parent class this class belongs to
supplemental_obj_field array Specifies the supplemental object fields to be added for this item
field_no int 100 the field no
OR
field_name string 100 the field name
field_value string array the field value
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.
allow_service_credits string 1 Y / N. Determines whether or not the inventory item can consume service credits. Null value = yes.

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

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.