24/7 Support: 800.608.6482

Navigation


BranchTemplateVersionList_Load_Query

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

This funciton is used pull the page templates and page settings for a specific branch.

Request Body Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many branches you want returned. If for example you are querying thousands of branches 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 templates 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.
id Type:
Number
Title:
Template Version ID
Template Version ID
templ_id Type:
Number
Title:
Template ID
Template ID
user_id Type:
Number
Title:
User ID
Admin User ID of the user who created the template version.
parent_id Type:
Number
Title:
Parent ID
Parent ID - Used for Theme Component Templates
prop_id Type:
Number
Title:
Property ID
ID of Managed Property
sync Type:
Boolean
Title:
Sync
Boolean flag sync template
filename Type:
String
Title:
Filename
Filename of template
dtstamp Type:
Unix Timestamp
Title:
Date/Time Stamp
Date/Timestamp for when template version was created
source Type:
String
Title:
Source
Template Source
settings Type:
Array
Title:
Settings
JSON Array of Object defining the settings for each template and component assigned to the page. Not all templates will have settings and different types of template will have completely different 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 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.