Skip to main content

Product Update

Product Update API is essential for updating product details utilized in features like price drop or back in stock alerts. If you're using these alert features, employ this API to communicate the latest product price and back in stock details. This enables timely notifications about any updates.

POST
 https://api.pushengage.com/apiv1/products

Request Parameters

Parameter NameTypeRequiredDescription
productsProduct[]YesAn array of products to be updated. Refer to the product object section for more details.

Response Object

Parameter NameTypeRequiredDescription
successBooleanYesSpecifies if the product update request was successful. Acceptable values are true or false.

Product Object

Parameter NameParameter TypeDescription
product_idStringThe ID associated with the product for alerts.
priceNumberThe updated price for the product.
availabilityStringIndicates the product's availability. It can be inStock if the product is available or outOfStock if it's not. The default value is inStock.
variant_idStringOptional. The ID for a specific product variant. Required only if variants were considered during alert setup.

Example

Request

curl -X POST \
https://api.pushengage.com/apiv1/products \
-H 'Content-Type: application/json' \
-H 'api_key: <your_pushengage_api_key>' \
-d '{
"products": [
{
"product_id": "1",
"price": 100,
"availability": "outOfStock",
"variant_id": "variantID"
},
{
"product_id": "2",
"price": 100,
"availability": "inStock",
"variant_id": "variantId2"
}
]
}'

Response

{
"success": true
}