Yumzip Developer API Documentation

You can access the Yumzip Developer API Documentation to integrate third-party systems, POS hardware, or custom frontends with the Yumzip restaurant platform.

Core API details

Base URL: https://api.yumzip.in/v1
Authentication: Requires an API key passed explicitly in the request header, generated via your merchant portal settings.
Architecture: REST API infrastructure designed to interface with real-time webhooks and websocket order management feeds.

Available capabilities

Real-time Order Sync

Push and pull active direct orders between external POS systems, KDS hardware, and the cloud dashboard.
Menu & Inventory Control

Update categories, variants, and live item availability programmatically across all digital channels.
Payment Facilitation

Connect custom payment gateways securely at the software layer.

Quick start

Make your first request in four steps.

Get your API key

Generate your API token inside your Merchant Portal settings.
Set the Base URL

Send requests to https://api.yumzip.in/v1.
Authenticate your request

Pass your key in the Authorization header as a Bearer token. See Authentication.
Make your first API call

Fetch orders with GET /v1/orders.

Request curl

curl https://api.yumzip.in/v1/orders \
  -H 'Authorization: Bearer YOUR_MERCHANT_API_KEY' \
  -H 'Accept: application/json'

Authentication

All REST API requests require an API key passed explicitly in the request header. You can generate your API tokens inside your Merchant Portal settings.

Authentication header format

Headers http

Authorization: Bearer YOUR_MERCHANT_API_KEY
Content-Type: application/json
Accept: application/json

Orders API

Push and pull active direct orders between external POS systems, KDS hardware, and the cloud dashboard.

GET /v1/orders AuthenticationRequired

Send the authentication headers with every request.

Example request curl

curl https://api.yumzip.in/v1/orders \
  -H 'Authorization: Bearer YOUR_MERCHANT_API_KEY' \
  -H 'Accept: application/json'

Example response json

{
  "status": "success",
  "data": [
    {
      "order_number": "YZ-98234",
      "customer_name": "Rahul Sharma",
      "total": 450.00,
      "order_status": "Pending",
      "items": [
        { "name": "Paneer Butter Masala", "qty": 1, "price": 280.00 },
        { "name": "Butter Naan", "qty": 2, "price": 85.00 }
      ]
    }
  ]
}

Update categories, variants, and live item availability programmatically across your store setup.

POST /v1/menu/item/toggle-stock AuthenticationRequired

Send the authentication headers with every request.

Body parameters

Name	Type	Example
`item_id`	number	`1042`
`in_stock`	boolean	`false`

Request body json

{
  "item_id": 1042,
  "in_stock": false
}

Example request curl

curl -X POST https://api.yumzip.in/v1/menu/item/toggle-stock \
  -H 'Authorization: Bearer YOUR_MERCHANT_API_KEY' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"item_id": 1042, "in_stock": false}'

Webhooks & Websocket Feeds

REST API infrastructure is designed to interface with real-time webhooks and websocket order management feeds.

Events

Event	Triggered when
`order.created`	A customer places a direct order.
`order.status_updated`	Order status changes in POS/KDS.
`table.waiter_called`	A QR dine-in customer requests waiter assistance.

Need help with a specific endpoint or integration type?

Tell us what you are building, and we will guide you with exact request payloads and SDK guides.

Are you integrating a POS system or building a custom storefront?

Which specific data entities do you need to access?

Payments & architectural policy

Yumzip Payments & Architectural Policy: Yumzip functions cleanly and exclusively at the application software layer.

The Platform's architectural stack acts purely as an API facilitator, data transmitter, and integration hub for modern FoodTech SaaS workflows.

Developer API Documentation

Yumzip Developer API Documentation

Core API details

Available capabilities

Real-time Order Sync

Menu & Inventory Control

Payment Facilitation

Quick start

Get your API key

Set the Base URL

Authenticate your request

Make your first API call

Authentication

Authentication header format

Orders API

Menu & Inventory Control API

Body parameters

Webhooks & Websocket Feeds

Events

Need help with a specific endpoint or integration type?

Payments & architectural policy

LEGAL & POLICIES

HELP CENTER

PARTNERS & COMMUNITY

DEVELOPER