Update product availability (SHOPPERTISE API)

POST

/api/shoppertise/product/availability

Updates the availability of one or more products for a given outlet. Omnihub calls the Shoppertise platform API (PUT {SHOPPERTISE_API_URL}/partner/v1/batch/menu) to push the changes. Auth is via an OAuth access token from the Shoppertise token endpoint.

availableStatus values:

AVAILABLE — product is in stock and visible.

UNAVAILABLE — product is temporarily out of stock (shown but not orderable).

HIDE — product is removed from the listing entirely.

Flow:

Caller POSTs here with partnerMerchantID and the items array.

Omnihub authenticates against Shoppertise and PUTs { merchantID, field: "ITEM", menuEntities } to {SHOPPERTISE_API_URL}/partner/v1/batch/menu.

Callbacks

availabilityUpdate

Request

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Availability updated locally and push notification sent to third party.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/shoppertise/product/availability' \
--header 'Content-Type: application/json' \
--data '{
    "partnerMerchantID": "DGFBPC",
    "merchantID": "SHOPPERTISE",
    "items": [
        {
            "id": "DYNAMOD-GFBP071",
            "sku": "GFBP071",
            "availableStatus": "UNAVAILABLE"
        },
        {
            "id": "DYNAMOD-GFBP062",
            "sku": "GFBP062",
            "availableStatus": "AVAILABLE"
        },
        {
            "id": "DYNAMOD-GFBP090",
            "sku": null,
            "availableStatus": "HIDE"
        }
    ]
}'

Response Example

200 - Success

{
    "status": "success",
    "message": "Availability updated and notification sent",
    "partnerMerchantID": "DGFBPC",
    "updated": 2
}

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

Notify Shoppertise to pull menu (SHOPPERTISE API)

Order