This API provides comprehensive menu management capabilities for Keeta platform integration, including menu synchronization, product status management, and real-time notifications.
Menu//
- Menu Synchronization
Batch Update SPU Status
Batch Update ChoiceGroupSku Status
Batch Bind OpenItemCode
Menu Synchronization
Keeta Menu Management API (v.1.0.0)
Overview
Keeta Developer Website
Languages
Servers
https://open.mykeeta.com/api/open/
Request
This endpoint allows the bulk updating of product statuses using their SPU OpenItemCode.
Rate Limiting App-level throttling: QPS ≤ 10
Notes
The openItemCode field is mandatory with SPU entity-level uniqueness.
This endpoint supports partial successful updates when processing multiple SPUs in a single request. However, if the entire request contains fundamental structural errors the system will reject the complete batch with a fail response.
When the needLinkage parameter is set to 1, this endpoint facilitates the comprehensive synchronization of status changes not only for the specified SPUs but also for all associated ChoiceGroupSkus. This advanced functionality ensures cohesive inventory and product display management across related product options.
Each request cannot exceed 200 SPUs.
This field controls the visibility and availability of a SPU in the merchant storefront. Status = 0, this setting will immediately deactivate the specified SPU. Status = 1, this setting activates the SPU for public visibility and ordering.
Example: 1
This field determines whether the status change should propagate to related SKUs, with these behaviors: When needLinkage equals 0 the status update applies exclusively to the specified ChoiceGroupSku without affecting any related products. When needLinkage equals 1, the system will automatically identify and update all logically connected ChoiceGroupSkus based on existing mapping between ChoiceGroupSku names match SPU names
Example: 1
https://open.mykeeta.com/api/open/product/spustatus/batchupdatebycode
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://open.mykeeta.com/api/open/product/spustatus/batchupdatebycode \
-H 'Content-Type: application/json' \
-d '{
"shopId": 12345,
"spuOpenItemCodeList": [
"aCV",
"2code"
],
"status": 1,
"needLinkage": 1
}'Request executed successfully
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"
Contains a list of OpenItemCodes for all SPUs whose statuses were successfully changed.
Response
application/json
{ "code": 0, "message": "Success", "data": [ "string" ], "errorList": [ { … } ] }
Request
This endpoint allows users to efficiently modify the status of ChoicegroupSkus using their OpenItemCode.
Rate Limiting App-level throttling: QPS ≤ 10
Notes
- When developers call this endpoint to update the status of multiple options on the Keeta platform, it's essential to understand that the API processes each option independently. This can result in partial success, where some options are successfully updated while others encounter errors.
This field includes ChoicegroupSkus that required status updates.
The OpenItemCode identifier for the ChoiceGroup, provided by the developer.
Example: "SET-77017010009-3"
This field controls the visibility and availability of a ChoiceGroupSku in the merchant storefront. Status = 0, this setting will immediately deactivate the specified ChoiceGroupSku. Status = 1, this setting activates the ChoiceGroupSku for public visibility and ordering.
Example: 1
https://open.mykeeta.com/api/open/product/choicegroupskustatus/batchupdatebycode
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://open.mykeeta.com/api/open/product/choicegroupskustatus/batchupdatebycode \
-H 'Content-Type: application/json' \
-d '{
"shopId": 12345,
"choiceGroupSkuCodePackList": [
{
"choiceGroupCode": "SET-77017010009-3",
"choiceGroupSkuCodes": [
"54ee29c7271d4ce18c5f8c63811e7ab1#77017010009#3#66026020003"
]
}
],
"status": 1
}'Request executed successfully
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"
The quality of OpenItemCodes of choicegroupsku whose statuses were successfully changed.
Example: 239
Response
application/json
{ "code": 0, "message": "Success", "data": 239, "errorList": [ { … } ] }
Request
The endpoints allows developers setting the OpenItemCode mapping relationship using store ID and product name.
Rate Limiting App-level throttling: QPS ≤ 10
Notes
- Existing partners that have already integrated via Keeta ID-based APIs must complete OpenItemCode binding for their existing products through this API before switching to OpenItemCode-based APIs, if they have previously created marketing campaigns on the Keeta platform.
Please specify the mapping relationship between SPU names and their corresponding openItemCodes in this field. For detailed definitions of openItemCode, please refer to the Menu Development Guide documentation.
Developer-provided external identifier that maintains a one-to-one mapping with Keeta's internal spuId. Must be unique across all SPUs. For details, see Menu Integration Guide
Example: "SPU#10001"
List of SKUs associated with this SPU using OpenItemCode references For details, see Menu Integration Guide
https://open.mykeeta.com/api/open/product/mapping/batchupdatebyname
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://open.mykeeta.com/api/open/product/mapping/batchupdatebyname \
-H 'Content-Type: application/json' \
-d '{
"shopId": 12345,
"spuMappingList": [
{
"name": "Spicy Beef Noodles",
"openItemCode": "SPU#10001",
"skuList": [
{
"spec": "Big",
"openItemCode": "1582"
}
],
"languageType": "en"
}
]
}'Request executed successfully
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"
Returns a list of OpenItemCode values for all SPUs that were successfully bound during this API request.
Response
application/json
{ "code": 0, "message": "Success", "data": [ "string" ], "errorList": [ { … } ] }