Returns details of specified 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.
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 | Specifies the Inventory item number | ||||||||
OR | ||||||||||
client_sku | string array | 100 | Client SKU of the NSO/Inventory item | |||||||
currency_cd | string | |||||||||
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. | |||||||
include_translations | string | 1 | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.
Allowable values for include_translations:
|
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 | ||||||
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 | Specifies the inventory item name | ||||||
item_desc | string | Specifies description of Inventory item | ||||||
active_ind | int | Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active | ||||||
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 | ||||||
service_no | int | Specifies Service number for the Inventory item | ||||||
client_service_id | string | Client defined unique identifier | ||||||
invoice_advancement_months | int | Specifies months of invoice advancement for the Inventory item | ||||||
plan_no | int | Specifies Master Plan number for the Inventory item | ||||||
client_plan_id | string | Client defined unique identifier | ||||||
client_sku | string | SKU specified by client for the inventory item | ||||||
modify_price_ind | string | Specifies if CSR's may modify Inventory item price. Valid values are: Y - Yes and N - No | ||||||
subunit_qty | float | Subunit Quantity | ||||||
subunit_label | string | Subunit Label | ||||||
days_to_expiry | int | Specifies the number of days to expiration for resources on this SKU | ||||||
resources | hash | |||||||
![]() |
int | The assigned identifier for a resource | ||||||
![]() |
int | Number of units of resource | ||||||
![]() |
int | Specifies the number of days to expiration for resources on this SKU. If item_type=2 then this field is required | ||||||
![]() |
string | The name of the resource referenced in resource_type_no | ||||||
pricing | hash | |||||||
![]() |
string | Specifies the currency code of Inventory item | ||||||
![]() |
float | Specifies the price of Inventory item | ||||||
![]() |
float | Specifies sub unit price. This will be null if item type is not 0 or if item type is 0 but subunit_qty is not specified | ||||||
stock_level | float | |||||||
image | hash | |||||||
![]() |
string | Specifies the url for the thumbnail version of the image. | ||||||
![]() |
string | Specifies text about the image. | ||||||
![]() |
int | Specifies whether the image is default or not. Allowed values are 1 - default and 0- non default. | ||||||
![]() |
int | Specifies Aria generated sequence number for the image. | ||||||
![]() |
int | Specifies whether the image is active or not. | ||||||
![]() |
string | Specifies the url for the main image. | ||||||
item_class | int | Specifies which class the inventory item belongs to. | ||||||
supplemental_obj_fields | hash | |||||||
![]() |
int | the field no | ||||||
![]() |
string | the field value | ||||||
![]() |
string | the field name | ||||||
item_translations | hash | Array that contains all the translated values for a given locale. | ||||||
![]() |
string | Name of the locale. | ||||||
![]() |
int | Aria-assigned unique identifier of the locale used for translations. | ||||||
![]() |
long | Specifies the Inventory item number | ||||||
![]() |
string | Specifies the inventory item name | ||||||
![]() |
string | Specifies description of Inventory item | ||||||
schedule | array | This array contains the rate schedule information | ||||||
![]() |
string | Name for the rate schedule to be created. Translatable. | ||||||
![]() |
string | Client-defined unique identifier. | ||||||
![]() |
string | Currency for the schedules to be created. | ||||||
![]() |
boolean | This flag denotes if this rate schedule is the default one 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 | string | This flag denotes if this rate is inclusive of the taxes.
Allowable values for tax_inclusive_rate:
|
||||||
tier | array | This array contains tiered pricing information for the given rate schedule. | ||||||
![]() |
string | Name of rate schedule this tier belongs to. | ||||||
![]() |
string | Client-defined unique identifier for the rate schedule. | ||||||
![]() |
float | Tiered pricing rule that specifies rate per unit. | ||||||
![]() |
int | Tiered pricing rule that specifies "from" units. | ||||||
![]() |
int | Tiered pricing rule that specifies to units. | ||||||
![]() |
string | This field is used to display custom rate tier description. This will override the rate tier's description at service level. |