This function loads a list of custom fields so you can manually assign them to a copy product rule.
Description#
This function loads a list of custom fields so you can manually assign them to a copy product rule.
Request Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
CopyProductRules_IDCopyProductRules_Name |
Integer String |
ID of the copy product rule Name of the copy product rule. One of the two is required. |
|
Assigned |
Boolean | No | Include custom fields assigned to the rule. Defaults to true. |
Unassigned |
Boolean | No | Include custom fields not assigned to the rule. Defaults to false. |
Count |
Integer | No | Count is used to tell Miva how many records to return. |
Offset |
Integer | Used in conjunction with the Count parameter for paginating results of large datasets. Must not be negative. | |
Sort |
String | No | Field to sort results by. |
Filter |
Array | No | Search filters. Filterable fields are module_name, field_code and field_name. See usage here |
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "CopyProductRulesCustomFieldList_Load_Query",
"CopyProductRules_ID": 4,
"Assigned": true,
"Unassigned": true,
"Filter": [],
"Sort": "module_name",
"Offset": 0,
"Count": 18
}
Example Response#
{
"success": 1,
"data": {
"total_count": 6,
"start_offset": 0,
"data": [
{
"rules_id": 4,
"assigned": false,
"field_code": "footer",
"field_name": "Product Footer",
"module": {
"id": 33,
"code": "cmp-cssui-pchdft",
"name": "CSSUI Product/Category Header & Footer",
"provider": "Miva",
"api_ver": "5.72",
"version": "10.0100",
"module": "modules/component/cmp-cssui-pchdft.mvc",
"refcount": 1,
"active": true
}
},
{
"rules_id": 4,
"assigned": false,
"field_code": "header",
"field_name": "Product Header",
"module": {
"id": 33,
"code": "cmp-cssui-pchdft",
"name": "CSSUI Product/Category Header & Footer",
"provider": "Miva",
"api_ver": "5.72",
"version": "10.0100",
"module": "modules/component/cmp-cssui-pchdft.mvc",
"refcount": 1,
"active": true
}
},
{
"rules_id": 4,
"assigned": false,
"field_code": "tabs_reviews",
"field_name": "Reviews",
"module": {
"id": 163,
"code": "customfields",
"name": "Custom Fields",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0501",
"module": "modules/util/customfld.mvc",
"refcount": 1,
"active": true
}
},
{
"rules_id": 4,
"assigned": false,
"field_code": "tabs_specifications",
"field_name": "Specifications",
"module": {
"id": 163,
"code": "customfields",
"name": "Custom Fields",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0501",
"module": "modules/util/customfld.mvc",
"refcount": 1,
"active": true
}
},
{
"rules_id": 4,
"assigned": false,
"field_code": "description",
"field_name": "META Description",
"module": {
"id": 61,
"code": "cmp-mv-prodctgy-meta",
"name": "Product/Category META-Tag Settings",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-mv-prodctgy-meta.mvc",
"refcount": 1,
"active": true
}
},
{
"rules_id": 4,
"assigned": false,
"field_code": "keywords",
"field_name": "META Keywords",
"module": {
"id": 61,
"code": "cmp-mv-prodctgy-meta",
"name": "Product/Category META-Tag Settings",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-mv-prodctgy-meta.mvc",
"refcount": 1,
"active": true
}
}
]
}
}