Skip to content

`AvailabilityGroupCategoryList_Load_Query`#

Description#

This function loads a list of product categories by Availability Group.

Request Parameters#

Parameter	Type	Description
`assigned`	Boolean	Boolean value indicating if the query returns assigned categories
`availabilitygroup_id` `availabilitygroup_name`	Number String	Availability Group ID Availability Group Name
`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
`unassigned`	Boolean	Boolean value indicating if the query returns unassigned categories

Response Parameters#

Parameter	Type	Description
`success`	Number	`1` indicating a successful request. `0` indicating an unsuccessful request. was successful
`total_count`	Number	The number of categories returned
`start_offset`	Number	The offset starting point for pagination of return data
`id`	Number	Customer id
`parent_id`	Number	Parent category id associated with the category
`agrpcount`	Number	The number of availability groups the category is assigned to
`depth`	Number	The number of parent categories
`disp_order`	Number	The display order position for the category
`code`	String	The category code
`name`	String	The category name
`page_title`	Number	The page title for the category
`active`	Boolean	Boolean value indicating if the category is active
`dt_created`	Number	Unix timestamp for the category creation date
`dt_Updated`	Number	Unix timestamp for the date the category was updated
`page_code`	String	The page code of the category
`parent_category`	String	The parent category for the category
`assigned`	Boolean	Boolean value indicating if the category is assigned

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "AvailabilityGroupCategoryList_Load_Query",
    "Assigned": true,
    "AvailabilityGroup_ID": 4,
    "Count": 18,
    "Filter": "",
    "Offset": 0,
    "Sort": "code",
    "Unassigned": true
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 11,
        "start_offset": 0,
        "data": [
            {
                "id": 1,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 1,
                "code": "category_01",
                "name": "Category 1",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1624086349,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 11,
                "parent_id": 1,
                "agrpcount": 0,
                "depth": 1,
                "disp_order": 11,
                "code": "category_01_01",
                "name": "child category 01.01",
                "page_title": "",
                "active": true,
                "dt_created": 1633159793,
                "dt_Updated": 1633160089,
                "page_code": "",
                "parent_category": "category_01",
                "assigned": false
            },
            {
                "id": 2,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 2,
                "code": "category_02",
                "name": "Category 2",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 3,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 3,
                "code": "category_03",
                "name": "Category 3",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 4,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 4,
                "code": "category_04",
                "name": "Category 4",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 10,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 10,
                "code": "featured",
                "name": "Featured Products",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 9,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 9,
                "code": "sale",
                "name": "Sale",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 5,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 5,
                "code": "sub-cat-1",
                "name": "Sub Category 1",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 6,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 6,
                "code": "sub-cat-2",
                "name": "Sub Category 2",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 7,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 7,
                "code": "sub-cat-3",
                "name": "Sub Category 3",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            },
            {
                "id": 8,
                "parent_id": 0,
                "agrpcount": 0,
                "depth": 0,
                "disp_order": 8,
                "code": "sub-cat-4",
                "name": "Sub Category 4",
                "page_title": "",
                "active": true,
                "dt_created": 1623689023,
                "dt_Updated": 1623689023,
                "page_code": "",
                "parent_category": "",
                "assigned": false
            }
        ]
    }
}