24/7 Support: 800.608.6482

Navigation


AttributeTemplateList_Load_Query

This function loads a list of attribute templates.

Request Parameters

store_code Type:
String
Title:
Store Code
Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String
Title:
Attribute Template List Load Query
The name of the function being executed
filter Type:
Object
Title:
Filter
Array of objects containing search filters. See usage here: List Load Query Overview
sort Type:
String
Title:
Sort
The order for sorting any returned data, "id" indicated display by attribute template id, "-" (negative parameter sorts notes in descending order)
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
count Type:
Number
Title:
Count
Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
total_count Type:
Number
Title:
Total Count
The count of attribute templates returned
start_offset Type:
Number
Title:
Start Offset
Determines starting pagination for response dataset. Default 0 is no offset.
id Type:
Number
Title:
Attribute Template ID
Attribute template id
code Type:
String
Title:
Attribute Template Code
Attribute template code
prompt Type:
String
Title:
Attribute Prompt
The prompt offered for selecting the attribute
refcount Type:
Number
Title:
Reference Count
The number of codes returned in the attribute template id response

Example Request

Example Response

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.