1. Vendors - Admin
3enab
👨‍💼 Admin Application
  • 👤 User Application
  • 🏪 Vendor Application
  • 👨‍💼 Admin Application
  • 🚚 Delivery Application
  • Auth - Admin
    • Register a new admin
      POST
    • Login admin
      POST
    • Logout admin
      POST
    • Refresh access token
      POST
    • Send phone OTP
      POST
    • Verify phone OTP
      POST
    • Send password reset OTP
      POST
    • Verify password reset OTP
      POST
    • Reset password
      POST
  • Ads - Admin
    • Create a new advertisement
      POST
    • Update an advertisement
      PUT
    • Delete an advertisement
      DELETE
    • Upload advertisement image
      POST
    • Activate an advertisement
      PATCH
    • Deactivate an advertisement
      PATCH
    • Get all ads for admin
      GET
  • Coupons - Admin
    • Create a new coupon
    • Get all coupons
    • Get coupon by ID
    • Update coupon
    • Delete coupon
    • Update coupon active status
  • Delivery Areas - Admin
    • Create a new delivery area
    • Get all delivery areas
    • Get delivery area by ID
    • Update delivery area
    • Delete delivery area
  • Items - Admin
    • Get all items for admin
    • Create a new item
    • Get a single item by ID
    • Update an item
    • Delete an item
    • Upload item image
    • Update item availability
    • Update item group availability
    • Update item active status
    • Update item discount
    • Remove item discount
    • Apply discount to all vendor items
    • Remove discount from all vendor items
    • Update items order
    • Create a variant for an item
    • Get all variants of an item
    • Get all items (Direct Access - Public)
    • Get all items for a specific vendor (Direct Access - Public)
    • Get item by ID (Direct Access - Public)
  • Menu Categories - Admin
    • Get all menu categories for admin
    • Create menu category (Admin)
    • Get menu category by ID (Admin)
    • Update menu category (Admin)
    • Delete menu category (Admin)
    • Update menu category active status (Admin)
    • Update menu category order (Admin)
  • Rates - Admin
    • Get all ratings for a vendor (Admin)
    • Get a specific rating by ID (Admin)
    • Delete a rating (Admin)
  • Users - Admin
    • Get current admin user profile
    • Update current admin user profile
    • Delete current admin user account
    • Change admin user password
    • Get all users with pagination
    • Create user (Admin)
    • Reset user password (Admin)
    • Mark user phone as verified (Admin)
    • Get user by ID
    • Update user by ID
    • Delete user by ID
  • Vendor Categories - Admin
    • Create a new vendor category
    • Get all vendor categories
    • Get a vendor category by ID
    • Update a vendor category
    • Delete a vendor category
    • Upload vendor category image
    • Update vendor category active status
    • Reorder vendor categories
  • Vendors - Admin
    • Get all vendors for admin
      GET
    • Create vendor
      POST
    • Get vendor by ID
      GET
    • Update vendor
      PUT
    • Delete vendor
      DELETE
    • Upload vendor logo
      POST
    • Update vendor active status
      PATCH
    • Update vendor availability status (Admin)
      PATCH
    • Update vendor free delivery status
      PATCH
    • Reorder vendors
      PATCH
    • Create or update vendor notice
      PUT
    • Upload vendor cover image
      POST
    • Delete vendor notice
      DELETE
    • Delete vendor cover image
      DELETE
    • Upload notice image
      POST
    • Update vendor preparation time (Admin)
      PATCH
    • Delete notice image
      DELETE
  • Notifications - Admin
    • Send broadcast notification to users
    • Send notification to specific users
  • Versions - Admin
    • Create a new version
    • Get all versions
    • Get the latest version
    • Update a version
    • Delete a version
  • Orders - Admin
    • Get all orders (Admin)
    • Get order by ID (Admin)
    • Delete order permanently (Admin)
    • Cancel order by admin
  • App Notices - Admin
    • Create a new app notice
    • Get all app notices (paginated)
    • Get notice by ID
    • Update notice
    • Delete notice
    • Upload notice image
    • Delete notice image
  1. Vendors - Admin

Create or update vendor notice

PUT
/api/v1/admin/vendors/{vendorId}/notice
Set a notice/alert on the vendor (e.g. "We are busy", "Ramadan hours", etc.).
The notice is shown to users when isActive is true.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Path Params

Body Params application/jsonRequired

Example
{
    "title": "We are currently busy",
    "details": "Orders may take 30-60 minutes longer than usual",
    "isActive": true
}

Responses

🟢200
application/json
Vendor notice updated successfully
Body

Example
{
    "status": "success",
    "message": "Vendor notice updated successfully",
    "data": {
        "vendor": {
            "_id": "507f1f77bcf86cd799439011",
            "name": "Pizza Palace",
            "description": "Best pizza in town",
            "category": "507f1f77bcf86cd799439013",
            "workingHours": {
                "open": "09:00",
                "close": "21:00",
                "days": [
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday",
                    "Saturday",
                    "Sunday"
                ]
            },
            "owner": "507f1f77bcf86cd799439012",
            "logoPath": "/uploads/vendorsLogos/507f1f77bcf86cd799439011.jpg",
            "coverPath": "/uploads/vendorsCovers/507f1f77bcf86cd799439011.jpg",
            "isActive": true,
            "averageRate": 4.5,
            "totalRates": 150,
            "order": 0,
            "freeDelivery": false,
            "notice": {
                "title": "We are currently busy",
                "details": "Orders may take longer than usual",
                "imagePath": "/uploads/vendorsNotices/507f1f77bcf86cd799439011.jpg",
                "isActive": true
            },
            "preparationTime": {
                "from": 30,
                "to": 45,
                "unit": "minute"
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    }
}
🟠400
🟠404
Modified at 2026-04-08 13:49:45
Previous
Reorder vendors
Next
Upload vendor cover image
Built with