Home > Aria6 User Documentation > Aria6 core api > get_client_items_all

get_client_items_all

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.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
filter_currency_cd string 3 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 A boolean value that asserts the API call should include no-cost items in its returned results (true/1=yes, false/0=no).
filter_item_no long 8 Aria-assigned unique identifier indicating Client Inventory Item.
OR
filter_client_item_id string 100 Client assigned unique identifier indicating client Inventory Item.
include_inactive_items string 8 Specifies whether inactive inventory items need to be included or not   Allowable Values

Output Arguments

Field Name Field Type Description
all_client_items hash
item_no long The unique ID of the item being retrieved
item_label string The name or label for this item
service_no long The service number associated with this item, which will be used during invoicing
service_desc string The long description of the service associated with this item
client_item_id string The client-defined item ID to search for images
client_service_id string A multidimensional array of client-defined Service ID for this plan.
client_item_plan_id string client-defined item plan ID the item appears on
usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
all_service_supp_fields hash
field_name string The machine-readable name of this field
field_desc string The human-readable name of this field
field_order_no long The sort order of this field
field_value string The value stored in this field
client_sku string The client-defined product code for this item
item_plan long The plan associated with this item to assign when the item is purchased
item_months long The months to stack for this item
stock_level double The current number of this item left in stock
avg_ratings long (DEPRECATED) The average user rating of this item
num_ratings long (DEPRECATED) The number of total ratings for this item
num_reviews long (DEPRECATED) The number of user reviews for this item
item_type long The type of item, see allowable values legend  Allowable Values
item_desc string The long description of the item
active_ind long Whether or not this item is considered an active, in-stock item  Allowable Values
modify_price_ind string Whether or not the item price can be modified at sale time  Allowable Values
subunit_qty double 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 The item name of the subunit represented by a single quantity of this item
service_type string (DEPRECATED) This field is no longer used
coa_id string The system internal Chart-of-Accounts ID for this item
client_coa_code string The client-specified Chart-of-Accounts ID for this item
taxable_ind long Whether or not taxes apply to this item  Allowable Values
tax_group long If taxable, the tax group this item belongs to
usage_type long (DEPRECATED) This field is no longer used, as there are no usage fees for items
all_item_prices hash
price double The total price for this item
price_per_unit double The price for a single unit of this item
currency_cd string The ISO-compatible 3-digit currency code for the currency this item price bills in
all_item_images hash
image_class_name string The category of the image, such as thumbnail or full
image_class_no long The unique ID for the image class
image_class_seq_no long The sequence number of this image within its class
image_url string The actual URL for this image
image_text string The alt text for the image tag displaying the item image
default_ind long Whether or not this image is the default for that item  Allowable Values
all_item_supp_fields hash
field_name string The machine-readable name of this field
field_desc string The human-readable name of this field
field_order_no long The sort order of this field
field_value string The value stored in this field
all_item_classes hash
class_no long The unique ID of the item class to which this item belongs
label string The label or name for the item class
schedule hash
schedule_no long The ID of this rate schedule
schedule_name string Name for the rate schedule
client_rate_schedule_id string Client-defined unique identifier
currency_cd string Currency for the schedule
is_default string This flag denotes if this rate schedule is the default one for this plan. 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.  Allowable Values
tax_inclusive_ind string 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.
tier hash
from double Tiered pricing rule that specifies from units
to double Tiered pricing rule that specifies to units
amount double Tiered pricing rule that specifies rate per unit
description string This field is used to display custom rate tier description. This will override the rate tier's description at service level.
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by MindTouch ®