Skip to content

`BranchPropertyVersionList_Load_Query`#

Description#

This function is used pull the managed properties (theme components, buttons, etc) for a specific branch.

Request Body Parameters#

Parameter	Type	Description
`count`	Number	Count is used to tell Miva how many records to return.
`offset`	Offset	Used in conjunction with the Count parameter for paginating results of large datasets. Default is `0`.
`sort`	String	Field to sort results by. Available sorting fields listed below. Use `-` prefix for a descending sort.
`filter`	Object	Array of Object containing search filters. See usage here
`branch_name` `branch_id`	String Number	Branch Name set as primary Branch ID set as primary
`changeset_id`	Number	Optional Changeset ID. If omitted, the response will include the JS Resources from the head of the Branch.

Supported Sort Columns#

One of these values would be passed in the sort request parameter to have the results sorted by that column. Value may be preceded by - for a descending sort.

Sort	Description
`id`	Branch ID

On Demand Columns#

Column	Description
`source`	Template Source
`settings`	Template Settings

Response Parameters#

Parameter	Type	Description
`total_count`	Number	Total number of records that match your search criteria.
`start_offset`	Number	Number of the starting offset number of branches to return. Used in conjunction with the Count parameter.
`prop_id`	Number	Property ID
`type`	String	Property Type
`code`	String	Managed Property Code
`product_id`	Number	Product ID set if property is associated with a product such as a product header
`cat_id`	Number	Category ID set only if property is associated with a category such as a category header
`sync`	Boolean	Flag to Sync Template
`templ_id`	Number	Template ID if there is a template associated with Property, for example ReadyTheme Content Section
`version_id`	Number	Version ID
`version_user_id`	Number	User Id of user who created property version
`source`	String	Template Source
`settings`	Array	JSON Array containing property settings

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "BranchPropertyVersionList_Load_Query",
    "Branch_Name": "Dev Branch",
    "Count": 0,
    "Offset": 0,
    "Sort": "",
    "Filter": [
        {
            "name": "ondemandcolumns",
            "value": ["source", "settings"]
        }
    ]
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 57,
        "start_offset": 0,
        "data": [
            {
                "prop_id": 19,
                "type": "cssui_button",
                "code": "AddAllToBasket",
                "product_id": 0,
                "cat_id": 0,
                "sync": true,
                "templ_id": 25,
                "version_id": 38,
                "version_user_id": 1,
                "settings": {
                    "advanced": 1,
                    "prompt": "Add All To Basket",
                    "text": "Add All To Basket"
                },
                "source": "",
                "source_user_id": 1
            },
            {
                "prop_id": 4,
                "type": "cssui_button",
                "code": "AddToBasket",
                "product_id": 0,
                "cat_id": 0,
                "sync": true,
                "templ_id": 10,
                "version_id": 28,
                "version_user_id": 1,
                "settings": {
                    "advanced": 1,
                    "prompt": "Add To Basket",
                    "text": "Add To Basket"
                },
                "source": "",
                "source_user_id": 1
            },
            {
                "prop_id": 1,
                "type": "cssui_button",
                "code": "AddToBasketE",
                "product_id": 0,
                "cat_id": 0,
                "sync": true,
                "templ_id": 7,
                "version_id": 1,
                "version_user_id": 1,
                "settings": {
                    "advanced": 0,
                    "prompt": "Add To Basket (Expanded)",
                    "text": "Add To Basket"
                },
                "source": "",
                "source_user_id": 1
            },
            {
                "prop_id": 2,
                "type": "cssui_button",
                "code": "AddToBasketL",
                "product_id": 0,
                "cat_id": 0,
                "sync": true,
                "templ_id": 8,
                "version_id": 26,
                "version_user_id": 1,
                "settings": {
                    "advanced": 1,
                    "prompt": "Add To Basket (Line Item)",
                    "text": "Add To Basket"
                },
                "source": "",
                "source_user_id": 1
            },
            {
                "prop_id": 3,
                "type": "cssui_button",
                "code": "AddToOrder",
                "product_id": 0,
                "cat_id": 0,
                "sync": true,
                "templ_id": 9,
                "version_id": 27,
                "version_user_id": 1,
                "settings": {
                    "advanced": 1,
                    "prompt": "Add To Order",
                    "text": "Add To Order"
                },
                "source": "",
                "source_user_id": 1
            }
        ]
    }
}