Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo Documentation > Aria Crescendo core api > get_client_items_all_m

get_client_items_all_m

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.

For information on error messages generated by this API, see get_client_items_all_m error messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png 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. The default is false, if Null is passed. (DEPRECATED)  Allowable Values
  filter_item_no long 22 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 5 Specifies whether inactive inventory items need to be included or not. The default is false, if Null is passed.  Allowable Values
  purchase_scope long 1 Purchase scope for inventory item, default is null (both 0 and 1)   Allowable Values
  include_all_service_supp_fields string 5 Specifies whether all_service_supp_fields array is to be populated or not Allowable Values
  include_all_item_images string 5 Specifies whether all_item_images array is to be populated or not Allowable Values
  include_all_item_supp_fields string 5 Specifies whether all_item_supp_fields array is to be populated or not Allowable Values
  include_all_item_classes string 5 Specifies whether all_item_classes array is to be populated or not Allowable Values
  include_nso_rate_schedule string 5 Specifies whether nso_rate_schedule array is to be populated or not Allowable Values
  limit long 10 Limits the number of records returned by the API.
  offset long 10  

Output Arguments

Field Name Field Type Description
all_client_item_details hash  
brd_arrow.gif item_no long The unique ID of the item being retrieved
brd_arrow.gif item_label string The name or label for this item
brd_arrow.gif service_no long The service number associated with this item, which will be used during invoicing
brd_arrow.gif service_desc string The long description of the service associated with this item
brd_arrow.gif client_item_id string The client-defined item ID to search for images
brd_arrow.gif client_service_id string A multidimensional array of client-defined Service ID for this plan.
brd_arrow.gif client_item_plan_id string client-defined item plan ID the item appears on
brd_arrow.gif usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
brd_arrow.gif all_service_supp_fields hash An array containing the inventory item service's supplemental fields'; field_name, field_desc, field_order_no, and field_value.
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_desc string The human-readable name of this field
brd_arrow.gif field_order_no long The sort order of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif client_sku string Client SKU of the NSO/Inventory item.
brd_arrow.gif item_plan long The plan associated with this item to assign when the item is purchased
brd_arrow.gif item_months long The months to stack for this item
brd_arrow.gif stock_level double The current number of this item left in stock
brd_arrow.gif avg_ratings long (DEPRECATED) The average user rating of this item
brd_arrow.gif num_ratings long (DEPRECATED) The number of total ratings for this item
brd_arrow.gif num_reviews long (DEPRECATED) The number of user reviews for this item
brd_arrow.gif item_type long The type of item, see allowable values legend   Allowable Values
brd_arrow.gif item_desc string The long description of the item
brd_arrow.gif active_ind long Whether or not this item is considered an active, in-stock item   Allowable Values
brd_arrow.gif modify_price_ind string Whether or not the item price can be modified at sale time   Allowable Values
brd_arrow.gif 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)
brd_arrow.gif subunit_label string The item name of the subunit represented by a single quantity of this item
brd_arrow.gif service_type string (DEPRECATED) This field is no longer used
brd_arrow.gif coa_id string The system internal Chart-of-Accounts ID for this item
brd_arrow.gif client_coa_code string The client-specified Chart-of-Accounts ID for this item
brd_arrow.gif taxable_ind long Whether or not taxes apply to this item   Allowable Values
brd_arrow.gif tax_group long If taxable, the tax group this item belongs to
brd_arrow.gif usage_type long (DEPRECATED)  This field is no longer used
brd_arrow.gif purchase_scope long Purchase scope for inventory item, default is null (both 0 and 1)   Allowable Values
brd_arrow.gif all_item_prices hash (DEPRECATED)  This is no longer used
brd_arrow.gif price double (DEPRECATED) The total price for this item
brd_arrow.gif price_per_unit double (DEPRECATED) The price for a single unit of this item
brd_arrow.gif currency_cd string (DEPRECATED) The ISO-compatible 3-digit currency code for the currency this item price bills in
brd_arrow.gif all_item_images hash  
brd_arrow.gif image_class_name string The category of the image, such as thumbnail or full
brd_arrow.gif image_class_no long The unique ID for the image class
brd_arrow.gif image_class_seq_no long The sequence number of this image within its class
brd_arrow.gif image_url string The actual URL for this image
brd_arrow.gif image_text string The alt text for the image tag displaying the item image
brd_arrow.gif default_ind long Whether or not this image is the default for that item   Allowable Values
brd_arrow.gif all_item_supp_fields hash  
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_desc string The human-readable name of this field
brd_arrow.gif field_order_no long The sort order of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif all_item_classes hash  
brd_arrow.gif class_no long The unique ID of the item class to which this item belongs
brd_arrow.gif label string The label or name for the item class
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.
nso_rate_schedules    
brd_arrow.gifrate_schedule_no long The ID of this rate schedule
brd_arrow.gifrate_schedule_name string Name for the rate schedule
brd_arrow.gifclient_rate_schedule_id string Client-defined unique identifier
brd_arrow.gifcurrency_cd string Currency for the schedule
brd_arrow.gifis_default string 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.
brd_arrow.giftax_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.
brd_arrow.gifnso_rate_tiers    
brd_arrow.gifbrd_arrow.gifrate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gifbrd_arrow.giffrom_unit double Specifies the starting unit for the given tier.
brd_arrow.gifbrd_arrow.gifto_unit double Specifies the ending unit for the given tier
brd_arrow.gifbrd_arrow.gifrate_per_unit double Specifies the rate per unit billed
brd_arrow.gifbrd_arrow.gifdescription string This field is used to display custom rate tier description. This will override the rate tier's description at service level.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.