Skip to content
Menu/
/
Adjust products order in...

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
menu.json
menu.yaml
Overview
Keeta Developer Website

https://developers.mykeeta.com/

Languages
Servers

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

OpenItemCode-Based

Operations

Webhooks

Webhooks

KeetaID-Based

Operations

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"
}

Adjust products order in a Shop(in batch)

Request

  1. Mostly like 3.3.9 but support multiple ShopCategories.

Rate limit: 10 QPS by appId dimension.

Bodyapplication/jsonrequired
shopIdinteger(int64)required

store id in KeeTa

shopCategoryId2SpuSeqMapobjectrequired

key: ShopCategory.id value: Spu sequence data model

shopCategoryId2SpuSeqMap.​property name*Array of objects(OpenSpuSequenceDTO)additional property
curl -i -X POST \
  https://open.mykeeta.com/api/open/product/spu/batchupdateallsequence \
  -H 'Content-Type: application/json' \
  -d '{
    "shopId": 0,
    "shopCategoryId2SpuSeqMap": {
      "property1": [
        {
          "spuId": 0,
          "sequence": 0
        }
      ],
      "property2": [
        {
          "spuId": 0,
          "sequence": 0
        }
      ]
    }
  }'

Responses

Batch update all sequence 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

errorListArray of objects(ErrorShopCategory)

failed ShopCategory informations

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

Product Picture

Operations