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

Modify the available and unavailable status(in batch)

Request

  1. Product data that can be transmitted in one batch should not exceed 200. If there are more products, please create 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 there is no available product in a ShopCategory, the ShopCategory will disapear at user APP.
  4. If needLinkage=1, this API will also modify the status linked to the ChoiceGroupSkus (the same name with Spu). But if the ChoiceGroupSku status violates the rule of ChoiceGroup, it wouldn't be modified.

Rate limit: 10 QPS by appId dimension.

Bodyapplication/jsonrequired
shopIdinteger(int64)required

store id in KeeTa

Example: 25381
spuIdListArray of integers(int64)required

Spu id list

Example: [1,2,3]
statusintegerrequired

1 - available 0 - unavailable

Example: 1
needLinkageinteger

1 - need linkage modification else - no need

Default 0
Example: 1
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/spustatus/batchupdate \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 25381,
    "spuIdList": [
      1,
      2,
      3
    ],
    "status": 1,
    "needLinkage": 1
  }'

Responses

Batch status update 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 objects(SPU)

Successful Spu data model

errorListArray of objects(ErrorSpu)

Failed Spu informations

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

Query conflict ChoiceGroup before unavailable (in batch)

Request

  1. Query if there is any rule-violated ChoiceGroup when unavailable a Spu with linkage.

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]
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/spu/batchcheck \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 25381,
    "spuIdList": [
      1,
      2,
      3
    ]
  }'

Responses

Conflict check 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 objects(ConflictGroup)

conflict group data model

errorListArray of objects(ErrorSpu)

failed Spu information

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

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": [ {} ] }
Operations