API para desenvolvedores

Public menu of a restaurant

The categories with at least one visible product, in display order, each with its visible products in display order. Hidden products and empty categories are never included. restaurant.language is the language name and description are written in, and restaurant.languages the ones the menu is translated into: to render one of those, read translations[code] on each category, product, variant and option and fall back to the original field when it is missing. Cached at the edge and refreshed on every change the owner makes; a differently-cased identifier is redirected to the lowercase one.

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/menus/pizzeria-roma"

Resposta 200

{
  "restaurant": {
    "id": "aR3kX9pLm2QzT7vN4bYc",
    "identifier": "pizzeria-roma",
    "name": "Pizzería Roma",
    "currency": "COP",
    "type": "whatsapp",
    "phone": "+573001234567",
    "address": "Calle 10 # 5-20, Bogotá",
    "menu_url": "https://delimenu.co/pizzeria-roma",
    "logo_url": "https://firebasestorage.googleapis.com/v0/b/example/o/logo_512x512.png?alt=media",
    "banner_url": null,
    "language": "es",
    "languages": [
      "en"
    ]
  },
  "categories": [
    {
      "id": "k3Qm8vXb2LpN7wRt1YaZ",
      "name": "Pizzas",
      "position": 1,
      "products": [
        {
          "id": "p9Hs4TqL2mNc8VbX6Rdy",
          "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
          "name": "Pizza Margarita",
          "price": 32000,
          "original_price": 38000,
          "description": "Tomate, mozzarella y albahaca fresca",
          "available": true,
          "hidden": false,
          "has_image": true,
          "image_url": "https://firebasestorage.googleapis.com/v0/b/example/o/margarita_1080x1080.jpg?alt=media",
          "variants": [
            {
              "id": "26fed9f6-2e3b-4310-b899-5641bf98e2f0",
              "name": "Tamaño",
              "min_selections": 1,
              "max_selections": 1,
              "options": [
                {
                  "id": "5c4f8896-06a3-4482-99d1-185a909d0415",
                  "name": "Personal",
                  "price": 0,
                  "show": true
                },
                {
                  "id": "b1e0c4d2-7f3a-4c8e-9d21-0a5f6e7b8c9d",
                  "name": "Familiar",
                  "price": 12000,
                  "show": true
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Campos da resposta

Erros

• 403 RESTAURANT_UNAVAILABLE — the restaurant exists but has no active plan; only its name is returned
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

List the restaurants of the account

Call this first; every other endpoint takes one of these by identifier or id.

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "restaurants": [
    {
      "id": "aR3kX9pLm2QzT7vN4bYc",
      "identifier": "pizzeria-roma",
      "name": "Pizzería Roma",
      "currency": "COP",
      "type": "whatsapp",
      "phone": "+573001234567",
      "address": "Calle 10 # 5-20, Bogotá",
      "menu_url": "https://delimenu.co/pizzeria-roma",
      "logo_url": "https://firebasestorage.googleapis.com/v0/b/example/o/logo_512x512.png?alt=media",
      "banner_url": null,
      "language": "es",
      "languages": [
        "en"
      ],
      "trial_active": false
    }
  ]
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Get a restaurant

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants/pizzeria-roma" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "restaurant": {
    "id": "aR3kX9pLm2QzT7vN4bYc",
    "identifier": "pizzeria-roma",
    "name": "Pizzería Roma",
    "currency": "COP",
    "type": "whatsapp",
    "phone": "+573001234567",
    "address": "Calle 10 # 5-20, Bogotá",
    "menu_url": "https://delimenu.co/pizzeria-roma",
    "logo_url": "https://firebasestorage.googleapis.com/v0/b/example/o/logo_512x512.png?alt=media",
    "banner_url": null,
    "language": "es",
    "languages": [
      "en"
    ],
    "trial_active": false
  }
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Update a restaurant

Changes only the fields given: name, WhatsApp phone, address, currency, type, language (the primary one) or languages (the additional ones, never the primary). Changing the currency converts no prices and changing a language translates nothing. The identifier has its own endpoint.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PATCH "https://delimenu.co/api/v1/restaurants/pizzeria-roma" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+573009876543","address":"Carrera 7 # 45-10, Bogotá"}'

Resposta 200

{
  "restaurant": {
    "id": "aR3kX9pLm2QzT7vN4bYc",
    "identifier": "pizzeria-roma",
    "name": "Pizzería Roma",
    "currency": "COP",
    "type": "whatsapp",
    "phone": "+573009876543",
    "address": "Carrera 7 # 45-10, Bogotá",
    "menu_url": "https://delimenu.co/pizzeria-roma",
    "logo_url": "https://firebasestorage.googleapis.com/v0/b/example/o/logo_512x512.png?alt=media",
    "banner_url": null,
    "language": "es",
    "languages": [
      "en"
    ],
    "trial_active": false
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Change the public URL

Changes the slug of the menu (delimenu.co/{identifier}). The old URL stops working immediately; printed QR codes keep working because they point at the restaurant id.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PUT "https://delimenu.co/api/v1/restaurants/pizzeria-roma/identifier" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"identifier":"pizzeria-roma-chapinero"}'

Resposta 200

{
  "restaurant": {
    "id": "aR3kX9pLm2QzT7vN4bYc",
    "identifier": "pizzeria-roma-chapinero",
    "name": "Pizzería Roma",
    "currency": "COP",
    "type": "whatsapp",
    "phone": "+573001234567",
    "address": "Calle 10 # 5-20, Bogotá",
    "menu_url": "https://delimenu.co/pizzeria-roma-chapinero",
    "logo_url": "https://firebasestorage.googleapis.com/v0/b/example/o/logo_512x512.png?alt=media",
    "banner_url": null,
    "language": "es",
    "languages": [
      "en"
    ],
    "trial_active": false
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 409 CONFLICT — the identifier is already taken
• 500 INTERNAL — something failed on our side; retry in a moment

Get the whole menu

Every category in display order, each with its products in display order, prices, availability and variants. Hidden products are omitted unless include_hidden is true. Uncategorized products are listed apart.

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants/pizzeria-roma/menu?include_hidden=true" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "restaurant": {
    "id": "aR3kX9pLm2QzT7vN4bYc",
    "identifier": "pizzeria-roma",
    "name": "Pizzería Roma",
    "currency": "COP",
    "type": "whatsapp",
    "phone": "+573001234567",
    "address": "Calle 10 # 5-20, Bogotá",
    "menu_url": "https://delimenu.co/pizzeria-roma",
    "logo_url": "https://firebasestorage.googleapis.com/v0/b/example/o/logo_512x512.png?alt=media",
    "banner_url": null,
    "language": "es",
    "languages": [
      "en"
    ],
    "trial_active": false
  },
  "categories": [
    {
      "id": "k3Qm8vXb2LpN7wRt1YaZ",
      "name": "Pizzas",
      "position": 1,
      "products": [
        {
          "id": "p9Hs4TqL2mNc8VbX6Rdy",
          "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
          "name": "Pizza Margarita",
          "price": 32000,
          "original_price": 38000,
          "description": "Tomate, mozzarella y albahaca fresca",
          "available": true,
          "hidden": false,
          "has_image": true,
          "image_url": "https://firebasestorage.googleapis.com/v0/b/example/o/margarita_1080x1080.jpg?alt=media",
          "variants": [
            {
              "id": "26fed9f6-2e3b-4310-b899-5641bf98e2f0",
              "name": "Tamaño",
              "min_selections": 1,
              "max_selections": 1,
              "options": [
                {
                  "id": "5c4f8896-06a3-4482-99d1-185a909d0415",
                  "name": "Personal",
                  "price": 0,
                  "show": true
                },
                {
                  "id": "b1e0c4d2-7f3a-4c8e-9d21-0a5f6e7b8c9d",
                  "name": "Familiar",
                  "price": 12000,
                  "show": true
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "uncategorized_products": [],
  "hidden_products_omitted": 2,
  "note": "Prices are in COP, major units."
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

List the categories

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants/pizzeria-roma/categories" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "categories": [
    {
      "id": "k3Qm8vXb2LpN7wRt1YaZ",
      "name": "Pizzas",
      "position": 1
    },
    {
      "id": "c7Wd2Bn5Kq9Xr4Ms8Lt1",
      "name": "Bebidas",
      "position": 2
    }
  ]
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Create a category

Adds a category at the end of the menu. name is in the menu's primary language; translations carries it in the others.

Parâmetros

Corpo (JSON)

Exemplo

curl -X POST "https://delimenu.co/api/v1/restaurants/pizzeria-roma/categories" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"Postres","translations":{"en":{"name":"Desserts"}}}'

Resposta 201

{
  "category": {
    "id": "d4Fg6Hj8Kl0Zx2Cv4Bn6",
    "name": "Postres",
    "translations": {
      "en": {
        "name": "Desserts"
      }
    }
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 409 CONFLICT — a category with that name already exists
• 500 INTERNAL — something failed on our side; retry in a moment

Reorder the categories

Sets the display order. Pass every category id exactly once, in the new order.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PUT "https://delimenu.co/api/v1/restaurants/pizzeria-roma/category-order" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"category_ids":["c7Wd2Bn5Kq9Xr4Ms8Lt1","k3Qm8vXb2LpN7wRt1YaZ"]}'

Resposta 200

{
  "order_categories": [
    "c7Wd2Bn5Kq9Xr4Ms8Lt1",
    "k3Qm8vXb2LpN7wRt1YaZ"
  ]
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Rename or translate a category

Pass name, translations or both; what is not passed is left as it is. translations replaces the whole map, and {} removes every translation.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PATCH "https://delimenu.co/api/v1/restaurants/pizzeria-roma/categories/k3Qm8vXb2LpN7wRt1YaZ" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"Pizzas artesanales"}'

Resposta 200

{
  "category": {
    "id": "k3Qm8vXb2LpN7wRt1YaZ",
    "name": "Pizzas artesanales"
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Delete a category

Refused with 409 while the category still has products, unless delete_products is true, in which case the products are deleted too.

Parâmetros

Exemplo

curl -X DELETE "https://delimenu.co/api/v1/restaurants/pizzeria-roma/categories/k3Qm8vXb2LpN7wRt1YaZ?delete_products=true" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "deleted": "k3Qm8vXb2LpN7wRt1YaZ",
  "deleted_products": 3
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 409 CONFLICT — the category still has products
• 500 INTERNAL — something failed on our side; retry in a moment

Reorder the products of a category

Pass every product id of that category exactly once, in the new order.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PUT "https://delimenu.co/api/v1/restaurants/pizzeria-roma/categories/k3Qm8vXb2LpN7wRt1YaZ/product-order" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"product_ids":["q2Jk5Lm8Np1Qr4St7Uv0","p9Hs4TqL2mNc8VbX6Rdy"]}'

Resposta 200

{
  "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
  "order_products": [
    "q2Jk5Lm8Np1Qr4St7Uv0",
    "p9Hs4TqL2mNc8VbX6Rdy"
  ]
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

List or search the products

Every product, hidden ones included and flagged. With q, only those whose name or description contains the text.

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products?q=margarita" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "products": [
    {
      "id": "p9Hs4TqL2mNc8VbX6Rdy",
      "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
      "name": "Pizza Margarita",
      "price": 32000,
      "original_price": 38000,
      "description": "Tomate, mozzarella y albahaca fresca",
      "available": true,
      "hidden": false,
      "has_image": true,
      "image_url": "https://firebasestorage.googleapis.com/v0/b/example/o/margarita_1080x1080.jpg?alt=media",
      "variants": [
        {
          "id": "26fed9f6-2e3b-4310-b899-5641bf98e2f0",
          "name": "Tamaño",
          "min_selections": 1,
          "max_selections": 1,
          "options": [
            {
              "id": "5c4f8896-06a3-4482-99d1-185a909d0415",
              "name": "Personal",
              "price": 0,
              "show": true
            },
            {
              "id": "b1e0c4d2-7f3a-4c8e-9d21-0a5f6e7b8c9d",
              "name": "Familiar",
              "price": 12000,
              "show": true
            }
          ]
        }
      ]
    }
  ],
  "count": 1
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Create a product

Adds a product to a category, at the end. Price is in the restaurant's currency, major units. Variants are optional choices (sizes, extras) with their own option prices.

Parâmetros

Corpo (JSON)

Exemplo

curl -X POST "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"k3Qm8vXb2LpN7wRt1YaZ","name":"Pizza Margarita","price":32000,"description":"Tomate, mozzarella y albahaca fresca","variants":[{"name":"Tamaño","min_selections":1,"max_selections":1,"options":[{"name":"Personal","price":0},{"name":"Familiar","price":12000}]}]}'

Resposta 201

{
  "product": {
    "id": "p9Hs4TqL2mNc8VbX6Rdy",
    "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
    "name": "Pizza Margarita",
    "price": 32000,
    "description": "Tomate, mozzarella y albahaca fresca",
    "available": true,
    "hidden": false,
    "has_image": true,
    "image_url": "https://firebasestorage.googleapis.com/v0/b/example/o/margarita_1080x1080.jpg?alt=media",
    "variants": [
      {
        "id": "26fed9f6-2e3b-4310-b899-5641bf98e2f0",
        "name": "Tamaño",
        "min_selections": 1,
        "max_selections": 1,
        "options": [
          {
            "id": "5c4f8896-06a3-4482-99d1-185a909d0415",
            "name": "Personal",
            "price": 0,
            "show": true
          },
          {
            "id": "b1e0c4d2-7f3a-4c8e-9d21-0a5f6e7b8c9d",
            "name": "Familiar",
            "price": 12000,
            "show": true
          }
        ]
      }
    ]
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Update many products

Applies a patch to up to 50 products in one write — for "raise every price 10%" or "mark these as out of stock". Same fields as updating one product.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PATCH "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"updates":[{"product_id":"p9Hs4TqL2mNc8VbX6Rdy","changes":{"price":35000}},{"product_id":"q2Jk5Lm8Np1Qr4St7Uv0","changes":{"available":false}}]}'

Resposta 200

{
  "updated": 2
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Get a product

translations is present only where something is translated: on the product (name, description) and inside each variant and option (name).

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products/p9Hs4TqL2mNc8VbX6Rdy" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "product": {
    "id": "p9Hs4TqL2mNc8VbX6Rdy",
    "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
    "name": "Pizza Margarita",
    "price": 32000,
    "original_price": 38000,
    "description": "Tomate, mozzarella y albahaca fresca",
    "available": true,
    "hidden": false,
    "has_image": true,
    "image_url": "https://firebasestorage.googleapis.com/v0/b/example/o/margarita_1080x1080.jpg?alt=media",
    "variants": [
      {
        "id": "26fed9f6-2e3b-4310-b899-5641bf98e2f0",
        "name": "Tamaño",
        "min_selections": 1,
        "max_selections": 1,
        "options": [
          {
            "id": "5c4f8896-06a3-4482-99d1-185a909d0415",
            "name": "Personal",
            "price": 0,
            "show": true
          },
          {
            "id": "b1e0c4d2-7f3a-4c8e-9d21-0a5f6e7b8c9d",
            "name": "Familiar",
            "price": 12000,
            "show": true,
            "translations": {
              "en": {
                "name": "Family"
              }
            }
          }
        ],
        "translations": {
          "en": {
            "name": "Size"
          }
        }
      }
    ],
    "translations": {
      "en": {
        "name": "Margherita Pizza",
        "description": "Tomato, mozzarella and fresh basil"
      }
    }
  }
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Update a product

Changes only the fields given: name, price, description, original_price (promotion), available, hidden, variants (replaces all), translations (replaces all) or category_id (moves it). Raising price above an existing original_price ends the promotion. A variant or option sent without translations keeps the ones stored under the same name, so repricing an option does not erase them; send translations: {} on it to remove them.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PATCH "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products/p9Hs4TqL2mNc8VbX6Rdy" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"price":30000,"original_price":38000,"translations":{"en":{"name":"Margherita Pizza","description":"Tomato, mozzarella and fresh basil"}}}'

Resposta 200

{
  "product": {
    "id": "p9Hs4TqL2mNc8VbX6Rdy",
    "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
    "name": "Pizza Margarita",
    "price": 30000,
    "original_price": 38000,
    "description": "Tomate, mozzarella y albahaca fresca",
    "available": true,
    "hidden": false,
    "has_image": true,
    "image_url": "https://firebasestorage.googleapis.com/v0/b/example/o/margarita_1080x1080.jpg?alt=media",
    "variants": [
      {
        "id": "26fed9f6-2e3b-4310-b899-5641bf98e2f0",
        "name": "Tamaño",
        "min_selections": 1,
        "max_selections": 1,
        "options": [
          {
            "id": "5c4f8896-06a3-4482-99d1-185a909d0415",
            "name": "Personal",
            "price": 0,
            "show": true
          },
          {
            "id": "b1e0c4d2-7f3a-4c8e-9d21-0a5f6e7b8c9d",
            "name": "Familiar",
            "price": 12000,
            "show": true,
            "translations": {
              "en": {
                "name": "Family"
              }
            }
          }
        ],
        "translations": {
          "en": {
            "name": "Size"
          }
        }
      }
    ],
    "translations": {
      "en": {
        "name": "Margherita Pizza",
        "description": "Tomato, mozzarella and fresh basil"
      }
    }
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Delete a product

Permanent, photo included. Prefer hidden: true when the owner may want it back.

Parâmetros

Exemplo

curl -X DELETE "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products/p9Hs4TqL2mNc8VbX6Rdy" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "deleted": "p9Hs4TqL2mNc8VbX6Rdy"
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Set the logo or the banner

Downloads the image at a public https URL and sets it as the logo or the banner, replacing the current one. Takes a few seconds while the image is optimised.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PUT "https://delimenu.co/api/v1/restaurants/pizzeria-roma/images/logo" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"image_url":"https://example.com/logo.png"}'

Resposta 200

{
  "restaurant": {
    "id": "aR3kX9pLm2QzT7vN4bYc",
    "identifier": "pizzeria-roma",
    "name": "Pizzería Roma",
    "currency": "COP",
    "type": "whatsapp",
    "phone": "+573001234567",
    "address": "Calle 10 # 5-20, Bogotá",
    "menu_url": "https://delimenu.co/pizzeria-roma",
    "logo_url": "https://firebasestorage.googleapis.com/v0/b/example/o/logo_512x512.png?alt=media",
    "banner_url": null,
    "language": "es",
    "languages": [
      "en"
    ],
    "trial_active": false
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Remove the logo or the banner

Parâmetros

Exemplo

curl -X DELETE "https://delimenu.co/api/v1/restaurants/pizzeria-roma/images/logo" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "restaurant": {
    "id": "aR3kX9pLm2QzT7vN4bYc",
    "identifier": "pizzeria-roma",
    "name": "Pizzería Roma",
    "currency": "COP",
    "type": "whatsapp",
    "phone": "+573001234567",
    "address": "Calle 10 # 5-20, Bogotá",
    "menu_url": "https://delimenu.co/pizzeria-roma",
    "logo_url": null,
    "banner_url": null,
    "language": "es",
    "languages": [
      "en"
    ],
    "trial_active": false
  }
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Set the product photo

Downloads the image at a public https URL and makes it the product photo, replacing the current one. Takes a few seconds while the image is optimised.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PUT "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products/p9Hs4TqL2mNc8VbX6Rdy/image" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"image_url":"https://example.com/fotos/margarita.jpg"}'

Resposta 200

{
  "product": {
    "id": "p9Hs4TqL2mNc8VbX6Rdy",
    "category_id": "k3Qm8vXb2LpN7wRt1YaZ",
    "name": "Pizza Margarita",
    "price": 32000,
    "original_price": 38000,
    "description": "Tomate, mozzarella y albahaca fresca",
    "available": true,
    "hidden": false,
    "has_image": true,
    "image_url": "https://firebasestorage.googleapis.com/v0/b/example/o/margarita_1080x1080.jpg?alt=media",
    "variants": [
      {
        "id": "26fed9f6-2e3b-4310-b899-5641bf98e2f0",
        "name": "Tamaño",
        "min_selections": 1,
        "max_selections": 1,
        "options": [
          {
            "id": "5c4f8896-06a3-4482-99d1-185a909d0415",
            "name": "Personal",
            "price": 0,
            "show": true
          },
          {
            "id": "b1e0c4d2-7f3a-4c8e-9d21-0a5f6e7b8c9d",
            "name": "Familiar",
            "price": 12000,
            "show": true
          }
        ]
      }
    ]
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Remove the product photo

Parâmetros

Exemplo

curl -X DELETE "https://delimenu.co/api/v1/restaurants/pizzeria-roma/products/p9Hs4TqL2mNc8VbX6Rdy/image" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "product_id": "p9Hs4TqL2mNc8VbX6Rdy",
  "has_image": false
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

List the webhooks of a restaurant

Signing secrets are never returned here; only when an endpoint is created or its secret rotated.

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants/pizzeria-roma/webhooks" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "webhooks": [
    {
      "id": "w7Kd2PqR9sLm4XvB1nTc",
      "url": "https://pos.example.com/delimenu/webhooks",
      "events": [
        "product.created",
        "product.updated",
        "product.deleted"
      ],
      "enabled": true,
      "disabled_reason": null,
      "created_at": "2026-10-01T15:04:05.000Z",
      "last_delivery_at": "2026-10-02T09:30:00.000Z",
      "last_status": 200
    }
  ]
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Register a webhook

Starts sending the chosen events to the URL. The response carries the signing secret, the only time it is shown: store it and use it to verify Delimenu-Signature. Up to 5 per restaurant; one URL once per restaurant.

Parâmetros

Corpo (JSON)

Exemplo

curl -X POST "https://delimenu.co/api/v1/restaurants/pizzeria-roma/webhooks" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://pos.example.com/delimenu/webhooks","events":["product.created","product.updated","product.deleted"]}'

Resposta 201

{
  "webhook": {
    "id": "w7Kd2PqR9sLm4XvB1nTc",
    "url": "https://pos.example.com/delimenu/webhooks",
    "events": [
      "product.created",
      "product.updated",
      "product.deleted"
    ],
    "enabled": true,
    "disabled_reason": null,
    "created_at": "2026-10-01T15:04:05.000Z",
    "last_delivery_at": null,
    "last_status": null
  },
  "secret": "whsec_Zx8Qm2Lk5Vb9Tn3Rw7Yc1Hd4Fg6Js0Pa"
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 409 CONFLICT — this restaurant already has a webhook with that URL
• 500 INTERNAL — something failed on our side; retry in a moment

Update a webhook

Changes only the fields given. enabled: true turns back on an endpoint that was switched off for failing, and clears its failure count.

Parâmetros

Corpo (JSON)

Exemplo

curl -X PATCH "https://delimenu.co/api/v1/restaurants/pizzeria-roma/webhooks/w7Kd2PqR9sLm4XvB1nTc" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

Resposta 200

{
  "webhook": {
    "id": "w7Kd2PqR9sLm4XvB1nTc",
    "url": "https://pos.example.com/delimenu/webhooks",
    "events": [
      "product.created",
      "product.updated",
      "product.deleted"
    ],
    "enabled": true,
    "disabled_reason": null,
    "created_at": "2026-10-01T15:04:05.000Z",
    "last_delivery_at": "2026-10-02T09:30:00.000Z",
    "last_status": 200
  }
}

Campos da resposta

Erros

• 400 VALIDATION — a field is missing or malformed; `issues` names it
• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 409 CONFLICT — this restaurant already has a webhook with that URL
• 500 INTERNAL — something failed on our side; retry in a moment

Delete a webhook

Stops every delivery at once, retries already queued included.

Parâmetros

Exemplo

curl -X DELETE "https://delimenu.co/api/v1/restaurants/pizzeria-roma/webhooks/w7Kd2PqR9sLm4XvB1nTc" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "deleted": "w7Kd2PqR9sLm4XvB1nTc"
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Rotate the signing secret

Replaces the secret; the old one stops verifying on the very next delivery. The response is the only time the new one is shown.

Parâmetros

Exemplo

curl -X POST "https://delimenu.co/api/v1/restaurants/pizzeria-roma/webhooks/w7Kd2PqR9sLm4XvB1nTc/secret" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "webhook": {
    "id": "w7Kd2PqR9sLm4XvB1nTc",
    "url": "https://pos.example.com/delimenu/webhooks",
    "events": [
      "product.created",
      "product.updated",
      "product.deleted"
    ],
    "enabled": true,
    "disabled_reason": null,
    "created_at": "2026-10-01T15:04:05.000Z",
    "last_delivery_at": "2026-10-02T09:30:00.000Z",
    "last_status": 200
  },
  "secret": "whsec_Zx8Qm2Lk5Vb9Tn3Rw7Yc1Hd4Fg6Js0Pa"
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Send a test event

POSTs a signed "ping" event now and returns how the endpoint answered. A failing endpoint is still a 200 here, with ok: false. Works on a switched-off endpoint too.

Parâmetros

Exemplo

curl -X POST "https://delimenu.co/api/v1/restaurants/pizzeria-roma/webhooks/w7Kd2PqR9sLm4XvB1nTc/test" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "delivery": {
    "id": "d4Nf8Kq2Rm6Xs1Vb9Lt3",
    "event_id": "evt_test_8c1e4a7f2b9d3e6a0c5f",
    "type": "ping",
    "attempt": 1,
    "ok": true,
    "http_status": 200,
    "duration_ms": 184,
    "error": null,
    "response_excerpt": "{\"received\":true}",
    "created_at": "2026-10-02T09:30:00.000Z"
  }
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment

Latest delivery attempts

The most recent attempts to this endpoint, newest first, retries included. Kept for 14 days.

Parâmetros

Exemplo

curl -X GET "https://delimenu.co/api/v1/restaurants/pizzeria-roma/webhooks/w7Kd2PqR9sLm4XvB1nTc/deliveries" \
  -H "Authorization: Bearer dmk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Resposta 200

{
  "deliveries": [
    {
      "id": "d4Nf8Kq2Rm6Xs1Vb9Lt3",
      "event_id": "evt_3f9a1c7e5b2d8a4c6e0f1b3d",
      "type": "product.updated",
      "attempt": 1,
      "ok": true,
      "http_status": 200,
      "duration_ms": 184,
      "error": null,
      "response_excerpt": "{\"received\":true}",
      "created_at": "2026-10-02T09:30:00.000Z"
    }
  ]
}

Campos da resposta

Erros

• 401 UNAUTHORIZED — the key is missing, unknown or revoked
• 402 NOT_PREMIUM — the restaurant has no active subscription or trial
• 403 FORBIDDEN — the key lacks the scope this endpoint needs
• 404 NOT_FOUND — no such restaurant in this account, or no such item in it
• 500 INTERNAL — something failed on our side; retry in a moment