update_inventory_item_m

Last updated
Save as PDF

Update an existing 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

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

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

existing_client_sku

string array

100

Client SKU of the NSO/Inventory Item

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

100

Specifies the inventory item name. Translatable.

item_desc

string

300

Specifies description of Inventory item. Translatable.

service_no

int

Specifies Service number for the Inventory item

client_service_id

string

100

Specifies Client defined unique id for the service

service

array

service_no

int

Specifies Service number for the Inventory item

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

Specified chart of access code

taxable

int

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

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

Commodity Code

price

float array

This attribute is not in use. It is just a placeholder.

client_sku

string

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 )

item_price

string

Specifies the price for Inventory item for currencies. Count of value passed for the 'price_per_unit' parameter should be the same as 'currency_cd'.

active_ind

int

Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active

schedule

array

This array contains the rate schedule information.

schedule_no

string

100

Specifies the schedule number whose details is going to be edited. This can be nullable for new services.REST input arrays should passed in the following format: schedule[0][schedule_no]=1212121&schedule[1][schedule_no]=4234232 etc where schedule[0] specifies first schedule and schedule[1] specifies the second schedule and so on. <br/>Note: If a rate schedule has been used on an inventory item, then it cannot be deleted. If no price has been provided for a currency in a rate schedule, then the corresponding rate schedule is automatically deleted.

schedule_name

Name for the rate schedule to be created. Translatable.

client_rate_schedule_id

Client-defined unique identifier.

currency_cd

Currency for the schedules to be created.

is_default

Denotes whether this rate schedule is the default 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

This flag denotes if this rate is inclusive of the taxes. 1 is tax inclusive and 0 is tax exclusive. If not passed, the value is set to 0 (tax exclusive).

tier

This array contains tiered pricing information for the given rate schedule.

amount

Tiered pricing rule that specifies rate per unit.

from

Tiered pricing rule that specifies “from” units.

Tiered pricing rule that specifies “to” units.

description

This field is used to display custom rate tier description. This will override the rate tier's description at service level.

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

tax_inclusive_ind

string

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. Count of value passed for the 'tax_inclusive_ind' parameter should be the same as 'currency_cd'.

modify_price_ind

string

Specifies if CSR's may modify Inventory item price. Valid values are: Y - Yes and N - No

subunit_qty

int

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.

pricing_rule

int

Specifies the pricing rule of the tier calculations.

Allowable values for pricing_rule:

Values	Description
1	Standard
2	Volume Discount
3	Flat Rate Per Tier

queued_active_ind

int

Specifies whether to queue the activation or not. Valid values are 0 - No, 1- Yes

queued_active_date

string

Specifies date to activate or deactivate the item

do_auto_create_service_credit

int

Specifies whether to automatically create service credit or not. Valid values are 0 - No, 1- Yes

days_to_expiry

int

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

resource_units

string

Number of units of resource. This should not be null if item_type = 2

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

Specifies the description of the image

default_ind

int

Specifies whether this is the default image or not

active

int

Specifies whether this image is active or not

parent_class

int array

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

field_name

string

100

the field name

field_value

string array

the field value

edit_directive

int

A directive that indicates the action to be taken. This new parameter applies to the schedule in the API.

Allowable values for edit_directive:

Values	Description
1	Delete data that is not passed in the request
2	Insert or update data passed but DO NOT delete
3	Delete everything that is passed

locale_no

int

Aria-assigned unique identifier of the locale used for translations.

locale_name

string

Name of the locale to which the translations belong.

allow_service_credits

string

Y / N. Determines whether or not the inventory item can consume service credits. Null value = yes.

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

Input Arguments

Allowable values for pricing_rule:

Allowable values for edit_directive:

Output Arguments