Home > Aria6 User Documentation > Aria6 core api > get_items_by_supp_field
get_items_by_supp_field
get_items_by_supp_field
Table of contents
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 |
|---|---|---|---|---|
 |
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. |
|
field_no | long | The plan supplemental field number which is being searched against | |
| OR | ||||
| field_name | string | 300 | The optional name of this supplemental field, if the number is not known | |
|
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 | |
 item_no |
long | The inventory item number returned from the API query. |
| item_label |
string | The label for the inventory item specified by item_no. |
| service_no |
long | Aria-assigned unique service identifier |
| service_desc |
string | The description of the service specified by service_no |
| client_sku |
string | Client-defined SKU number for this item |
| price |
double | The price of the inventory item. |
| item_plan |
long | The plan number associated with the inventory item specified by item_no. |
| item_months |
long | The months to stack for this item |
| currency_cd |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
| class_no |
long | Inventory item class number |
| class_label |
string | The inventory item class label describing the class specified by class_no. |
| stock_level |
double | The current stock-level of the item specified by item_no |
| avg_ratings |
double | An arbitrary value provided by the client to indicate user/buyer ratings for the specified item_no. |
| num_ratings |
long | The number of ratings that have been tendeder regarding this item_no. |
| num_reviews |
long | The number of user/buyer reviews for this item_no. |
| image_url |
string | The URL to the inventory item image for this item_no. |
| image_text |
string | Alternative text to display for the inventory item image if that image cannot be displayed or is not found. |
| 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 |
| 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. |
- © Copyright 2023 Aria Developer Central