The get_client_items_all_m API returns a list of inventory items associated with a client. The information returned includes prices, services, images, supplemental fields, and classes associated with the items.
Additional Guidance
- 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.
Input Fields
| Field Name |
Notes |
| <return_no_cost_items> |
Allowable values
| Values |
Description |
| true |
No cost line items will be included |
| false |
No cost line items will not be included |
|
| <include_inactive_items> |
Allowable values
| Values |
Description |
| true |
Inactive inventory items will be included |
| false |
Inactive inventory items will not be included |
|
| <purchase_scope> |
Allowable values
| Values |
Description |
| 0 |
No purchase restrictions. |
| 1 |
Can be purchased with qualifying plans only. |
|
| <include_all_service_supp_fields> |
Allowable values
| Values |
Description |
| true |
include_all_service_supp_fields will be populated. |
| false |
include_all_service_supp_fields will not be populated. |
|
| <include_all_item_images> |
Allowable values
| Values |
Description |
| true |
include_all_item_images will be populated. |
| false |
include_all_item_images will not be populated. |
|
| <include_all_item_supp_fields> |
Allowable values
| Values |
Description |
| true |
include_all_item_supp_fields will be populated. |
| false |
include_all_item_supp_fields will not be populated. |
|
| <include_all_item_classes> |
Allowable values
| Values |
Description |
| true |
include_all_item_classes will be populated. |
| false |
include_all_item_classes will not be populated. |
|
| <include_nso_rate_schedule> |
Allowable values
| Values |
Description |
| true |
include_nso_rate_schedule will be populated. |
| false |
include_nso_rate_schedule will not be populated. |
|
Output Fields
| Field Name |
Notes |
| <item_type> |
Allowable values
| Values |
Description |
| 0 |
Inventory Item |
| 1 |
Months to stack |
| 2 |
Resource Item |
|
| <active_ind> |
Allowable values
| Values |
Description |
| 0 |
Inactive |
| 1 |
Active |
|
| <modify_price_ind> |
Allowable values
| Values |
Description |
| Y |
Yes |
| N |
No |
|
| <taxable_ind> |
Allowable values
| Values |
Description |
| 0 |
taxable |
| 1 |
non-taxable |
|
| <purchase_scope> |
Allowable values
| Values |
Description |
| 0 |
No purchase restrictions. |
| 1 |
Can be purchased with qualifying plans only. |
|
| <default_ind> |
Allowable values
| Values |
Description |
| 0 |
Rate schedule is not the default. |
| 1 |
Rate schedule is the default. |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<auth_key>, <client_no> |
1033: a parameter that represents a true or false value contains invalid input
|
<include_inactive_items>, <include_service_supp_fields> |
3109: Invalid Client SKU.
|
<client_item_id> |
5029: invalid item or sku
|
<filter_item_no> |
5035: Account not in dunning. Degrade date not updated
|
<filter_client_item_id> |
25012: Invalid purchase scope input
|
<purchase_scope> |
