get_client_items_all_m
Summary
| API Name | get_client_items_all_m |
|---|---|
| Class | system_services_m |
| Update Version | 47 |
Description
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.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| filter_currency_cd | string | 3 | No |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
||||||
| return_no_cost_items | string | 5 | No |
Note: This field is deprecated. Aria no longer supports return_no_cost_items. |
||||||
| filter_item_no | long | 22 | No |
Aria-assigned unique identifier indicating Client Inventory Item. Alternative field: filter_client_sku |
||||||
| include_inactive_items | string | 5 | No |
Specifies whether inactive inventory items need to be included or not Allowed values:
|
||||||
| filter_client_item_id | string | 100 | No |
Note: This field is deprecated. Aria no longer supports filter_client_item_id. |
||||||
| purchase_scope | long | 1 | No |
Purchase scope for inventory item, default is null (both 0 and 1) Allowed values:
|
||||||
| include_all_service_supp_fields | string | 5 | No |
Specifies whether all_service_supp_fields array is to be populated or not Allowed values:
|
||||||
| include_all_item_images | string | 5 | No |
Specifies whether all_item_images array is to be populated or not Allowed values:
|
||||||
| include_all_item_supp_fields | string | 5 | No |
Specifies whether all_item_supp_fields array is to be populated or not Allowed values:
|
||||||
| include_all_item_classes | string | 5 | No |
Specifies whether all_item_classes array is to be populated or not Allowed values:
|
||||||
| include_nso_rate_schedule | string | 5 | No |
Specifies whether nso_rate_schedule array is to be populated or not Allowed values:
|
||||||
| limit | long | 10 | No |
Limits the number of records returned by the API. |
||||||
| offset | long | 10 | No | |||||||
| filter_client_sku | string | 100 | No |
The client defined SKU for this item Alternative field: filter_item_no |
Outputs
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Start of all_client_item_details object | ||||||||||||
| all_client_item_details | object | No | ||||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶item_no | long | No |
The unique ID of the item being retrieved |
|||||||||
| ▶item_label | string | No |
The name or label for this item |
|||||||||
| ▶service_no | long | No |
The service number associated with this item, which will be used during invoicing |
|||||||||
| ▶service_desc | string | No |
The long description of the service associated with this item |
|||||||||
| ▶client_item_id | string | 100 | No |
Note: This field is deprecated. Aria no longer supports client_item_id. |
||||||||
| ▶client_service_id | string | 100 | No |
A multidimensional array of client-defined Service ID for this plan. |
||||||||
| ▶client_item_plan_id | string | 100 | No |
client-defined item plan ID the item appears on |
||||||||
| ▶usage_type_cd | string | 100 | No |
An array containing usage_type_cd(s) to denote which usage type(s) to record. |
||||||||
| Start of all_service_supp_fields object | ||||||||||||
| ▶all_service_supp_fields | object | No |
An array containing the inventory item service's supplemental fields' field_name, field_desc, field_order_no, and field_value. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶▶field_name | string | No |
The machine-readable name of this field |
|||||||||
| ▶▶field_desc | string | No |
The human-readable name of this field |
|||||||||
| ▶▶field_order_no | long | No |
The sort order of this field |
|||||||||
| ▶▶field_value | string | No |
The value stored in this field |
|||||||||
| End of all_service_supp_fields object | ||||||||||||
| ▶client_sku | string | No | ||||||||||
| ▶item_plan | long | No |
The plan associated with this item to assign when the item is purchased |
|||||||||
| ▶item_months | long | No |
The months to stack for this item |
|||||||||
| ▶stock_level | double | No |
The current number of this item left in stock |
|||||||||
| ▶avg_ratings | long | No |
(DEPRECATED) The average user rating of this item |
|||||||||
| ▶num_ratings | long | No |
(DEPRECATED) The number of total ratings for this item |
|||||||||
| ▶num_reviews | long | No |
(DEPRECATED) The number of user reviews for this item |
|||||||||
| ▶item_type | long | No |
The type of item, see allowable values legend Allowed values:
|
|||||||||
| ▶item_desc | string | No |
The long description of the item |
|||||||||
| ▶active_ind | long | No |
Whether or not this item is considered an active, in-stock item Allowed values:
|
|||||||||
| ▶modify_price_ind | string | No |
Whether or not the item price can be modified at sale time Allowed values:
|
|||||||||
| ▶subunit_qty | double | No |
Allows the client to associate a quantity of an arbitrary virtual item which is associated with a single unit of this item (e.g. 500 gold pieces) |
|||||||||
| ▶subunit_label | string | No |
The item name of the subunit represented by a single quantity of this item |
|||||||||
| ▶service_type | string | No |
(DEPRECATED) This field is no longer used |
|||||||||
| ▶coa_id | string | No |
The system internal Chart-of-Accounts ID for this item |
|||||||||
| ▶client_coa_code | string | No |
The client-specified Chart-of-Accounts ID for this item |
|||||||||
| ▶taxable_ind | long | No |
Whether or not taxes apply to this item Allowed values:
|
|||||||||
| ▶tax_group | long | No |
If taxable, the tax group this item belongs to |
|||||||||
| ▶usage_type | long | No |
Purchase scope for inventory item, default is null (both 0 and 1) |
|||||||||
| ▶purchase_scope | long | No |
Purchase scope for inventory item, default is null (both 0 and 1) Allowed values:
|
|||||||||
| ▶all_item_prices | object | No |
Note: This field is deprecated. Aria no longer supports all_item_prices. |
|||||||||
| Start of all_item_images object | ||||||||||||
| ▶all_item_images | object | No | ||||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶▶image_class_name | string | No |
The category of the image, such as thumbnail or full |
|||||||||
| ▶▶image_class_no | long | No |
The unique ID for the image class |
|||||||||
| ▶▶image_class_seq_no | long | No |
The sequence number of this image within its class |
|||||||||
| ▶▶image_url | string | No |
The actual URL for this image |
|||||||||
| ▶▶image_text | string | No |
The alt text for the image tag displaying the item image |
|||||||||
| ▶▶default_ind | long | No |
Whether or not this image is the default for that item |
|||||||||
| End of all_item_images object | ||||||||||||
| Start of all_item_supp_fields object | ||||||||||||
| ▶all_item_supp_fields | object | No |
An array containing the inventory item supplemental fields' field_name, field_desc, field_order_no, and field_value. |
|||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶▶field_name | string | No |
The machine-readable name of this field |
|||||||||
| ▶▶field_desc | string | No |
The human-readable name of this field |
|||||||||
| ▶▶field_order_no | long | No |
The sort order of this field |
|||||||||
| ▶▶field_value | string | No |
The value stored in this field |
|||||||||
| End of all_item_supp_fields object | ||||||||||||
| Start of all_item_classes object | ||||||||||||
| ▶all_item_classes | object | No | ||||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶▶class_no | long | No |
The unique ID of the item class to which this item belongs |
|||||||||
| ▶▶label | string | No |
The label or name for the item class |
|||||||||
| End of all_item_classes object | ||||||||||||
| Start of nso_rate_schedules object | ||||||||||||
| ▶nso_rate_schedules | object | No | ||||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶▶rate_schedule_no | long | No |
The ID of this rate schedule |
|||||||||
| ▶▶rate_schedule_name | string | No |
Name for the rate schedule |
|||||||||
| ▶▶client_rate_schedule_id | string | No |
Client-defined unique identifier |
|||||||||
| ▶▶currency_cd | string | No |
Currency for the schedule |
|||||||||
| ▶▶is_default | string | No |
This flag denotes if this rate schedule is the default one for this item. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule for a given currency denoting it is the default. For subsequent rate schedules, the default is set to 0. |
|||||||||
| ▶▶tax_inclusive_ind | string | No |
This flag denotes if a rate is inclusive of taxes. Valid values are: 1 - Means tax inclusive rates and 0 (default) - Means tax exclusive rates. Allowed values:
|
|||||||||
| Start of nso_rate_tiers object | ||||||||||||
| ▶▶nso_rate_tiers | object | No | ||||||||||
| Name | Type | Length | Required | Description | ||||||||
| ▶▶▶rate_seq_no | long | No |
Sequential number in the rate schedule for dertermining tiers |
|||||||||
| ▶▶▶from_unit | double | No |
Specifies the starting unit for the given tier. |
|||||||||
| ▶▶▶to_unit | double | No |
Specifies the ending unit for the given tier |
|||||||||
| ▶▶▶rate_per_unit | double | No |
Specifies the rate per unit billed. |
|||||||||
| ▶▶▶description | string | No |
This field is used to display custom rate tier description. This will override the rate tier's description at service level. |
|||||||||
| End of nso_rate_tiers object | ||||||||||||
| End of nso_rate_schedules object | ||||||||||||
| End of all_client_item_details object | ||||||||||||
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|||||||||
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|||||||||