This API provides comprehensive menu management capabilities for Keeta platform integration, including menu synchronization, product status management, and real-time notifications.
Menu//
- Modify ChoiceGroups(in batch)
Query ShopCategory list
Create a ShopCategory
Modify a ShopCategory
Delete ShopCategories(in batch)
Adjust order of a ShopCategory
Adjust order of ShopCategories(in batch)
Query category attribute list
Query products list
Query a specific product
Create products(in batch)
Modify products(in batch)
Modify the available and unavailable status(in batch)
Query conflict ChoiceGroup before unavailable (in batch)
Delete products(in batch)
Adjust order of a product(in a specific ShopCategory)
Adjust products order in a ShopCategory(in batch)
Adjust products order in a Shop(in batch)
Batch bind Spus picture(support other image urls)
Query ChoiceGroup list
Create ChoiceGroups(in batch)
Batch query which products are using these ChoiceGroups
Delete ChoiceGroups(in batch)
Modify ChoiceGroupSkus available/unavailable status(in batch)
Modify ChoiceGroups(in ba...
Keeta Menu Management API (v.1.0.0)
Overview
Keeta Developer Website
Languages
Servers
https://open.mykeeta.com/api/open/
Request
- if the ChoiceGroupSku.name is the same as Spu.name, normally they will bound.
- ChoiceGroup.maxNumber should greater than or equals to ChoiceGroup.minNumber and ChoiceGroup.maxNumber should greater than 0.
- ChoiceGroupSku.price is required, status is required.
Rate limit: 10 QPS by appId dimension.
ChoiceGroup data model
Unique ChoiceGroup ID generated by Keeta system. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs.
Example: 0
Language code for name field (refer to Menu Integration Guide)
Example: "en"
Language code for nameTranslation (required if translation exists), please refer to Menu API Integration Guide
Example: "zh-HK"
Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant.
Example: 1
Minimum number of ChoiceGroupSkus that must be selected
Example: 0
Maximum number of ChoiceGroupSkus that can be selected
Example: 3
List of available ChoiceGroupSkus in this ChoiceGroup
Primary key for ChoiceGroupSku, mainly used for order API alignment. Changes when names are modified. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs.
Example: 0
Display name of the ChoiceGroupSku. Should match SPU name when representing the same product for internal correlation.
Example: "Ketchup"
Language code for name field (refer to Menu Integration Guide)
Example: "en"
Localized name translation
Example: "番茄醬"
Language code for nameTranslation (required if translation exists), please refer to Menu API Integration Guide
Example: "zh-HK"
Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant.
Example: 1
Delivery price (supports 2 decimal places)
Example: "12.33"
Pickup price (supports 2 decimal places)
Example: "12.33"
Dine-in price (supports 2 decimal places)
Example: "12.33"
Currency code (refer to "Currency Symbols" enum). Defaults to merchant's currency.
Example: "HKD"
Availability status:
0: indicates the ChoiceGroupSku is unavailable / 1: indicates ChoiceGroupSku is available
Example: 1
Third-party ChoiceGroupSku identifier. Mandatory and unique in OpenItemCode-based APIs.
Example: "CHOICE#10001"
Nutritional components (refer to "Nutritional Elements" enum)
Allergen information (refer to "Allergens" enum)
Third-party SPU identifier this ChoiceGroupSku should bind to. Using this to explicitly bind the ChoiceGroupSku to the given SPU.
Third-party SKU identifier this ChoiceGroupSku should bind to. Using this to explicitly bind the ChoiceGroupSku to the given SKU. When a ChoiceGroupSku bind to a SKU, it will use the bounded SKU's ChoiceGroups to form a multi-layer ChoiceGroup structure.
Developer-provided ChoiceGroup identifier. Mandatory and unique in OpenItemCode-based APIs.
Example: "GROUP#10001"
https://open.mykeeta.com/api/open/product/choicegroup/batchcreate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://open.mykeeta.com/api/open/product/choicegroup/batchcreate \
-H 'Content-Type: application/json' \
-d '{
"shopId": 25381,
"choiceGroupList": [
{
"id": 0,
"name": "Sauces",
"sourceLanguageType": "en",
"nameTranslation": "選擇醬料",
"targetLanguageType": "zh-HK",
"nameTranslateType": 1,
"minNumber": 0,
"maxNumber": 3,
"choiceGroupSkuList": [
{
"id": 0,
"name": "Ketchup",
"sourceLanguageType": "en",
"nameTranslation": "番茄醬",
"targetLanguageType": "zh-HK",
"nameTranslateType": 1,
"price": "12.33",
"pickPrice": "12.33",
"canteenPrice": "12.33",
"currency": "HKD",
"status": 1,
"openItemCode": "CHOICE#10001",
"nutritionalInfo": {
"property1": 0,
"property2": 0
},
"allergens": [
"string"
],
"pictureList": [
{
"url": "https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b09999.jpg"
}
],
"relatedSpuOpenItemCode": "string",
"relatedSkuOpenItemCode": "string"
}
],
"openItemCode": "GROUP#10001",
"repeatable": 0
}
]
}'Batch creation result.
A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.
| Enum Value | Description |
|---|---|
| 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
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", "data": [ { … } ], "errorList": [ { … } ] }
Bodyapplication/jsonrequired
ChoiceGroup data model
Unique ChoiceGroup ID generated by Keeta system. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs.
Example: 0
Language code for name field (refer to Menu Integration Guide)
Example: "en"
Language code for nameTranslation (required if translation exists), please refer to Menu API Integration Guide
Example: "zh-HK"
Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant.
Example: 1
Minimum number of ChoiceGroupSkus that must be selected
Example: 0
Maximum number of ChoiceGroupSkus that can be selected
Example: 3
List of available ChoiceGroupSkus in this ChoiceGroup
Primary key for ChoiceGroupSku, mainly used for order API alignment. Changes when names are modified. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs.
Example: 0
Display name of the ChoiceGroupSku. Should match SPU name when representing the same product for internal correlation.
Example: "Ketchup"
Language code for name field (refer to Menu Integration Guide)
Example: "en"
Localized name translation
Example: "番茄醬"
Language code for nameTranslation (required if translation exists), please refer to Menu API Integration Guide
Example: "zh-HK"
Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant.
Example: 1
Delivery price (supports 2 decimal places)
Example: "12.33"
Pickup price (supports 2 decimal places)
Example: "12.33"
Dine-in price (supports 2 decimal places)
Example: "12.33"
Currency code (refer to "Currency Symbols" enum). Defaults to merchant's currency.
Example: "HKD"
Availability status:
0: indicates the ChoiceGroupSku is unavailable / 1: indicates ChoiceGroupSku is available
Example: 1
Third-party ChoiceGroupSku identifier. Mandatory and unique in OpenItemCode-based APIs.
Example: "CHOICE#10001"
Nutritional components (refer to "Nutritional Elements" enum)
Allergen information (refer to "Allergens" enum)
Third-party SPU identifier this ChoiceGroupSku should bind to. Using this to explicitly bind the ChoiceGroupSku to the given SPU.
Third-party SKU identifier this ChoiceGroupSku should bind to. Using this to explicitly bind the ChoiceGroupSku to the given SKU. When a ChoiceGroupSku bind to a SKU, it will use the bounded SKU's ChoiceGroups to form a multi-layer ChoiceGroup structure.
Developer-provided ChoiceGroup identifier. Mandatory and unique in OpenItemCode-based APIs.
Example: "GROUP#10001"
https://open.mykeeta.com/api/open/product/choicegroup/batchupdate
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://open.mykeeta.com/api/open/product/choicegroup/batchupdate \
-H 'Content-Type: application/json' \
-d '{
"shopId": 25381,
"choiceGroupList": [
{
"id": 0,
"name": "Sauces",
"sourceLanguageType": "en",
"nameTranslation": "選擇醬料",
"targetLanguageType": "zh-HK",
"nameTranslateType": 1,
"minNumber": 0,
"maxNumber": 3,
"choiceGroupSkuList": [
{
"id": 0,
"name": "Ketchup",
"sourceLanguageType": "en",
"nameTranslation": "番茄醬",
"targetLanguageType": "zh-HK",
"nameTranslateType": 1,
"price": "12.33",
"pickPrice": "12.33",
"canteenPrice": "12.33",
"currency": "HKD",
"status": 1,
"openItemCode": "CHOICE#10001",
"nutritionalInfo": {
"property1": 0,
"property2": 0
},
"allergens": [
"string"
],
"pictureList": [
{
"url": "https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b09999.jpg"
}
],
"relatedSpuOpenItemCode": "string",
"relatedSkuOpenItemCode": "string"
}
],
"openItemCode": "GROUP#10001",
"repeatable": 0
}
]
}'Batch update result.
A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.
| Enum Value | Description |
|---|---|
| 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
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", "data": [ { … } ], "errorList": [ { … } ] }
https://open.mykeeta.com/api/open/product/choicegroup/listappliedspu
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://open.mykeeta.com/api/open/product/choicegroup/listappliedspu \
-H 'Content-Type: application/json' \
-d '{
"shopId": 25381,
"choiceGroupIdList": [
3123,
4343
]
}'Query applied SPU result.
A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully.
| Enum Value | Description |
|---|---|
| 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
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", "data": [ { … } ], "errorList": [ { … } ] }