This 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.
Error Codes:
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1033: a parameter that represents a true or false value contains invalid input
Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write
|
<include_inactive_items>, <include_service_supp_fields> |
3109: Invalid Client SKU.
Associated Inputs: client_item_id, inventory_items
|
<client_item_id> |
5029: invalid item or sku
Associated Inputs: filter_item_no, filter_client_item_id, client_sku
|
<filter_item_no> |
5035: Account not in dunning. Degrade date not updated
Associated Input: filter_client_item_id
|
<filter_client_item_id> |
25012: Invalid purchase scope input
Associated Input: purchase_scope
|
<purchase_scope> |
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. |
|
