1. Menu
Omnihub - Shoppertise
  • Shoppertise
    • Outlets
      • List Shoppertise outlets
      • Outlet detail
    • Orders
      • Order webhook (new order intake)
      • Update order status
      • List orders (paginated)
      • Order detail
    • Menu
      • Get menu by partnerMerchantID
        GET
      • Notify Shoppertise to pull menu (SHOPPERTISE API)
        POST
    • Availability
      • Update product availability (SHOPPERTISE API)
    • Schemas
      • Order
      • Currency
      • Price
      • OrderItem
      • Campaign
      • CampaignFreeItem
      • Modifier
      • Receiver
      • VirtualContact
      • OrderCancelRequest
      • OutletSummary
      • OutletDetail
      • OrderAccepted
      • OrderDuplicate
      • SuccessBool
      • ErrorString
      • InvalidOutletError
      • InvalidItemError
      • InvalidModifierError
      • StatusStringMessage
      • ShoppertiseMenu
      • MenuPushRequest
      • MenuPushNotification
      • MenuPushResponse
      • ProductAvailabilityRequest
      • ProductAvailabilityItem
      • ProductAvailabilityCallback
  1. Menu

Get menu by partnerMerchantID

GET
/api/shoppertise/menu
Returns the full menu payload for an outlet resolved from partnerMerchantID (matched against company_outlet.platformMerchantId or shoppertiseMerchantId). Authenticated via Authorization: Bearer <SHOPPERTISE_WEBHOOK_SECRET>.

Request

Query Params

Responses

🟢200
application/json
Menu payload for the resolved outlet.
Bodyapplication/json

🟠400
🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/shoppertise/menu?partnerMerchantID='
Response Response Example
200 - Success
{
    "status": "success",
    "partnerMerchantID": "DGFBPC",
    "outlet_id": 3,
    "menu": {
        "merchantID": "DGFBPC",
        "partnerMerchantID": "SPBPC",
        "currency": {
            "code": "MYR",
            "symbol": "RM",
            "exponent": 2
        },
        "sellingTimes": [
            {
                "id": "ST-BPC-001",
                "name": "All Day",
                "sequence": 1,
                "serviceHours": {
                    "mon": {
                        "openPeriodType": "OpenPeriod",
                        "periods": [
                            {
                                "startTime": "10:00",
                                "endTime": "22:00"
                            }
                        ]
                    },
                    "tue": {
                        "openPeriodType": "OpenPeriod",
                        "periods": [
                            {
                                "startTime": "10:00",
                                "endTime": "22:00"
                            }
                        ]
                    },
                    "wed": {
                        "openPeriodType": "OpenPeriod",
                        "periods": [
                            {
                                "startTime": "10:00",
                                "endTime": "22:00"
                            }
                        ]
                    },
                    "thu": {
                        "openPeriodType": "OpenPeriod",
                        "periods": [
                            {
                                "startTime": "10:00",
                                "endTime": "22:00"
                            }
                        ]
                    },
                    "fri": {
                        "openPeriodType": "OpenPeriod",
                        "periods": [
                            {
                                "startTime": "10:00",
                                "endTime": "23:00"
                            }
                        ]
                    },
                    "sat": {
                        "openPeriodType": "OpenPeriod",
                        "periods": [
                            {
                                "startTime": "10:00",
                                "endTime": "23:00"
                            }
                        ]
                    },
                    "sun": {
                        "openPeriodType": "OpenPeriod",
                        "periods": [
                            {
                                "startTime": "10:00",
                                "endTime": "22:00"
                            }
                        ]
                    }
                },
                "startTime": "2025-01-01 00:00:00",
                "endTime": "2028-12-01 23:59:59"
            }
        ],
        "categories": [
            {
                "id": "CAT-BPC-RICE",
                "name": "Rice Dishes",
                "sequence": 1,
                "availableStatus": "AVAILABLE",
                "sellingTimeID": "ST-BPC-001",
                "items": [
                    {
                        "id": "DYNAMOD-GFBP071",
                        "sku": "GFBP071",
                        "name": "Nasi Lemak Ayam",
                        "sequence": 1,
                        "availableStatus": "AVAILABLE",
                        "price": 1590,
                        "campaignInfo": null,
                        "description": "Fragrant coconut rice served with crispy fried chicken, sambal, anchovies and egg.",
                        "photos": [
                            "https://incardoms.cools.my/storage/products/nasi-lemak-ayam.jpg"
                        ],
                        "modifierGroups": [
                            {
                                "id": "MG-SPICE-001",
                                "name": "Spice Level",
                                "sequence": 1,
                                "availableStatus": "AVAILABLE",
                                "selectionRangeMin": 1,
                                "selectionRangeMax": 1,
                                "modifiers": [
                                    {
                                        "id": "MOD-MILD",
                                        "sku": "GFBP071-MILD",
                                        "name": "Mild",
                                        "sequence": 1,
                                        "availableStatus": "AVAILABLE",
                                        "price": 0
                                    },
                                    {
                                        "id": "MOD-MEDIUM",
                                        "sku": "GFBP071-MED",
                                        "name": "Medium",
                                        "sequence": 2,
                                        "availableStatus": "AVAILABLE",
                                        "price": 0
                                    },
                                    {
                                        "id": "MOD-HOT",
                                        "sku": null,
                                        "name": "Hot",
                                        "sequence": 3,
                                        "availableStatus": "AVAILABLE",
                                        "price": 0
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "id": "DYNAMOD-GFBP062",
                        "sku": "GFBP062",
                        "name": "Nasi Goreng Kampung",
                        "sequence": 2,
                        "availableStatus": "AVAILABLE",
                        "price": 1390,
                        "campaignInfo": null,
                        "description": "Traditional village-style fried rice with anchovies and vegetables.",
                        "photos": [],
                        "modifierGroups": []
                    }
                ]
            },
            {
                "id": "CAT-BPC-DRINKS",
                "name": "Drinks",
                "sequence": 2,
                "availableStatus": "AVAILABLE",
                "sellingTimeID": "ST-BPC-001",
                "items": [
                    {
                        "id": "DYNAMOD-GFBP090",
                        "sku": "GFBP090",
                        "name": "Teh Tarik",
                        "sequence": 1,
                        "availableStatus": "AVAILABLE",
                        "price": 490,
                        "campaignInfo": null,
                        "description": "",
                        "photos": [],
                        "modifierGroups": [
                            {
                                "id": "MG-SUGAR-001",
                                "name": "Sugar Level",
                                "sequence": 1,
                                "availableStatus": "AVAILABLE",
                                "selectionRangeMin": 0,
                                "selectionRangeMax": 1,
                                "modifiers": [
                                    {
                                        "id": "MOD-LESS-SUGAR",
                                        "sku": "GFBP090-LS",
                                        "name": "Less Sugar",
                                        "sequence": 1,
                                        "availableStatus": "AVAILABLE",
                                        "price": 0
                                    },
                                    {
                                        "id": "MOD-NO-SUGAR",
                                        "sku": "GFBP090-NS",
                                        "name": "No Sugar",
                                        "sequence": 2,
                                        "availableStatus": "AVAILABLE",
                                        "price": 0
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
Modified at 2026-10-20 14:43:16
Previous
Order detail
Next
Notify Shoppertise to pull menu (SHOPPERTISE API)
Built with