Home > Aria6 User Documentation > Aria6 core api > get_items_by_supp_field


Returns the inventory items associated with a particular value for a supplemental object field.

Note: 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 Arguments

Req Field Name Field Type Max Length Description
Asterisk_0807a.jpg client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
Asterisk_0807a.jpg auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
Asterisk_0807a.jpg field_no long   The plan supplemental field number which is being searched against
  field_name string 300 The optional name of this supplemental field, if the number is not known
Asterisk_0807a.jpg field_val string 1000 The value of the supplemental field which all returned plans should possess

Output Arguments

Field Name Field Type Description
items_by_supp_field hash  
brd_arrow.gif item_no long The inventory item number returned from the API query.
brd_arrow.gif item_label string The label for the inventory item specified by item_no.
brd_arrow.gif service_no long Aria-assigned unique service identifier
brd_arrow.gif service_desc string The description of the service specified by service_no
brd_arrow.gif client_sku string Client-defined SKU number for this item
brd_arrow.gif price double The price of the inventory item.
brd_arrow.gif item_plan long The plan number associated with the inventory item specified by item_no.
brd_arrow.gif item_months long The months to stack for this item
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif class_no long Inventory item class number
brd_arrow.gif class_label string The inventory item class label describing the class specified by class_no.
brd_arrow.gif stock_level double The current stock-level of the item specified by item_no
brd_arrow.gif avg_ratings double An arbitrary value provided by the client to indicate user/buyer ratings for the specified item_no.
brd_arrow.gif num_ratings long The number of ratings that have been tendeder regarding this item_no.
brd_arrow.gif num_reviews long The number of user/buyer reviews for this item_no.
brd_arrow.gif image_url string The URL to the inventory item image for this item_no.
brd_arrow.gif image_text string Alternative text to display for the inventory item image if that image cannot be displayed or is not found.
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
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


This page has no custom tags.


This page has no classifications.