BranchList_Load_Query

This function is used to load a list of Template Branches from a Miva Store.

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

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: Branch ID	Template Branch ID
immutable	Type: Boolean	Title: Immutable	Flag for whether the branch is immutable
branchkey	Type: String	Title: Branch Key	Unique Identifier for Branch
name	Type: String	Title: Branch Name	Branch Name
color	Type: String	Title: Color	Branch Color Chip Color. Hex value including #
is_primary	Type: Boolean	Title: Is Primary	Boolean flag to identify the primary branch. This is the branch live traffic is seeing.
is_working	Type: Boolean	Title: Is Working	Boolean flag to identify the working branch. This is the branch user is currently viewing in the admin.
preview_url	Type: String	Title: Preview URL	Preview URL to this specific branch