get_client_items_basic_m Sample Call and Response
This example shows a call to get_client_items_basic_m that retrieves a summary list of inventory items associated with a client, based on the plsql_m_r73.yml definition file for release 73. Unlike get_client_items_all_m, this method does not return nested images, item classes, or supplemental field arrays, only the flat item-level fields.
This example includes a representative set of optional filters and shows two of the returned items, not the full catalog a real client would have configured.
Sample call
{
"rest_call": "get_client_items_basic_m",
"output_format": "json",
"client_no": "10021",
"auth_key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"filter_currency_cd": "usd",
"include_inactive_items": "false",
"purchase_scope": 0
}
The client_no and auth_key fields follow the shared param_defaults definitions used throughout the yml file. This call requests active items priced in United States dollars with no purchase restrictions. As with the get_client_items_all_m example, this call leaves filter_item_no and filter_client_sku out entirely, since narrowing by either of those alternative fields would return only a single item rather than the list this method is meant to illustrate. The example omits return_no_cost_items and filter_client_item_id, since both carry a deprecate_version.
Sample response
{
"items_basic_details": [
{
"item_no": 88420,
"item_label": "Wireless Noise-Cancelling Headphones",
"service_no": 5510,
"service_desc": "Consumer Electronics Hardware",
"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,
"client_service_id": "svc-hardware-electronics",
"client_item_plan_id": "plan-hardware-addon",
"usage_type_cd": null,
"purchase_scope": 0
},
{
"item_no": 88421,
"item_label": "Extended Warranty - Two Years",
"service_no": 5520,
"service_desc": "Warranty Services",
"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,
"client_service_id": "svc-warranty",
"client_item_plan_id": null,
"usage_type_cd": null,
"purchase_scope": 1
}
],
"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 items and returned the requested summary details successfully. The items_basic_details array holds one entry per item; this example shows two representative entries, but a real catalog could contain many more, and the array is not exhaustive. This example excludes avg_ratings, num_ratings, num_reviews, service_type, and usage_type, since the yml file marks each of these as deprecated in its description text even though it does not carry a formal deprecate_version tag; including fields the platform no longer acts on would misrepresent a current, working example. It also excludes client_item_id, which does carry an explicit deprecate_version.