Created by potrace 1.16, written by Peter Selinger 2001-2019

Miva Developer Docs

Productmodified

Previous Next

Adds a product to the Product Data Fields and Feeds queue, removes it, or triggers the queue to run.

Marks a product as modified for the Product Data Fields and Feeds module. It can add the product to the queue for processing, delete it from the queue, and trigger the queue to be processed. It’s a module function, so Function is always Module, Module_Code is productdata and Module_Function is ProductModified.

Note

The Product Data Fields and Feeds module must be installed in order to be used. Because this is a module level function you’ll need to use the following format to whitelist the function for your API token:

Module:productdata:ProductModified

Before you begin#

  • The API token needs Module:productdata:ProductModified, either assigned directly under Functions or through a group. See Create an API token.
  • Requests must be signed if the token requires it. See Make a signed request with HMAC.
  • The Product Data Fields and Feeds module must be installed.

Example requests#

Queue a product and trigger processing#

Adds the product to the queue for the searchfeed data field and triggers the queue to run.

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "Module",
    "Module_Code": "productdata",
    "Module_Function": "ProductModified",
    "Product_Code": "{{Product_Code}}",
    "ProductDataField_Code": "searchfeed",
    "Queue": true,
    "Delete": false,
    "Trigger": true
}

Request parameters#

Parameter Type Required Description
Function String Yes For Module level functions this will always have the value of: “Module”
Module_Code String Module Code. Always productdata for this function
Module_Function String Function to execute. Always ProductModified for this function.
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
ProductDataField_Code String The code of the data field which should get processed.
Queue Boolean No Boolean Value if the product should be added to the queue
Delete Boolean No Boolean Value if the Product should be deleted from the queue
Trigger Boolean No Boolean Value if the function call should trigger the scheduled task to run to process the queue. The trigger value must also be configured at the Data Field level in the module.

Example response#

{
    "success": 1
}

Response parameters#

Name Description
success boolean value for if the request was successful

Error responses#

Error Code Error Message Error Description
invalid_function Invalid Function Request syntax is incorrect. This is a module level function, so “Module” needs to be passed in the Function Parameter.
invalid_module Invalid Module Request syntax is incorrect. This is a module level function, so Module_Code parameter needs to be “productdata”.
Function Use it to
Product_Update Change a product
Product_Insert Create a product
ProductList_Load_Query Find products

Try in Postman#

This function isn’t in the Miva Postman collection yet. See Set Up Postman to send it with your own request.

ProductList_Load_Query ProductPaymentRules_Update