update_inventory_item_m
Summary
| API Name | update_inventory_item_m |
|---|---|
| Class | administration_services_m |
| Update Version | 6.38 |
Description
Update an existing inventory item
Inputs
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 12 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
||||||||
| item_no | long | 8 | Yes |
Specifies the Inventory item number Alternative required field: existing_client_sku |
||||||||
| item_type | int | 1 | Yes |
Item Type for the inventory item. Valid values are: 0 - Inventory Item, 1 - Months To Stack (Deprecated), 2 - Resource Item |
||||||||
| item_name | string | 100 | Yes |
Specifies the inventory item name. Translatable. |
||||||||
| item_desc | string | 300 | Yes |
Specifies description of Inventory item. Translatable. |
||||||||
| existing_client_sku | string | 30 | Yes |
Existing SKU to query the inventory item Alternative required field: item_no |
||||||||
| client_item_id | string | 100 | No |
Specifies Client defined unique id for the item Note: This field was deprecated in version 43. |
||||||||
| active_ind | int | 1 | No |
Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active |
||||||||
| purchase_scope | int | 1 | No |
Specifies purchase scope for inventory item. Valid values are: 0 - No purchase restrictions and 1 - Can be purchased with qualifying plans only |
||||||||
| service_no | long | 8 | Yes |
Specifies Service number for the Inventory item Alternative required field: client_service_id |
||||||||
| client_service_id | string | 100 | Yes |
Specifies Client defined unique id for the service Alternative required field: service_no |
||||||||
| Start of service object | ||||||||||||
| service | object | Yes |
The service associated with this method. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶service_no | long | 8 | Yes |
Specifies Service number for the Inventory item Alternative required field: client_service_id |
||||||||
| ▶client_service_id | string | 100 | No |
Specifies Client defined unique id for the service Alternative field: service_no |
||||||||
| ▶name | string | 100 | Yes |
Specifies Service name for the Inventory item |
||||||||
| ▶gl_cd | string | 30 | No |
Specified chart of access code |
||||||||
| ▶taxable | int | 1 | No |
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 | No |
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 | No |
Commodity Code |
||||||||
| End of service object | ||||||||||||
| Start of schedule object | ||||||||||||
| schedule | object | No |
The schedule associated with this method. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶schedule_no | long | 100 | No |
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. 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. Alternative field: client_rate_schedule_id |
||||||||
| ▶schedule_name | string | 100 | Yes |
Name for the rate schedule. REST input arrays should passed in the following format: schedule[0][schedule_name]=firstSchedule&schedule[1][schedule_name]= secondSchedule. |
||||||||
| ▶currency_cd | string | 3 | Yes |
Currency of the schedule. REST input arrays should passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=gbp |
||||||||
| ▶client_rate_schedule_id | string | 100 | No |
'Client defined unique id' REST input arrays should 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 | 1 | No |
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. Allowed values:
|
||||||||
| ▶tax_inclusive_rate | int | 1 | No |
This flag denotes if this rate is inclusive of the taxes. Allowed values:
|
||||||||
| Start of tier object | ||||||||||||
| ▶tier | object | Yes |
The tier associated with this method. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶▶from | int | 10 | No |
Tiered pricing rule that specifies “from” units. REST input arrays should be passed in the following format: schedule[0][tier][0][from]=1&schedule[0][tier][1][from]=1 etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. |
||||||||
| ▶▶to | int | 10 | No |
Tiered pricing rule that specifies “to” units. To indicate no upper limit, value should be left blank. REST input arrays should be passed in the following format: schedule[0][tier][0][to]=3&schedule[0][tier][1][to]=7 etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. |
||||||||
| ▶▶description | string | 50 | No |
This field is used to display custom rate tier description. REST input arrays should be passed in the following format: schedule[0][tier][0][description]=Custom description&schedule[0][tier][0][description]=custom description etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. |
||||||||
| ▶▶amount | float | 11 | Yes |
Tiered pricing rule that specifies rate per unit. REST input arrays should be passed in the following format: schedule[0][tier][0][amount]=3&schedule[0][tier][0][amount]=4 etc |
||||||||
| End of tier object | ||||||||||||
| End of schedule object | ||||||||||||
| client_sku | string | 30 | Yes |
SKU specified by client for the inventory item |
||||||||
| currency_cd | string | Yes |
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 | Yes |
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'. |
||||||||
| tax_inclusive_ind | string | 1 | No |
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 | No |
Specifies if CSR's may modify Inventory item price. Valid values are: Y - Yes and N - No |
||||||||
| subunit_qty | int | 12 | No |
Subunit Quantity If item_type=0 and subunit_label is not null then this field is required |
||||||||
| subunit_label | string | 100 | No |
Subunit Label If item_type=0 and quantity_per_item is not null then this field is required. Translatable. |
||||||||
| pricing_rule | int | No |
Specifies the pricing rule of the tier calculations. Allowed values:
|
|||||||||
| queued_active_ind | int | 1 | No |
Specifies whether to queue the activation or not. Valid values are 0 - No, 1- Yes |
||||||||
| queued_active_date | string | 10 | No |
Specifies date to activate or deactivate the item |
||||||||
| do_auto_create_service_credit | int | 1 | No |
Specifies whether to automatically create service credit or not. Valid values are 0 - No, 1- Yes. Not applicable for fee type (item_type=3). |
||||||||
| days_to_expiry | int | 3 | No |
Specifies the number of days to expiration for resources on this SKU |
||||||||
| resource_type_no | long | No |
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 | No |
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 | No |
Specifies whether the stock level can be adjusted or not. Allowed values are 1 or 0 |
|||||||||
| stock_level_adjust | float | No |
Specifies the number to adjust the stock level with |
|||||||||
| Start of image object | ||||||||||||
| image | object | No |
The image associated with this method. |
|||||||||
| 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 or not |
||||||||
| ▶active | int | 1 | Yes |
Specifies whether this image is active or not |
||||||||
| End of image object | ||||||||||||
| Start of parent_class object | ||||||||||||
| parent_class | object | No |
The parent_class associated with this method. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶class_no | long | 8 | No |
Specifies the parent class this class belongs to |
||||||||
| End of parent_class object | ||||||||||||
| Start of supplemental_obj_field object | ||||||||||||
| supplemental_obj_field | object | No |
Specifies the supplemental object fields to be added for this item |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶field_no | long | 100 | No |
the field no Alternative field: field_name |
||||||||
| ▶field_name | string | 100 | No |
the field name Alternative field: field_no |
||||||||
| ▶field_value | string | No |
the field value |
|||||||||
| End of supplemental_obj_field object | ||||||||||||
| edit_directive | int | No |
A directive that indicates the action to be taken. This new parameter applies to the schedule in the API Allowed values:
|
|||||||||
| locale_no | long | 38 | No |
Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name |
||||||||
| locale_name | string | 32 | No |
Name of the locale to which the translations belong. Alternative field: locale_no |
||||||||
| allow_service_credits | string | 1 | No |
Y / N. Determines whether or not the inventory item can consume service credits. Null value = yes. |
||||||||
| Start of installment_terms object | ||||||||||||
| installment_terms | object | No |
A list of installment terms can be mapped to an inventory item |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶installment_term_no | long | No |
Installment no Alternative field: client_installment_term_id |
|||||||||
| ▶client_installment_term_id | string | No |
Client installment ID Alternative field: installment_term_no |
|||||||||
| ▶is_default | int | 1 | No |
The value of 1 is defaulted for the first installment term denoting it is the default. For subsequent installment terms, the default is set to 0. Alternate boolean values are accepted. |
||||||||
| End of installment_terms object | ||||||||||||
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 |