This function allows you load a list of items and see if they are assigned or unassigned for a Copy Page Rule
Description#
This function allows you load a list of items and see if they are assigned or unassigned for a Copy Page Rule
Request Body Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
CopyPageRules_ID |
Integer | ID of the copy page rule. CopyPageRules_Name can be sent instead. |
|
Assigned |
Boolean | No | Include items assigned to the rule. Default is true. |
Unassigned |
Boolean | No | Include items not assigned to the rule. Default is false. |
Count |
Integer | No | Maximum number of records to return. |
Offset |
Integer | No | Number of records to skip, used with Count for pagination. |
Sort |
String | No | Field to sort results by. |
Filter |
Array | No | Search filters. See the List Load Query overview. |
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "CopyPageRulesSettingsList_Load_Query",
"CopyPageRules_ID": 3,
"Assigned": true,
"Unassigned": true,
"Filter": [],
"Sort": "code",
"Offset": 0,
"Count": 18
}
Example Response#
{
"success": 1,
"data": {
"total_count": 87,
"start_offset": 0,
"data": [
{
"id": 64,
"code": "addressbook",
"assigned": false,
"module": {
"id": 7,
"code": "cmp-cssui-addressbook",
"name": "Customer Address Book",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-cssui-addressbook.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 65,
"code": "addressfields",
"assigned": false,
"module": {
"id": 8,
"code": "cmp-cssui-addressfields",
"name": "Customer Address Fields",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-cssui-addressfields.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 73,
"code": "admin_order",
"assigned": false,
"module": {
"id": 47,
"code": "cmp-mv-adminorderfields",
"name": "Administrative Order Fields",
"provider": "Miva",
"api_ver": "5.00",
"version": "10.0000",
"module": "modules/component/cmp-mv-adminorderfields.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 43,
"code": "affiliate",
"assigned": false,
"module": {
"id": 9,
"code": "cmp-cssui-afae",
"name": "CSSUI Affiliate Add/Edit",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-cssui-afae.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 38,
"code": "affiliatelink",
"assigned": false,
"module": {
"id": 10,
"code": "cmp-cssui-afflink",
"name": "CSSUI Affiliate Sign-in Link",
"provider": "Miva",
"api_ver": "5.60",
"version": "10.0500",
"module": "modules/component/cmp-cssui-afflink.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 32,
"code": "all_products",
"assigned": true,
"module": {
"id": 35,
"code": "cmp-cssui-prodlist",
"name": "CSSUI Product List",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-cssui-prodlist.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 20,
"code": "attributemachine",
"assigned": false,
"module": {
"id": 48,
"code": "cmp-mv-attributemachine",
"name": "Attribute Machine",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-mv-attributemachine.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 66,
"code": "backorder",
"assigned": false,
"module": {
"id": 71,
"code": "cmp-mv-stdorderitemfields",
"name": "Standard Order Item Fields",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0501",
"module": "modules/component/cmp-mv-stdorderitemfields.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 40,
"code": "basket",
"assigned": false,
"module": {
"id": 12,
"code": "cmp-cssui-basket",
"name": "CSSUI Basket Contents",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0600",
"module": "modules/component/cmp-cssui-basket.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 52,
"code": "breadcrumbs",
"assigned": false,
"module": {
"id": 13,
"code": "cmp-cssui-breadcrumbs",
"name": "CSSUI Smart Breadcrumbs",
"provider": "Miva",
"api_ver": "5.60",
"version": "10.0300",
"module": "modules/component/cmp-cssui-breadcrumbs.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 36,
"code": "buttons",
"assigned": false,
"module": {
"id": 14,
"code": "cmp-cssui-buttons",
"name": "CSSUI Buttons",
"provider": "Miva",
"api_ver": "5.60",
"version": "10.0000",
"module": "modules/component/cmp-cssui-buttons.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 9,
"code": "category",
"assigned": false,
"module": {
"id": 67,
"code": "cmp-mv-stdcatfields",
"name": "Standard Category Fields",
"provider": "Miva",
"api_ver": "5.00",
"version": "10.0100",
"module": "modules/component/cmp-mv-stdcatfields.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 31,
"code": "category_listing",
"assigned": false,
"module": {
"id": 35,
"code": "cmp-cssui-prodlist",
"name": "CSSUI Product List",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-cssui-prodlist.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 27,
"code": "category_title",
"assigned": false,
"module": {
"id": 15,
"code": "cmp-cssui-cattitle",
"name": "CSSUI Category Title",
"provider": "Miva",
"api_ver": "5.60",
"version": "10.0500",
"module": "modules/component/cmp-cssui-cattitle.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 53,
"code": "category_tree",
"assigned": false,
"module": {
"id": 16,
"code": "cmp-cssui-cattree",
"name": "CSSUI Category Tree",
"provider": "Miva",
"api_ver": "5.60",
"version": "10.0500",
"module": "modules/component/cmp-cssui-cattree.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 23,
"code": "content",
"assigned": false,
"module": {
"id": 50,
"code": "cmp-mv-content",
"name": "Content",
"provider": "Miva",
"api_ver": "10.05",
"version": "10.0500",
"module": "modules/component/cmp-mv-content.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 26,
"code": "countries",
"assigned": false,
"module": {
"id": 17,
"code": "cmp-cssui-countryselect",
"name": "Country Selector",
"provider": "Miva",
"api_ver": "5.00",
"version": "10.0000",
"module": "modules/component/cmp-cssui-countryselect.mvc",
"refcount": 1,
"active": true
}
},
{
"id": 11,
"code": "cssui_links",
"assigned": false,
"module": {
"id": 27,
"code": "cmp-cssui-links",
"name": "CSSUI Links",
"provider": "Miva",
"api_ver": "5.03",
"version": "10.0000",
"module": "modules/component/cmp-cssui-links.mvc",
"refcount": 1,
"active": true
}
}
]
}
}