Skip to content

`CategoryURIList_Load_Query`#

Description#

This function loads a list of URIs for a category.

Request Parameters#

Parameter	Type	Description
`count`	Number	Count is used to tell Miva how many records to return.
`offset`	Offset	Used in conjunction with the Count parameter for paginating results of large datasets. Default is `0`.
`sort`	String	Field to sort results by. Available sorting fields listed below. Use `-` prefix for a descending sort.
`filter`	Object	Array of Object containing search filters. See usage here
`category_id` `category_code` `edit_category`	Number String String	The category id being updated The category code being updated The category name being updated

Response Parameters#

Parameter	Type	Description
`success`	Boolean	Boolean value indicating if the API request was successful
`total_count`	Number	The total number of URIs returned for the category
`start_offset`	Number	Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
`id`	Number	URI id for the category
`uri`	String	The relative path for the URI
`store_id`	Number	The id number of the store
`screen`	String	The screen description
`page_id`	Number	The id number of the page
`cat_id`	Number	The id number of the category
`product_id`	Number	The id number of the product
`feed_id`	Number	The id number of the feed
`canonical`	Boolean	Boolean value indicating if the URI is canonical
`status`	Number	The status response number for the URI

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "CategoryURIList_Load_Query",
    "Category_ID": 1,
    "Filter": "",
    "Sort": "uri",
    "Offset": 0,
    "Count": 39
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 1,
        "start_offset": 0,
        "data": [
            {
                "id": 68,
                "uri": "/category-1.html",
                "store_id": 1,
                "screen": "",
                "page_id": 0,
                "cat_id": 1,
                "product_id": 0,
                "feed_id": 0,
                "canonical": true,
                "status": 200
            }
        ]
    }
}