Skip to content

Keeta Menu Management API (v.1.0.0)

This API provides comprehensive menu management capabilities for Keeta platform integration, including menu synchronization, product status management, and real-time notifications.

Download OpenAPI description
Overview
Keeta Developer Website

https://developers.mykeeta.com/

Languages
Servers

https://open.mykeeta.com/api/open/

Operations
Webhooks
Operations

Request

  1. You can only delete ShopCategory that doesn't contain any product.
  2. Please make sure the ShopCategory.id is in-store.

Rate limit: 10 QPS by appId dimension.

Bodyapplication/jsonrequired
shopIdinteger(int64)required

store id in KeeTa

Example: 25381
shopCategoryIdListArray of integers(int64)required

ShopCategory id list to be deleted

Example: [2313,4342]
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/shopcategory/batchdel \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 25381,
    "shopCategoryIdList": [
      2313,
      4342
    ]
  }'

Responses

Batch deletion result.

Bodyapplication/json
codeintegerrequired

A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.

Enum ValueDescription
0

The request was executed successfully.

Non-zero value

The request execution failed. Specific error details can be viewed in the message field.

Example: 0
messagestringrequired

Text description corresponding to the status code, explaining the operation result or error cause to users.

Example: "Success"
dataArray of integers(int64)

successful ShopCategory id list

errorListArray of objects(ErrorShopCategory)

failed ShopCategory data

Response
application/json
{ "code": 0, "message": "Success", "data": [ 0 ], "errorList": [ { … } ] }

Request

  • Adjust one specific ShopCategory's order, the sequence need to be greater than 0 and less than the number of ShopCategories.

Rate limit: 10 QPS by appId dimension.

Bodyapplication/jsonrequired
idinteger(int64)required

ShopCategory id

shopIdinteger(int64)required

store id in KeeTa

Example: 25381
sequenceintegerrequired

target sequence

Example: 2455425486
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/shopcategory/updatesequence \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "shopId": 25381,
    "sequence": 2455425486
  }'

Responses

Request executed successfully

Bodyapplication/json
codeintegerrequired

A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.

Enum ValueDescription
0

The request was executed successfully.

Non-zero value

The request execution failed. Specific error details can be viewed in the message field.

Example: 0
messagestringrequired

Text description corresponding to the status code, explaining the operation result or error cause to users.

Example: "Success"
Response
application/json
{ "code": 0, "message": "Success" }

Adjust order of ShopCategories(in batch)

Request

  • Adjust all ShopCategories' sequence in store.
  • Please make sure openShopCategorySequenceDTOList contains all shopCategory in store, otherwise the interface invoke will be rejected.

Rate limit: 10 QPS by appId dimension.

Bodyapplication/jsonrequired
shopIdinteger(int64)required

store id in KeeTa

Example: 25381
openShopCategorySequenceDTOListArray of objects(OpenShopCategorySequenceDTO)required

ShopCategory target sequence data model

openShopCategorySequenceDTOList[].​shopCategoryIdinteger(int64)

Unique Category ID generated by Keeta system.

Example: 5675
openShopCategorySequenceDTOList[].​sequenceinteger

Determines the sorting position of the category in menu displays. Uses 1-based indexing (1 = first position).

Example: 345454657
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/shopcategory/batchupdatesequence \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 25381,
    "openShopCategorySequenceDTOList": [
      {
        "shopCategoryId": 5675,
        "sequence": 345454657
      }
    ]
  }'

Responses

Request executed successfully

Bodyapplication/json
codeintegerrequired

A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.

Enum ValueDescription
0

The request was executed successfully.

Non-zero value

The request execution failed. Specific error details can be viewed in the message field.

Example: 0
messagestringrequired

Text description corresponding to the status code, explaining the operation result or error cause to users.

Example: "Success"
Response
application/json
{ "code": 0, "message": "Success" }
Operations