24/7 Support: 800.608.6482

Navigation


AttributeAndOptionList_Load_Product

This function loads a list of attributes and options for a product.

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 And Option List Load Product
The name of the function being executed
customer_id Type:
Number
Title:
Customer Id
Customer Id
product_id Type:
Number
Title:
Product Id
The id number of the product to be loaded

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
id Type:
Number
Title:
List Id
Attribute and option list id.
product_id Type:
Number
Title:
Product Id
The id number of the product
default_id Type:
Number
Title:
Default Id
Default id number of the product
disp_order Type:
Number
Title:
Display Order
Number indicating the position in the product display order
code Type:
String
Title:
Attribute Code
Attribute code
type Type:
String
Title:
Attribute Type
Attribute Type
attemp_id Type:
Number
Title:
Attribute Template ID
The id number of the attribute template
prompt Type:
String
Title:
Attribute Prompt
Name of the attribute prompt
price Type:
Number
Title:
Attribute Retail Price
Attribute price
formatted_price Type:
String
Title:
Currency Formatted Attribute Retail Price
Retail formatted total
cost Type:
Number
Title:
Attribute Cost
The cost of the attribute
formatted_cost Type:
String
Title:
Currency Formatted Attribute Cost
Cost formatted total
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 the attribute image
attributes
+ Show Properties
Type:
Object
Title:
Product Attributes
Product Attributes
id Type:
Number
Title:
Attribute Id
Attribute id
attemp_id Type:
Number
Title:
Attribute Template Id
The id number of attribute template
default_id Type:
Number
Title:
Default Id
Default id number of the product
disp_order Type:
Number
Title:
Display Order
Number indicating the position in the attribute display order
code Type:
String
Title:
Attribute Code
Attribute code
type Type:
String
Title:
Attribute Selector Type
Attribute selector type
prompt Type:
String
Title:
Attribute Prompt
Name of the attribute prompt
price Type:
Number
Title:
Attribute Retail Price
Attribute price
formatted_price Type:
String
Title:
Currency Formatted Attribute Retail Price
Retail formatted total
cost Type:
Number
Title:
Attribute Cost
The cost of the attribute
formatted_cost Type:
String
Title:
Currency Formatted Attribute Cost
Cost formatted total
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 the attribute image
options
+ Show Properties
Type:
Object
Title:
Product Attribute Options
Product Attribute Options
id Type:
Number
Title:
Attribute Option Id
Attribute option id
attemp_id Type:
Number
Title:
Attribute Template Id
The id number of attribute template
attmpat_id Type:
Number
Title:
Attribute Template Attribute Option ID
The id number of the attribute option in the attribute template
disp_order Type:
Number
Title:
Display Order
Number indicating the position in the attribute option display order
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
Retail price of the attribute option
formatted_price Type:
String
Title:
Currency Formatted Attribute Option Retail Price
Attribute option retail formatted total
cost Type:
Number
Title:
Attribute Option Cost
The cost of the attribute option
formatted_cost Type:
String
Title:
Currency Formatted Attribute Option Cost
Attribute option cost formatted total
weight Type:
Number
Title:
Attribute Option Weight
The weight of the attribute option
image Type:
String
Title:
Attribute Image
Filepath for the attribute option image

Example Request

Example Response

Error Responses

error code:
MER-CUS-JSN-00001
error message:
Customer not found
description:
Customer id is not found
error code:
MER-JSN-PRD-00070
error message:
Product not found
description:
Product id is not found

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