This function loads a list of modules which have product related data. The assigned field is used to determine if this modules data will be copied as part of the copy product rule.
Description#
This function loads a list of modules which have product related data. The assigned field is used to determine if this modules data will be copied as part of the copy product rule.
Request Body Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
CopyProductRules_IDCopyProductRules_Name |
Integer String |
Required. One of these identifies the copy product rule: its ID, or its name. | |
Assigned |
Boolean | No | Return modules assigned to the rule. Default is true. |
Unassigned |
Boolean | No | Return modules not assigned to the rule. Default is false. |
Filter |
Array | No | Array of objects containing search filters. See usage here |
Sort |
String | No | Field to sort results by. Use - prefix for a descending sort. |
Offset |
Integer | Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0. |
|
Count |
Integer | No | Number of records to return. Default is 0. |
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "CopyProductRulesModuleList_Load_Query",
"CopyProductRules_ID": 4,
"Assigned": true,
"Unassigned": true,
"Filter": [],
"Sort": "module_name",
"Offset": 0,
"Count": 24
}
Example Response#
{
"success": 1,
"data": {
"total_count": 4,
"start_offset": 0,
"data": [
{
"rules_id": 4,
"assigned": false,
"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,
"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,
"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,
"module": {
"id": 91,
"code": "discount_volume",
"name": "Volume Pricing",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules\/discount\/volume.mvc",
"refcount": 1,
"active": true
}
}
]
}
}
```