Skip to main content
Aria Knowledge Central

get_inventory_item_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_inventory_item_details_m
Class administration_services_m
Update Version 6.38

Description

Returns details of specified 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   Yes

Specifies the Inventory item number

Alternative required field: client_sku
client_sku string 30 Yes

SKU specified by client for the inventory item

Alternative required field: item_no
client_item_id string 100 No

Client defined unique identifier

Note: This field was deprecated in version 43.
currency_cd string   No  
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
include_translations string 5 No

Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowed values:

Value Description
True Translated fields will be fetched in all the locales defined.
False Translation information will not be fetched.

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
client_item_id string 100 No

Client defined unique identifier

Note: This field was deprecated in version 43.
item_type int 1 No

Item Type for the inventory item. Valid values are: 0 - Inventory Item, 1 - Months To Stack (Deprecated), 2 - Resource Item, 3 - Fee
fee_application_type int 1 No

Specifies how the fee is applied. If item_type = 3, defaults to 1. Allowable value: 1 - Applied to payment plan. Null for non-fee items.
fee_type string 1 No

Type of fee calculation. Mandatory when item_type = 3. Allowable values are: P - Percentage-based, F - Flat, A - Amortized (declining balance) interest. Null for non-fee items.
fee_structure_list object   No

List of fee structure components. Null / empty array for non-fee items.

See fields below
item_name string 100 No

Specifies the inventory item name
item_desc string 300 No

Specifies description of Inventory item
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 No

Specifies Service number for the Inventory item
client_service_id string 100 No

Client defined unique identifier
invoice_advancement_months int 2 No

Specifies months of invoice advancement for the Inventory item
plan_no long 12 No

Specifies Master Plan number for the Inventory item
client_plan_id string 100 No

Client defined unique identifier
client_sku string 30 No

SKU specified by client for the inventory item
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 float 12 No

Subunit Quantity
subunit_label string 100 No

Subunit Label
days_to_expiry int 3 No

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

The resources associated with this method.

See fields below
pricing object   No

The pricing associated with this method.

See fields below

Note: This field was deprecated in version 50.
stock_level float   No  
image object   No

The image associated with this method.

See fields below
item_class int   No

Specifies which class the inventory item belongs to.
supplemental_obj_fields object   No

The supplemental_obj_fields associated with this method.

See fields below
item_translations object   No

Array that contains all the translated values for a given locale.

See fields below
schedule object   No

The schedule associated with this method.

See fields below
installment_term_info object   No

The installment_term_info associated with this method.

See fields below

fee_structure_list fields

Name Type Length Required Description
currency_cd string 3 Yes

Specifies the ISO currency code for fee.
tax_inclusive_ind int 1 No

Indicates if the fee is inclusive of taxes. Allowable values: 1 - tax inclusive, 0 - tax exclusive.
fee_amount float   No

Specifies the fee amount. Works jointly with fee_type.

resources fields

Name Type Length Required Description
resource_type_no long   Yes

The assigned identifier for a resource
resource_units int   Yes

Number of units of resource
days_to_expiry int 3 No

Specifies the number of days to expiration for resources on this SKU. If item_type=2 then this field is required
resource_name string   Yes

The name of the resource referenced in resource_type_no

pricing fields

Name Type Length Required Description
currency_cd string 3 Yes

Specifies the currency code of Inventory item
price float 12 No

Specifies the price of Inventory item
price_per_unit float 12 No

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

image fields

Name Type Length Required Description
thumbnail_image_url string   No

Specifies the url for the thumbnail version of the image.
image_text string   No

Specifies text about the image.
default_ind int   No

Specifies whether the image is default or not. Allowed values are 1 - default and 0- non default.
image_class_seq_no long   No

Specifies Aria generated sequence number for the image.
active int   No

Specifies whether the image is active or not.
main_image_url string   No

Specifies the url for the main image.

supplemental_obj_fields fields

Name Type Length Required Description
field_no long 100 No

the field no
field_value string   No

the field value
field_name string 100 No

the field name

item_translations fields

Name Type Length Required Description
locale_name string 32 No

Name of the locale to which the translations belong.

Alternative field: locale_no
locale_no long 38 No

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

Alternative field: locale_name
item_no long 100 Yes

Specifies the Inventory item number
item_name string 100 Yes

Specifies the inventory item name
item_desc string 300 Yes

Specifies description of Inventory item

schedule.tier fields

Name Type Length Required Description
from int 10 No

Tiered pricing rule that specifies “from” units.
to int 10 No

Tiered pricing rule that specifies “to” units.
description string 50 No

This field is used to display custom rate tier description.
amount float 11 Yes

Tiered pricing rule that specifies rate per unit.

schedule fields

Name Type Length Required Description
schedule_no long 10 Yes

Schedule Number for the Inventory item currency
schedule_name string 100 Yes

Name for the rate schedule.
currency_cd string 3 Yes

Currency for the schedule.
client_rate_schedule_id string 100 No

Client defined unique id
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:

Value Description
0 Default schedule
1 Non-Default schedule
tax_inclusive_rate string 1 No

This flag denotes if this rate is inclusive of the taxes.

Allowed values:

Value Description
0 Tax exclusive
1 Tax inclusive
tier object   Yes

The tier associated with this method.

See fields below

installment_term_info fields

Name Type Length Required Description
installment_term_no long   Yes

Aria-assigned installment terms no
client_installment_term_id string   Yes

Specifies client installment term id
installment_term_name string   Yes

Specifies installment term name
installment_term_description string   No

Installment term description
aligned_installment string   No

Aligned installment schedule with existing master plan instance. Allowable values are: Yes (Y) - Aligned with existing master plan instance OR No (N) - Its own installment schedule and due dates. If aligned, installment amount will be charged along with master plan instance anniversary invoice/statement.
is_default int   No

The default installment term
term_type string   No

M (Months), W (Weeks), D (Days). If Null, will be treated as Months
term_length int   No

Installment term length. For example if interval type is M (Monthly), if users enter 36 then, installment period is 36 months.
installment_term_interval int   No

Installment interval, works jointly with terms type. For example: 2 on interval and months in terms type mean installment is due every 2 months. If defined, must be less than terms length.
days_to_start int   No

Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after a purchase or subscription date that the first installment will start. For example: if 5 is passed, then 5 days after a purchase date 1st installment will start. If 0 is passed, then 1st installment will start on purchase date.
days_until_due int   No

Applicable only when aligned_installment is No (N) - Its own installment schedule and due dates. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due.
installment_term_status string   No

Installment status related to installment terms (Active or Inactive)
lump_sum_type string   No

Lump sum type determines type of charges to be considered as a lump sum. 2 types of lump sum are: proportionately split (tax/charge) or tax only. Allowable values are: P - for proportionately split charge/tax; T - for purchase tax only.
lump_sum_amount float 8 No

Applicable only when lump sump type is proportionately split (lump_sum_type = P). A one-time amount that will reduce the total installment to be spread over the course of installment term. For example: a $1200 phone purchase with  $200 lump sump will reduce the total installment amount to $1000, which will be spread monthly over 10 months installment term ($100 per month). Lump sum amount is mandatory when only when lump_sum_type is P (proportionately split charge/tax).
aligned_lump_sum int   No

Applicable only for aligned installment (aligned_installment = Y). Determines when to notify customers of the lump sum. Allowable values are: 0 - Aligned with when an invoice is created; 1 - Aligned with the 1st installment. If NULL, but aligned_installment = Y and lump_sum_type are passed, then aligned_lump_sum will be treated as 0 - Aligned with when an invoice is created. When aligned_installment = N, value passed will be ignored.
lump_sum_days int 8 No

Applicable only for independent installment (aligned_installment = N). Determines how many days after a purchase or invoice date that a lump sum is charged and be notified to customers. For example: if 3 is passed, then 3 days after an invoice date, a lump sum will be charged. If 0 is passed, then 1st installment will start (and be notified to customers) on purchase date (invoice date).
lump_sum_days_until_due int 8 No

Applicable for both types of installment. Determines how many days after customers are notified that a lump sum is due. For example: if 5 is passed, then 5 days after customers are notified, the lump sum will be due. For independent installment, if it's NULL, it will be treated as 0, and lump sum is due when it's notified to customers. If it's NULL for aligned installment, it will follow the statement due date that lump sum is on.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.