ProductURIList_Load_Query
#
Description#
This function loads a list of URI’s for a product.
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 |
total_count |
Number | The total number of URI’s returned for the product |
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 product |
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": "ProductURIList_Load_Query",
"Product_ID": 1,
"Filter": "",
"Sort": "uri",
"Offset": 0,
"Count": 39
}
Example Response#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "ProductURIList_Load_Query",
"Product_ID": 1,
"Filter": "",
"Sort": "uri",
"Offset": 0,
"Count": 39
}
Error Responses#
Error Code | Error Message | Error Description |
---|---|---|
MER-JSN-PRD-00070 |
Product not found | Product id is not found |