Notify Shoppertise to pull menu (SHOPPERTISE API)

POST

/api/shoppertise/menu/push

Triggers Omnihub to call the Shoppertise platform API (POST {SHOPPERTISE_API_URL}/partner/v1/merchant/menu/notification) so Shoppertise knows the menu is ready to be fetched. Shoppertise then calls GET /api/shoppertise/menu?partnerMerchantID=... on Omnihub to pull the updated menu.

Flow:

Caller POSTs here with partnerMerchantID.

Omnihub authenticates against Shoppertise and POSTs { merchantID } to {SHOPPERTISE_API_URL}/partner/v1/merchant/menu/notification.

Shoppertise calls GET /api/shoppertise/menu?partnerMerchantID={partnerMerchantID} to pull the menu.

Callbacks

menuSyncNotification

Request

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Menu notification sent to the Shoppertise platform.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/shoppertise/menu/push' \
--header 'Content-Type: application/json' \
--data '{
    "partnerMerchantID": "DGFBPC",
    "merchantID": "SHOPPERTISE"
}'

Response Example

200 - Success

{
    "status": "success",
    "message": "Menu push notification sent",
    "partnerMerchantID": "DGFBPC"
}

Modified at 2026-10-20 14:43:16

Get menu by partnerMerchantID

Update product availability (SHOPPERTISE API)