get_inventory_item_details_m Sample Call and Response
This example retrieves the full configuration of one inventory item, based on the get_inventory_item_details_m definition in methods_m_r73.yml. The item in this example, item number 30021, is the same 5G Home Router bundled as a non-subscription offering (NSO) in the get_plan_details_m example, and it uses the same installment term shown in the get_installment_terms_m example.
This example covers the required item identifier, an optional currency filter, and a representative subset of the item configuration returned, including its rate schedule, image references, and installment financing terms. It does not cover fields that apply only to fee-type items, such as fee_type and fee_structure_list, since this item is a standard inventory item rather than a fee.
Sample call
{
"rest_call": "get_inventory_item_details_m",
"output_format": "json",
"client_no": 12345,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"item_no": 30021,
"currency_cd": "USD"
}
The rest_call and output_format fields are envelope fields added by the REST layer rather than arguments defined in the yml file. Client_no and auth_key are required on every Admin Tools API call. Item_no is the required item identifier for this method; the yml file also allows client_sku as an alternative identifier, but this example uses the Aria-assigned numeric item_no. Currency_cd is an optional filter that limits the rate schedule information returned to a single currency; this example uses United States Dollars. This example omits the optional client_item_id argument, since that field carries a deprecate_version marker in the yml file, and it omits locale_no, locale_name, and include_translations, since it does not request translated field values.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"item_no": 30021,
"item_type": 0,
"item_name": "5G Home Router - Model X200",
"item_desc": "Dual-band 5G wireless router with four gigabit Ethernet ports, provided as a bundled or standalone device purchase.",
"active_ind": 1,
"purchase_scope": 1,
"service_no": 70050,
"client_service_id": "DEVICE-FINANCING",
"invoice_advancement_months": 0,
"plan_no": 20456,
"client_plan_id": "PREMIUM-UNLTD-5G",
"client_sku": "RTR-X200",
"modify_price_ind": "N",
"item_class": 12,
"image": [
{
"main_image_url": "https://cdn.example.com/items/rtr-x200-main.png",
"thumbnail_image_url": "https://cdn.example.com/items/rtr-x200-thumb.png",
"image_text": "5G Home Router - Model X200, front view",
"default_ind": 1,
"active": 1
}
],
"schedule": [
{
"schedule_no": 88110,
"schedule_name": "Router Bundle Rate - USD",
"currency_cd": "USD",
"client_rate_schedule_id": "RS-ROUTER-BUNDLE",
"is_default": 1,
"tax_inclusive_rate": "0",
"tier": [
{
"description": "Flat unit price",
"amount": 249.99
}
]
}
],
"installment_term_info": [
{
"installment_term_no": 4521,
"client_installment_term_id": "12MO-DEVICE-FIN",
"installment_term_name": "12-Month Device Financing",
"is_default": 1
}
]
}
An error_code of 0 with error_msg of "OK" indicates the lookup succeeded. Item_type of 0 means this is a standard inventory item rather than a resource item or a fee, so the resources array and the fee-related fields do not apply and are omitted. Purchase_scope of 1 means the router can be purchased only alongside a qualifying plan, and plan_no and client_plan_id identify that plan, the same Premium Unlimited 5G plan documented in the get_plan_details_m example. Modify_price_ind of "N" means a CSR may not override this item's price. In the schedule array, is_default of 1 means this is the default rate schedule for its currency, and tax_inclusive_rate of "0" means the rate is tax exclusive; the single tier entry has no from or to unit values because this item is priced with one flat unit price rather than a tiered rate. Installment_term_info shows only a summary of the financing term available for this item; the full set of installment term configuration fields, such as term_length and lump_sum_amount, is covered separately in the get_installment_terms_m example. This example omits days_to_expiry and the resources array, since both apply only when item_type is 2 (resource item); it omits fee_application_type, fee_type, and fee_structure_list, since those apply only when item_type is 3 (fee); it omits subunit_qty, subunit_label, stock_level, supplemental_obj_fields, and item_translations, none of which are populated for this item in this example; and it omits the pricing object entirely, since the yml file carries a deprecate_version marker on that field.