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_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 |
![]() |
item_desc | string | 300 | Specifies description of Inventory item |
![]() |
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 | ||
![]() |
![]() |
string | 100 | Specifies Service name for the Inventory item |
![]() |
string | 30 | Specified chart of access code | |
![]() |
int | 1 | Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable. | |
![]() |
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 | |
![]() |
string | 20 | Commodity Code | |
![]() |
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 ) | |
![]() |
item_price | string | 12 | 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'. |
client_item_id | string | 100 | Specifies Client defined unique id for the item | |
active_ind | int | 1 | Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active | |
schedule | array | |||
![]() |
![]() |
string | 100 | Name for the rate schedule to be created. REST input arrays should passed in the following format: schedule[0][schedule_name]=firstSchedule&schedule[1][schedule_name]= secondSchedule. |
![]() |
![]() |
string | 3 | Currency for the schedule to be created. REST input arrays should passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=gbp |
![]() |
string | 100 | '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. | |
![]() |
boolean | 1 | 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. Allowable Values | |
![]() |
boolean | 1 | This flag denotes if this rate is inclusive of the taxes. Allowable Values | |
![]() |
![]() |
array | ||
![]() |
int | 10 | 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. | |
![]() |
int | 10 | 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. | |
![]() |
string | 50 | 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. | |
![]() |
![]() |
float | 11 | 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 |
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. 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 | |
pricing_rule | int | Specifies the pricing rule of the tier calculations. Allowable Values | ||
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 | string | 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. If item_type=2 then this field is required | |
resource_type_no | string | The assigned identifier for a resource | ||
resource_units | string | Number of units of resource | ||
stock_level_track | int | Specifies whether the stock level can be adjusted or not. Valid values are 1 or 0 | ||
stock_level_adjust | float | Specifies the number to adjust the stock level with | ||
image | array | |||
![]() |
string | 1000 | Specifies the main image url for the image | |
![]() |
string | 1000 | Specifies the thumbnail url for the image | |
![]() |
string | 50 | Specifies the description of the image | |
![]() |
int | 1 | Specifies whether this is the default image or not | |
![]() |
int | 1 | Specifies whether this image is active or not | |
![]() |
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 | ||
![]() |
int | 100 | the field no | |
OR | ||||
![]() |
string | 100 | the field name | |
![]() |
string array | the field value |
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 |