24/7 Support: 800.608.6482

Navigation


FeedURIList_Load_Query

This function loads a list of URI's for a feed.

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:
Feed URI List Load Query
The name of the function being executed
feed_id Type:
Number
Title:
Feed ID
The id number of the feed
filter Type:
String
Title:
Filter
A string for filtering returned data
sort Type:
String
Title:
Sort
The order for sorting returned data
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
count Type:
Number
Title:
Count
Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
total_count Type:
Number
Title:
Total Count
The total number of URI's returned for the feed
start_offset Type:
Number
Title:
Start Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
id Type:
Number
Title:
URI Id
URI id for the feed
uri Type:
String
Title:
URI Path
The relative path for the URI
store_id Type:
Number
Title:
Store ID
The id number of the store
screen Type:
String
Title:
Screen
The screen description
page_id Type:
Number
Title:
Page ID
The id number of the page
cat_id Type:
Number
Title:
Category ID
The id number of the category
product_id Type:
Number
Title:
Product ID
The id number of the product
feed_id Type:
Number
Title:
Feed ID
The id number of the feed
canonical Type:
Boolean
Title:
URI Canonical Status
Boolean value indicating if the URI is canonical
status Type:
Number
Title:
URI Status
The status response number for the URI

Example Request

Example Response

Error Responses

error code:
MER-FDS-JSON-00012
error message:
Feed not found
description:
Feed not found

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