get_items_by_supp_field_m
Summary
| API Name | get_items_by_supp_field_m |
|---|---|
| Class | system_services_m |
| Update Version | 6.40 |
Description
Returns the inventory items associated with a particular value for a supplemental object field.
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. |
| field_no | long | Yes |
The plan supplemental field number which is being searched against Alternative required field: field_name |
|
| field_val | string | 1000 | Yes |
The value of the supplemental field which all returned plans should possess |
| field_name | string | 300 | Yes |
The optional name of this supplemental field, if the number is not known Alternative required field: field_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| items_by_supp_field | object | No | ||
| 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. |
items_by_supp_field fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| item_no | long | No |
The inventory item number returned from the API query. |
|
| item_label | string | No |
The label for the inventory item specified by item_no. |
|
| service_no | long | No |
Aria-assigned unique service identifier |
|
| service_desc | string | No |
The description of the service specified by service_no |
|
| client_sku | string | No | ||
| price | double | No |
The price of the inventory item. |
|
| item_plan | long | No |
The plan number associated with the inventory item specified by item_no. |
|
| item_months | long | No |
The months to stack for this item |
|
| currency_cd | string | No |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
|
| class_no | long | No |
Inventory item class number |
|
| class_label | string | No |
The inventory item class label describing the class specified by class_no. |
|
| stock_level | double | No |
The current stock-level of the item specified by item_no |
|
| avg_ratings | double | No |
An arbitrary value provided by the client to indicate user/buyer ratings for the specified item_no. |
|
| num_ratings | long | No |
The number of ratings that have been tendeder regarding this item_no. |
|
| num_reviews | long | No |
The number of user/buyer reviews for this item_no. |
|
| image_url | string | No |
The URL to the inventory item image for this item_no. |
|
| image_text | string | No |
Alternative text to display for the inventory item image if that image cannot be displayed or is not found. |
|
| 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 |