update_inventory_item_m

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Summary

API Name	update_inventory_item_m
Class	administration_services_m
Update Version	6.38

Description

Updates an existing inventory item.

Inputs

Name

Type

Length

Required

Description

client_no

long

Yes

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

auth_key

string

Yes

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

item_no

long

Yes

Specifies the inventory item number.

Alternative required field: existing_client_sku

item_type

int

Yes

The item type for the inventory item.

Allowed values:

Value	Description
0	Inventory item
1	Months to stack (deprecated)
2	Resource item

item_name

string

100

Yes

Specifies the inventory item name. This field is translatable.

item_desc

string

300

Yes

Specifies the description of the inventory item. This field is translatable.

existing_client_sku

string

Yes

The existing SKU used to query the inventory item.

Alternative required field: item_no

client_item_id

string

100

Specifies the client-defined unique identifier for the item.

Note: This field was deprecated in version 43.

active_ind

int

Specifies whether the inventory item is active or inactive.

Allowed values:

Value	Description
0	Inactive
1	Active

purchase_scope

int

Specifies the purchase scope for the inventory item.

Allowed values:

Value	Description
0	No purchase restrictions
1	Can be purchased with qualifying plans only

service_no

long

Yes

Specifies the service number for the inventory item.

Alternative required field: client_service_id

client_service_id

string

100

Yes

Specifies the client-defined unique identifier for the service.

Alternative required field: service_no

service

object

The service associated with the inventory item.

See fields below

schedule

object

The rate schedules associated with the inventory item.

See fields below

client_sku

string

Yes

The SKU specified by the client for the inventory item.

currency_cd

string

Yes

Specifies the currency code for the inventory item. This value is not case sensitive (for example, both usd and USD work). REST input arrays are pipe-separated lists of a single data type.

item_price

string

Yes

Specifies the price for the inventory item for each currency. REST input arrays are pipe-separated lists of a single data type. The count of values passed for the item_price parameter must be the same as the count for currency_cd.

tax_inclusive_ind

string

Indicates whether a rate is inclusive of taxes. A value of 1 means tax-inclusive rates, and a value of 0 (default) means tax-exclusive rates. REST input arrays are pipe-separated lists of a single data type. The count of values passed for the tax_inclusive_ind parameter must be the same as the count for currency_cd.

modify_price_ind

string

Specifies whether customer service representatives may modify the inventory item price.

Allowed values:

Value	Description
Y	Yes
N	No

subunit_qty

int

The subunit quantity. If item_type equals 0 and subunit_label is not null, this field is required.

subunit_label

string

100

The subunit label. If item_type equals 0 and quantity_per_item is not null, this field is required. This field is translatable.

pricing_rule

int

Specifies the pricing rule for the tier calculations.

Allowed values:

Value	Description
1	Standard
2	Volume discount
3	Flat rate per tier

queued_active_ind

int

Specifies whether to queue the activation.

Allowed values:

Value	Description
0	No
1	Yes

queued_active_date

string

Specifies the date to activate or deactivate the item.

do_auto_create_service_credit

int

Specifies whether to automatically create a service credit. This field does not apply to the fee type (item_type equals 3).

Allowed values:

Value	Description
0	No
1	Yes

days_to_expiry

int

Specifies the number of days to expiration for resources on this SKU.

resource_type_no

long

The assigned identifier for a resource. This field must not be null if item_type equals 2. REST input arrays are pipe-separated lists of a single data type.

resource_units

string

The number of units of the resource. This field must not be null if item_type equals 2. REST input arrays are pipe-separated lists of a single data type.

stock_level_track

int

Specifies whether the stock level can be adjusted.

Allowed values:

Value	Description
0	No
1	Yes

stock_level_adjust

float

Specifies the number to adjust the stock level with.

image

object

The image associated with the inventory item.

See fields below

parent_class

object

The parent class information for the inventory item.

See fields below

supplemental_obj_field

object

Specifies the supplemental object fields to add for this item.

See fields below

edit_directive

int

A directive that indicates the action to take. This parameter applies to the schedule field in this method.

Allowed values:

Value	Description
1	Delete data that is not passed in the request
2	Insert or update data that is passed, but do not delete data that is not passed
3	Delete everything that is passed

locale_no

long

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

Alternative field: locale_name

locale_name

string

The name of the locale to which the translations belong.

Alternative field: locale_no

allow_service_credits

string

Determines whether the inventory item can consume service credits. Valid values are Y and N. A null value defaults to Y.

installment_terms

object

A list of installment terms that can be mapped to an inventory item.

See fields below

service fields

Name	Type	Length	Required	Description
service_no	long	8	Yes	Specifies the service number for the inventory item. Alternative field: client_service_id
client_service_id	string	100	No	Specifies the client-defined unique identifier for the service. Alternative field: service_no
name	string	100	Yes	Specifies the service name for the inventory item.
gl_cd	string	30	No	Specifies the chart of accounts code.
taxable	int	1	No	Indicates whether the service has tax associated with it. A value of 1 indicates taxable, and a value of 0 indicates non-taxable.
tax_group	int	8	No	Specifies the tax group associated with the service. This value is null if taxable_ind is set to 0. If taxable_ind is 1, this field is required.
commodity_cd	string	20	No	The commodity code.

schedule fields

Name

Type

Length

Required

Description

schedule_no

long

100

Specifies the schedule number to edit. This field can be null for new services. REST input arrays should be passed in the following format: schedule[0][schedule_no]=1212121&schedule[1][schedule_no]=4234232, where schedule[0] specifies the first schedule and schedule[1] specifies the second schedule, and so on.

Note: If a rate schedule has been used on an inventory item, you cannot delete it. If no price has been provided for a currency in a rate schedule, Aria automatically deletes the corresponding rate schedule.

Alternative field: client_rate_schedule_id

schedule_name

string

100

Yes

The name for the rate schedule. REST input arrays should be passed in the following format: schedule[0][schedule_name]=firstSchedule&schedule[1][schedule_name]=secondSchedule.

currency_cd

string

Yes

The currency of the schedule. REST input arrays should be passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=gbp.

client_rate_schedule_id

string

100

The client-defined unique identifier. REST input arrays should be passed in the following format: schedule[0][client_rate_schedule_id]=firstSchedule&schedule[1][client_rate_schedule_id]=secondSchedule.

Alternative field: schedule_no

is_default

int

Denotes whether this rate schedule is the default one for the currency of the schedule. 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 as the default. For subsequent rate schedules, the default is set to 0.

Allowed values:

Value	Description
0	Non-default schedule
1	Default schedule

tax_inclusive_rate

int

Denotes whether this rate is inclusive of taxes.

Allowed values:

Value	Description
0	Tax exclusive
1	Tax inclusive

tier

object

Yes

The tiered pricing rules for the rate schedule.

See fields below

tier fields

Name	Type	Length	Required	Description
from	int	10	No	The tiered pricing rule that specifies the starting number of units. REST input arrays should be passed in the following format: schedule[0][tier][0][from]=1&schedule[0][tier][1][from]=1, where [tier][0] specifies the first tier and [tier][1] specifies the second tier, and so on.
to	int	10	No	The tiered pricing rule that specifies the ending number of units. To indicate no upper limit, leave this value blank. REST input arrays should be passed in the following format: schedule[0][tier][0][to]=3&schedule[0][tier][1][to]=7, where [tier][0] specifies the first tier and [tier][1] specifies the second tier, and so on.
description	string	50	No	A custom description for the rate tier. REST input arrays should be passed in the following format: schedule[0][tier][0][description]=Custom description, where [tier][0] specifies the first tier and [tier][1] specifies the second tier, and so on.
amount	float	11	Yes	The tiered pricing rule that specifies the rate per unit. REST input arrays should be passed in the following format: schedule[0][tier][0][amount]=3&schedule[0][tier][1][amount]=4.

image fields

Name	Type	Length	Required	Description
default_image_url	string	1000	Yes	Specifies the main image URL for the image.
thumbnail_image_url	string	1000	Yes	Specifies the thumbnail URL for the image.
image_text	string	50	No	Specifies the description of the image.
default_ind	int	1	Yes	Specifies whether this is the default image.
active	int	1	Yes	Specifies whether this image is active.

parent_class fields

Name	Type	Length	Required	Description
class_no	long	8	No	Specifies the parent class to which this class belongs.

supplemental_obj_field fields

Name	Type	Length	Required	Description
field_no	long	100	No	The field number. Alternative field: field_name
field_name	string	100	No	The field name. Alternative field: field_no
field_value	string		No	The field value. This field accepts an array of values.

Name

Type

Length

Required

Description

field_no

long

100

The field number.

Alternative field: field_name

field_name

string

100

The field name.

Alternative field: field_no

field_value

string

The field value. This field accepts an array of values.

installment_terms fields

Name	Type	Length	Required	Description
installment_term_no	long		No	The installment number. Alternative field: client_installment_term_id
client_installment_term_id	string		No	The client installment identifier. Alternative field: installment_term_no
is_default	int	1	No	The value of 1 is defaulted for the first installment term, denoting it as the default. For subsequent installment terms, the default is set to 0. Alternate boolean values are accepted.

Name

Type

Length

Required

Description

installment_term_no

long

The installment number.

Alternative field: client_installment_term_id

client_installment_term_id

string

The client installment identifier.

Alternative field: installment_term_no

is_default

int

The value of 1 is defaulted for the first installment term, denoting it as the default. For subsequent installment terms, the default is set to 0. Alternate boolean values are accepted.

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.
item_no	long	8	No	Specifies the inventory item number.