24/7 Support: 800.608.6482

Navigation

BranchPropertyVersionList_Load_Query

An Optional Changeset_ID may be passed. If omitted the respose will include properties from the head.

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

Request Body Parameters

count Type:
Number		 Title:
Count		 Count is used to tell Miva how many properties you want returned. If for example you are querying thousands of properties you'll want to set the count to limit how many you get back in a single request.
offset Type:
Offset		 Title:
Number		 Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0 whcih is no offset.
sort Type:
String		 Title:
Sort		 Field to sort results by. Avaiilable sorting fields listed above. Use - prefix for a decending sort.
Filter Type:
Object		 Title:
Filter		 Array of Object containing search filters. See usage here: List Load Query Overview
Branch_Name Type:
String		 Title:
Branch Name		 Name of Branch you want to pull templates from
Changeset_ID Type:
Number		 Title:
Changeset ID		 Optional Changeset ID. If omitted, the response will include properties from the head of the Branch

On Demand Columns

source Template Source
settings Template Settings

Response Parameters

total_count Type:
Number		 Title:
Total Product Count		 total_count is the total number of records that match your search criteria. Note: this is not always the total products returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
start_offset Type:
Number		 Title:
Start Offset		 Number number of the starting offset number of branches to return. Used in conjunction with the Count parameter for paginating results of large datasets.
prop_id Type:
Number		 Title:
Property ID		 Property ID
type Type:
String		 Title:
Property Type		 One of: cssui_button, readytheme_lookandfeel, readytheme_banner, readytheme_contentsection, readytheme_image, readytheme_nagivationset, readytheme_productlisting, header, footer
code Type:
String		 Title:
Property Code		 Managed Property Code
product_id Type:
Number		 Title:
Product ID		 Product ID set if property is associated with a product such as a product header
cat_id Type:
Number		 Title:
Category ID		 Category ID set only if property is associated with a category such as a category header
sync Type:
Boolean		 Title:
Sync		 Flag to Sync Template
templ_id Type:
Number		 Title:
Template ID		 Template ID if there is a template associated with Property, for example ReadyTheme Content Section
version_id Type:
Number		 Title:
Version ID		 Version ID
version_user_id Type:
Number		 Title:
Version User ID		 User Id of user who created property version
source Type:
String		 Title:
Source		 Template Source
settings Type:
Array		 Title:
Settings		 JSON Array containing property settings

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.