Skip to content

`ProductKitList_Load_Query`#

Description#

This function loads a list of products in a product kit.

Request Parameters#

Parameter	Type	Description
`product_id` `Edit_Product` `Product_Code` `Product_SKU`	Number String String String	ID Number of product Product code string Product code string Product SKU string
`count`	Number	Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
`filter`	String	A string for filtering returned data
`offset`	Number	Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
`sort`	String	The order for sorting returned data

Response Parameters#

Parameter	Type	Description
`success`	Boolean	Boolean value indicating if the api request was successful
`data`	Object	An object containing the data returned from the request
`data`	Array	An array of objects containing product information
`attr_id`	Number	Attribute id for the product
`attr_type`	String	Attribute Type
`attr_code`	String	Attribute code
`attr_prompt`	String	Name of the attribute prompt
`attmpat_id`	Number	The attribute id number of the attribute template
`option_id`	Number	The id number of the option
`option_code`	String	The option code
`option_prompt`	String	Name of the option prompt
`start_offset`	Number	Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
`total_count`	Number	The total number of items returned in the product kit

Example Request#

{
    "Store_code": "beta",
    "Function": "ProductKitList_Load_Query",
    "Product_ID": 1,
    "Filter": "",
    "Sort": "disp_order",
    "Offset": 0,
    "Count": 39
}

Example Response#

{
    "success": 1,
    "data": {
        "data": [
            {
                "attr_id": 9,
                "attr_type": "select",
                "attr_code": "size",
                "attr_prompt": "Size",
                "attmpat_id": 1,
                "option_id": 1,
                "option_code": "SM",
                "option_prompt": "small"
            },
            {
                "attr_id": 9,
                "attr_type": "select",
                "attr_code": "size",
                "attr_prompt": "Size",
                "attmpat_id": 1,
                "option_id": 2,
                "option_code": "MED",
                "option_prompt": "medium"
            },
            {
                "attr_id": 9,
                "attr_type": "select",
                "attr_code": "size",
                "attr_prompt": "Size",
                "attmpat_id": 1,
                "option_id": 3,
                "option_code": "LG",
                "option_prompt": "large"
            },
            {
                "attr_id": 9,
                "attr_type": "select",
                "attr_code": "size",
                "attr_prompt": "Size",
                "attmpat_id": 1,
                "option_id": 4,
                "option_code": "XL",
                "option_prompt": "x-large"
            }
        ],
        "start_offset": 0,
        "total_count": 4
    }
}

Error Responses#

Error Code	Error Message	Error Description
`MER-JSN-PRD-00070`	Product not found	Product id is not found