Skip to content

AttributeTemplateList_Load_Query#


Description#

This function loads a list of attribute templates.

Request Parameters#

Parameter
Type Description
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 Number 1 indicating a successful request.
0 indicating an unsuccessful request.
total_count Number The count of attribute templates returned
start_offset Number Determines starting pagination for response dataset. Default 0 is no offset
id Number Attribute template id
code String Attribute template code
prompt String The prompt offered for selecting the attribute
refcount Number The number of codes returned in the attribute template id response

Example Request#

{
    "Store_code": "beta",
    "Function": "AttributeTemplateList_Load_Query",
    "Filter": [],
    "Sort": "id",
    "Offset": 0,
    "Count": 36
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 2,
        "start_offset": 0,
        "data": [
            {
                "id": 1,
                "code": "size",
                "prompt": "Size",
                "refcount": 1
            },
            {
                "id": 2,
                "code": "color",
                "prompt": "Color",
                "refcount": 1
            }
        ]
    }
}