24/7 Support: 800.608.6482

Navigation


AttributeTemplateAttributeList_Load_Query

This function loads a list of attributes and attribute options from an Attribute Template.

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 Attribute List Load Query
The name of the function being executed
attributetemplate_id Type:
Number
Title:
Attribute Template Id
The id number of the attribute template being loaded
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, "disporder" indicated display order, "-" (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
id Type:
Number
Title:
Response ID
response id
attemp_id Type:
Number
Title:
Attribute Template Id
Attribute template id
default_id Type:
Number
Title:
Default Id
The default_id of the attribute template attribute list
disporder Type:
Number
Title:
Display Order
Number indicating display order position
code Type:
String
Title:
Code
Attribute Template attribute code
type Type:
String
Title:
Attribute Type
Attribute Type
prompt Type:
String
Title:
Attribute Prompt
The prompt offered for selecting the attribute
price Type:
Number
Title:
Attribute Retail Price
The price of the attribute
cost Type:
Number
Title:
Attribute Cost
The cost of the attribute
weight Type:
Number
Title:
Attribute Weight
The weight of the attribute
required Type:
Boolean
Title:
Attribute Required
Boolean value indicating if selecting the product attribute is required for purchase
inventory Type:
Boolean
Title:
Attribute Inventory
Boolean value indicating if the product attribute is recorded in inventory
image Type:
String
Title:
Attribute Image
Filepath for Attribute Image
options
+ Show Properties
Type:
Object
Title:
Attribute Template Attribute Options
Attribute Template Attribute Options
id Type:
Number
Title:
Option Id
The id number of the option
attemp_id Type:
Number
Title:
Attribute Template ID
The id number of the attribute template
attmpat_id Type:
Number
Title:
Attribute Template Attribute Option ID
The id number of the attribute option in the attribute template
disporder Type:
Number
Title:
Display Order
Number indicating display order position for the attribute option
code Type:
String
Title:
Attribute Option Code
Attribute option code
prompt Type:
String
Title:
Attribute Option Prompt
Name of the attribute option prompt
price Type:
Number
Title:
Attribute Option Retail Price
Attribute option price
cost Type:
Number
Title:
Attribute Option Cost
The cost of the attribute option
weight Type:
Number
Title:
Attribute Option Weight
The weight of the attribute option
image Type:
String
Title:
Attribute Option Image
Filepath for the attribute option image
default_opt Type:
Boolean
Title:
Attribute Template Attribute Option Default
Boolean value indicating if the attribute option is the default selection for the Attribute Template

Example Request

Example Response

Error Responses

error code:
MER-UTL-QUOTES-00032
error message:
Attribute template not found
description:
Attribute template not found

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 – 2021 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.