get_client_items_all_m Sample Call and Response
This example shows a call to get_client_items_all_m that retrieves the full, detailed catalog of inventory items associated with a client, including prices, services, images, supplemental fields, and item classes, based on the plsql_m_r73.yml definition file for release 73.
This example includes every required field and a representative set of optional filters and inclusion flags, and it shows two of the returned items in full detail rather than every item a real client catalog would contain.
Sample call
{
"rest_call": "get_client_items_all_m",
"output_format": "json",
"client_no": "10021",
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"filter_currency_cd": "usd",
"include_inactive_items": "false",
"purchase_scope": 0,
"include_all_service_supp_fields": "true",
"include_all_item_images": "true",
"include_all_item_supp_fields": "true",
"include_all_item_classes": "true",
"include_nso_rate_schedule": "false",
"limit": 2,
"offset": 0
}
This call requests every active item priced in United States dollars, and it asks Aria to populate the nested service supplemental fields, item images, item supplemental fields, and item classes arrays. The purchase_scope value of 0 means the returned items carry no purchase restrictions; a value of 1 would mean an item can only be purchased alongside a qualifying plan. This example leaves filter_item_no and filter_client_sku out of the call entirely, since narrowing the call to a single item by either of those alternative fields would defeat the purpose of illustrating a multi-item catalog response. The limit and offset fields page through the catalog; this example requests only the first two items. The example omits return_no_cost_items and filter_client_item_id from the call, since both fields carry a deprecate_version and no longer belong in a current sample.
Sample response
{
"all_client_item_details": [
{
"item_no": 88420,
"item_label": "Wireless Noise-Cancelling Headphones",
"service_no": 5510,
"service_desc": "Consumer Electronics Hardware",
"client_service_id": "svc-hardware-electronics",
"client_item_plan_id": "plan-hardware-addon",
"usage_type_cd": null,
"all_service_supp_fields": [
{
"field_name": "Category",
"field_desc": "Product category for reporting",
"field_order_no": 1,
"field_value": "Audio Accessories"
}
],
"client_sku": "WNC-HDPH-BLK",
"item_plan": 3301,
"item_months": 0,
"stock_level": 412.0,
"item_type": 0,
"item_desc": "Over-ear wireless headphones with active noise cancellation and a thirty-hour battery life.",
"active_ind": 1,
"modify_price_ind": "N",
"subunit_qty": null,
"subunit_label": null,
"coa_id": "COA-4400",
"client_coa_code": "ELEC-HW",
"taxable_ind": 0,
"tax_group": 12,
"purchase_scope": 0,
"all_item_images": [
{
"image_class_name": "thumbnail",
"image_class_no": 1,
"image_class_seq_no": 1,
"image_url": "https://cdn.example.com/items/88420/thumb.png",
"image_text": "Wireless Noise-Cancelling Headphones thumbnail",
"default_ind": 1
}
],
"all_item_supp_fields": [
{
"field_name": "Color",
"field_desc": "The color variant of this headphone model",
"field_order_no": 1,
"field_value": "Midnight Black"
}
],
"all_item_classes": [
{
"class_no": 40,
"label": "Consumer Electronics"
}
],
"nso_rate_schedules": []
},
{
"item_no": 88421,
"item_label": "Extended Warranty - Two Years",
"service_no": 5520,
"service_desc": "Warranty Services",
"client_service_id": "svc-warranty",
"client_item_plan_id": null,
"usage_type_cd": null,
"all_service_supp_fields": [],
"client_sku": "WNC-WARR-2Y",
"item_plan": null,
"item_months": 24,
"stock_level": null,
"item_type": 1,
"item_desc": "Two-year extended warranty coverage that can be stacked onto a purchased hardware item.",
"active_ind": 1,
"modify_price_ind": "N",
"subunit_qty": null,
"subunit_label": null,
"coa_id": "COA-4401",
"client_coa_code": "WARR-SVC",
"taxable_ind": 1,
"tax_group": null,
"purchase_scope": 1,
"all_item_images": [],
"all_item_supp_fields": [],
"all_item_classes": [
{
"class_no": 41,
"label": "Warranty and Protection Plans"
}
],
"nso_rate_schedules": []
}
],
"error_code": 0,
"error_msg": "OK",
"error_details": null
}
An error_code of 0 with an error_msg of OK indicates that Aria found the client’s catalog and returned the requested item details successfully. The all_client_item_details array holds one entry per inventory item; this example shows two representative entries, an in-stock hardware item and a months-to-stack warranty item, but a real client catalog would typically contain many more items than shown here, and the array is not exhaustive. The nso_rate_schedules array is shown as empty for both items because the sample call set include_nso_rate_schedule to false; setting that flag to true would populate it with rate schedule entries instead. This example does not cover the all_item_prices array, since that field carries a deprecate_version, nor does it cover avg_ratings, num_ratings, num_reviews, or service_type, all of which the yml file marks as deprecated in their descriptions.