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. Product data that can be transmitted in one batch should not exceed 200. If there are more products, please delete them in batches.
  2. The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail.
  3. If needLinkage=1, this API will also delete the linked ChoiceGroupSkus (the same name with Spu). But if the ChoiceGroupSku status violates the rule of ChoiceGroup, it wouldn't be modified.

Rate limit: 50 QPS by appId dimension.

Bodyapplication/jsonrequired
shopIdinteger(int64)required

store id in KeeTa

Example: 25381
spuIdListArray of integers(int64)required

spuId list

Example: [1,2,3]
linkedDelbooleanrequired

true: need linkage deletion false:no need

Example: true
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/spu/batchdel \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 25381,
    "spuIdList": [
      1,
      2,
      3
    ],
    "linkedDel": true
  }'

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 spuId list

errorListArray of objects(ErrorSpu)

failed Spu informations

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

Adjust order of a product(in a specific ShopCategory)

Request

  1. Adjust a product's sequence in a specific ShopCategory.
  2. 0 < sequence <= number of spus.

Rate limit: 10 QPS by appId dimension.

Bodyapplication/jsonrequired
shopIdinteger(int64)required

store id in KeeTa

Example: 1
shopCategoryIdinteger(int64)required

ShopCategory.id

Example: 22
spuIdinteger(int64)required

spuId

Example: 333
sequenceintegerrequired

target sequence

Example: 2
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/spu/updatesequence \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 1,
    "shopCategoryId": 22,
    "spuId": 333,
    "sequence": 2
  }'

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 products order in a ShopCategory(in batch)

Request

  1. Adjust all products' sequence in a specific ShopCategory.
  2. 0 < sequence <= number of spus.
  3. Please make sure spuSequenceDTOList contains all Spu in the ShopCategory, otherwise it will fail.

Rate limit: 10 QPS by appId dimension.

Bodyapplication/jsonrequired
shopIdinteger(int64)required

store id in KeeTa

shopCategoryIdinteger(int64)required

ShopCategory id

spuSequenceDTOListArray of objects(OpenSpuSequenceDTO)required

Spu sequence data model

spuSequenceDTOList[].​spuIdinteger(int64)

Unique identifier for the SPU, generated by Keeta system.

spuSequenceDTOList[].​sequenceinteger

Determines the sorting position of the SPU in menu displays. Uses 1-based indexing (1 = first position). Lower numbers appear before higher numbers.

curl -i -X POST \
  https://open.mykeeta.com/api/open/product/spu/batchupdatesequence \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 0,
    "shopCategoryId": 0,
    "spuSequenceDTOList": [
      {
        "spuId": 0,
        "sequence": 0
      }
    ]
  }'

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