{"items":[{"type":"link","label":"Keeta Menu Management API","link":"/apis/standard/menu","routeSlug":"/apis/standard/menu","content":{"contentType":"overview","meta":{"name":"Keeta Menu Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"menu.json","url":"/_bundle/apis/@standard/menu.json?download"},{"kind":"download","label":"menu.yaml","url":"/_bundle/apis/@standard/menu.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"Keeta Developer Website","email":"https://developers.mykeeta.com/","label":"https://developers.mykeeta.com/","withCopyButton":true,"copyContent":"https://developers.mykeeta.com/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://open.mykeeta.com/api/open"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Keeta Menu Management API (v.1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This API provides comprehensive menu management capabilities for Keeta platform integration, including menu synchronization, product status management, and real-time notifications."}],"sectionId":"/apis/standard/menu"}],"sectionId":"/apis/standard/menu"}]}]}},{"type":"group","label":"OpenItemCode-Based","link":"/apis/standard/menu/openitemcode-based","routeSlug":"/apis/standard/menu/openitemcode-based","items":[{"label":"Menu Synchronization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/openitemcode-based/menusync","routeSlug":"/apis/standard/menu/openitemcode-based/menusync","metadata":{"seo":{"title":"Menu Synchronization","description":"This endpoint enables menu synchronization for stores on Keeta. The system performs full-menu updates based on the provided data, implementing entity matching through the openItemCode field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"menuSync","name":"Menu Synchronization","isWebhook":false,"pointer":"/paths/~1product~1menu~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Menu Synchronization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint enables menu synchronization for stores on Keeta. The system performs full-menu updates based on the provided data, implementing entity matching through the openItemCode field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App-level throttling: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QPS ≤ 50"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity Matching Logic"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system identifies entities as follows:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": When matching openItemCode values exist in the store's current menu"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Addition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": When no matching openItemCode values are found"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": All existing entities with openItemCode values not present in the request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2. Execution Semantics"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response only confirms successful submission of the synchronization task. Certain items may still fail during processing due to validation rules, requiring manual verification and resubmission by the caller."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3. Image Handling"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoints supports standard HTTP/HTTPS (ports 80/443) external image URLs, which must comply with platform specifications regarding size, format, and accessibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4. Validation Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Category"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- The openItemCode field is mandatory and must maintain uniqueness across entities"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Each store cannot exceed 100 menu categories"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Category names must be unique within a single store"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Only one mandatory category is permitted per store"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Categories become hidden when all contained products are delisted, and are repositioned when products become temporarily unavailable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choicegroup"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- The openItemCode field is mandatory with entity-level uniqueness"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Maximum 2,000 option groups per store"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Maximum 10,000 options per store"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Use the relatedSpuOpenItemCode to explicitly bind the ChoiceGroupSku to an existing SPU entity"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Use the relatedSkuOpenItemCode to explicitly bind the ChoiceGroupSku to an existing SKU entity. When the ChoiceGroupSku binds to a SKU, it will use the bounded SKU''s ChoiceGroups to form a multi-layer ChoiceGroup structure."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- When both relatedSkuOpenItemCode and relatedSpuOpenItemCode are declared, there will be a association check to ensure the SKU belongs to the declared SPU."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- If both relatedSpuOpenItemCode and relatedSkuOpenItemCode are not specified, automatic binding occurs when the ChoiceGroupSku name matches a SPU name, enabling coordinated SPUs and ChoiceGroupSku status management"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"em","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Note: If multiple SPUs share identical names, the system randomly selects one for binding, which may lead to unintended synchronization.)"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- External image URLs are supported in the pictureList field"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product (SPU)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- The openItemCode field is mandatory with entity-level uniqueness"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Maximum 2,000 SPUs per store"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Maximum 15 featured products per store"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Tobacco/alcohol products must have corresponding attributes marked as \"Yes\""},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- External image URLs are supported in the pictureList field"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Time-limited availability slots cannot overlap and are limited to 30 time periods"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- The shopCategoryOpenItemCodeList request should include the menu category openItemCode which exists in the specific store"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- The choiceGroupOpenItemCodeList request should include the choicegroup openItemCode which exists in the specific store"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Sorting"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Optional field that defaults to upload sequence when empty"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- Requires complete sorting data for all products across all categories when provided"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165"}},"schemaId":"schema_165","pointer":"/paths/~1product~1menu~1sync/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/menu/sync","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_165"}},"responseCodes":["200"],"pointer":"/product/menu/sync","href":"openitemcode-based/menusync","openApiOperationId":"menuSync","summary":"Menu Synchronization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_165","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}},"schemaId":"schema_166"}],"pointer":"/paths/~1product~1menu~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_166","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/openitemcode-based/menusync"}],"panels":[]}]},"httpPath":"/product/menu/sync"},{"label":"Batch Update SPU Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/openitemcode-based/batchupdatespustatus","routeSlug":"/apis/standard/menu/openitemcode-based/batchupdatespustatus","metadata":{"seo":{"title":"Batch Update SPU Status","description":"This endpoint allows the bulk updating of product statuses using their SPU OpenItemCode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchUpdateSPUStatus","name":"Batch Update SPU Status","isWebhook":false,"pointer":"/paths/~1product~1spustatus~1batchupdatebycode/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Update SPU Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows the bulk updating of product statuses using their SPU OpenItemCode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App-level throttling: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QPS ≤ 10"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The openItemCode field is mandatory with SPU entity-level uniqueness."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each request cannot exceed 200 SPUs."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167"}},"schemaId":"schema_167","pointer":"/paths/~1product~1spustatus~1batchupdatebycode/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spustatus/batchupdatebycode","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_167"}},"responseCodes":["200"],"pointer":"/product/spustatus/batchupdatebycode","href":"openitemcode-based/batchupdatespustatus","openApiOperationId":"batchUpdateSPUStatus","summary":"Batch Update SPU Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_167","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}},"schemaId":"schema_168"}],"pointer":"/paths/~1product~1spustatus~1batchupdatebycode/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_168","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_168"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/openitemcode-based/batchupdatespustatus"}],"panels":[]}]},"httpPath":"/product/spustatus/batchupdatebycode"},{"label":"Batch Update ChoiceGroupSku Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/openitemcode-based/batchupdatechoicegroupskustatus","routeSlug":"/apis/standard/menu/openitemcode-based/batchupdatechoicegroupskustatus","metadata":{"seo":{"title":"Batch Update ChoiceGroupSku Status","description":"This endpoint allows users to efficiently modify the status of ChoicegroupSkus using their OpenItemCode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchUpdateChoiceGroupSkuStatus","name":"Batch Update ChoiceGroupSku Status","isWebhook":false,"pointer":"/paths/~1product~1choicegroupskustatus~1batchupdatebycode/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Update ChoiceGroupSku Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows users to efficiently modify the status of ChoicegroupSkus using their OpenItemCode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App-level throttling: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QPS ≤ 10"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_169"}},"schemaId":"schema_169","pointer":"/paths/~1product~1choicegroupskustatus~1batchupdatebycode/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/choicegroupskustatus/batchupdatebycode","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_169"}},"responseCodes":["200"],"pointer":"/product/choicegroupskustatus/batchupdatebycode","href":"openitemcode-based/batchupdatechoicegroupskustatus","openApiOperationId":"batchUpdateChoiceGroupSkuStatus","summary":"Batch Update ChoiceGroupSku Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_169","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_169"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}},"schemaId":"schema_170"}],"pointer":"/paths/~1product~1choicegroupskustatus~1batchupdatebycode/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_170","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_170"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/openitemcode-based/batchupdatechoicegroupskustatus"}],"panels":[]}]},"httpPath":"/product/choicegroupskustatus/batchupdatebycode"},{"label":"Batch Bind OpenItemCode","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/openitemcode-based/batchbindopenitemcode","routeSlug":"/apis/standard/menu/openitemcode-based/batchbindopenitemcode","metadata":{"seo":{"title":"Batch Bind OpenItemCode","description":"The endpoints allows developers setting the OpenItemCode mapping relationship using store ID and product name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchBindOpenItemCode","name":"Batch Bind OpenItemCode","isWebhook":false,"pointer":"/paths/~1product~1mapping~1batchupdatebyname/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Bind OpenItemCode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoints allows developers setting the OpenItemCode mapping relationship using store ID and product name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App-level throttling: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QPS ≤ 10"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_171"}},"schemaId":"schema_171","pointer":"/paths/~1product~1mapping~1batchupdatebyname/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/mapping/batchupdatebyname","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_171"}},"responseCodes":["200"],"pointer":"/product/mapping/batchupdatebyname","href":"openitemcode-based/batchbindopenitemcode","openApiOperationId":"batchBindOpenItemCode","summary":"Batch Bind OpenItemCode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_171","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_171"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172"}},"schemaId":"schema_172"}],"pointer":"/paths/~1product~1mapping~1batchupdatebyname/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_172","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_172"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/openitemcode-based/batchbindopenitemcode"}],"panels":[]}]},"httpPath":"/product/mapping/batchupdatebyname"}],"content":{"contentType":"group","meta":{"name":"OpenItemCode-Based"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"OpenItemCode-Based","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/product/menu/sync","summary":"Menu Synchronization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/openitemcode-based/menusync","deprecated":false},{"title":"/product/spustatus/batchupdatebycode","summary":"Batch Update SPU Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/openitemcode-based/batchupdatespustatus","deprecated":false},{"title":"/product/choicegroupskustatus/batchupdatebycode","summary":"Batch Update ChoiceGroupSku Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/openitemcode-based/batchupdatechoicegroupskustatus","deprecated":false},{"title":"/product/mapping/batchupdatebyname","summary":"Batch Bind OpenItemCode","prefix":{"name":"post","color":"post"},"badges":[],"link":"/openitemcode-based/batchbindopenitemcode","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/apis/standard/menu/webhooks","routeSlug":"/apis/standard/menu/webhooks","items":[{"label":"Picture Bind Task Completion Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/menu/webhooks/picturebindtaskcompletionnotification","routeSlug":"/apis/standard/menu/webhooks/picturebindtaskcompletionnotification","metadata":{"seo":{"title":"Picture Bind Task Completion Notification","description":"Item's Picture Bind Task operates asynchronously. When Keeta's platform receives a MenuSync request, it creates two separate internal tasks, one for syncing the menu and another for uploading item images. Upon the image task completion (success or failure), Keeta will notify developers via this webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PictureBindTaskCompletionNotification","name":"Picture Bind Task Completion Notification","isWebhook":true,"pointer":"/paths/PictureBindTaskCompletionNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Picture Bind Task Completion Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item's Picture Bind Task"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operates asynchronously. When Keeta's platform receives a MenuSync request, it creates two separate internal tasks, one for syncing the menu and another for uploading item images. Upon the image task completion (success or failure), Keeta will notify developers via this webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ID:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 1201"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_173"}},"schemaId":"schema_173","pointer":"/paths/PictureBindTaskCompletionNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"PictureBindTaskCompletionNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_173"}},"responseCodes":["200"],"pointer":"PictureBindTaskCompletionNotification","href":"webhooks/picturebindtaskcompletionnotification","openApiOperationId":"PictureBindTaskCompletionNotification","summary":"Picture Bind Task Completion Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_173","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_173"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"}],"pointer":"/paths/PictureBindTaskCompletionNotification/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/picturebindtaskcompletionnotification"}],"panels":[]}]},"httpPath":"PictureBindTaskCompletionNotification"},{"label":"Menu Synchronization Task Completion Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/menu/webhooks/menusynchronizationtaskcompletionnotification","routeSlug":"/apis/standard/menu/webhooks/menusynchronizationtaskcompletionnotification","metadata":{"seo":{"title":"Menu Synchronization Task Completion Notification","description":"The Menu Synchronization API operates asynchronously. When Keeta's platform receives a synchronization request, it creates an internal task for processing. Upon task completion (success or failure), Keeta will notify developers via this webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"menuSynchronizationTaskCompletionNotification","name":"Menu Synchronization Task Completion Notification","isWebhook":true,"pointer":"/paths/menuSynchronizationTaskCompletionWebhook/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Menu Synchronization Task Completion Notification","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu Synchronization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API operates asynchronously. When Keeta's platform receives a synchronization request, it creates an internal task for processing. Upon task completion (success or failure), Keeta will notify developers via this webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ID:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 1202"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_174"}},"schemaId":"schema_174","pointer":"/paths/menuSynchronizationTaskCompletionWebhook/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"menuSynchronizationTaskCompletionWebhook","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_174"}},"responseCodes":["200"],"pointer":"menuSynchronizationTaskCompletionWebhook","href":"webhooks/menusynchronizationtaskcompletionnotification","openApiOperationId":"menuSynchronizationTaskCompletionNotification","summary":"Menu Synchronization Task Completion Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_174","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_174"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"}],"pointer":"/paths/menuSynchronizationTaskCompletionWebhook/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/menusynchronizationtaskcompletionnotification"}],"panels":[]}]},"httpPath":"menuSynchronizationTaskCompletionWebhook"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"PictureBindTaskCompletionNotification","summary":"Picture Bind Task Completion Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/picturebindtaskcompletionnotification","deprecated":false},{"title":"menuSynchronizationTaskCompletionWebhook","summary":"Menu Synchronization Task Completion Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/menusynchronizationtaskcompletionnotification","deprecated":false}]}]}]}]}},{"type":"group","label":"KeetaID-Based","link":"/apis/standard/menu/keetaid-based","routeSlug":"/apis/standard/menu/keetaid-based","items":[{"label":"Query ShopCategory list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/queryshopcategorylist","routeSlug":"/apis/standard/menu/keetaid-based/queryshopcategorylist","metadata":{"seo":{"title":"Query ShopCategory list","description":"Query the list of ShopCategory information in store."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryShopCategoryList","name":"Query ShopCategory list","isWebhook":false,"pointer":"/paths/~1product~1shopcategory~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query ShopCategory list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query the list of ShopCategory information in store."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 50 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"schemaId":"schema_175","pointer":"/paths/~1product~1shopcategory~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/shopcategory/list","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_175"}},"responseCodes":["200"],"pointer":"/product/shopcategory/list","href":"keetaid-based/queryshopcategorylist","openApiOperationId":"queryShopCategoryList","summary":"Query ShopCategory list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_175","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful returns ShopCategory list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}},"schemaId":"schema_176"}],"pointer":"/paths/~1product~1shopcategory~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_176","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/queryshopcategorylist"}],"panels":[]}]},"httpPath":"/product/shopcategory/list"},{"label":"Create a ShopCategory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/createshopcategory","routeSlug":"/apis/standard/menu/keetaid-based/createshopcategory","metadata":{"seo":{"title":"Create a ShopCategory","description":"Only for creating in-store ShopCategory.The names of ShopCategory in a store are not allowed to be repeated.The maximum \"mandatory\" ShopCategory number for each store is 1.When there is no product available for sale under the ShopCategory (including products offshelf), the ShopCategory will not be displayed on our user APP.The number of ShopCategory can not exceed 100."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createShopCategory","name":"Create a ShopCategory","isWebhook":false,"pointer":"/paths/~1product~1shopcategory~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a ShopCategory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for creating in-store ShopCategory."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names of ShopCategory in a store are not allowed to be repeated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum \"mandatory\" ShopCategory number for each store is 1."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When there is no product available for sale under the ShopCategory (including products offshelf), the ShopCategory will not be displayed on our user APP."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of ShopCategory can not exceed 100."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_177"}},"schemaId":"schema_177","pointer":"/paths/~1product~1shopcategory~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/shopcategory/create","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_177"}},"responseCodes":["200"],"pointer":"/product/shopcategory/create","href":"keetaid-based/createshopcategory","openApiOperationId":"createShopCategory","summary":"Create a ShopCategory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_177","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_177"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful creation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178"}},"schemaId":"schema_178"}],"pointer":"/paths/~1product~1shopcategory~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_178","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/createshopcategory"}],"panels":[]}]},"httpPath":"/product/shopcategory/create"},{"label":"Modify a ShopCategory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/updateshopcategory","routeSlug":"/apis/standard/menu/keetaid-based/updateshopcategory","metadata":{"seo":{"title":"Modify a ShopCategory","description":"To update a ShopCategory information, will keep its original IDPlease ensure that each parameter is the value you want to update."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShopCategory","name":"Modify a ShopCategory","isWebhook":false,"pointer":"/paths/~1product~1shopcategory~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify a ShopCategory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a ShopCategory information, will keep its original ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please ensure that each parameter is the value you want to update."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_177"}},"schemaId":"schema_177","pointer":"/paths/~1product~1shopcategory~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/shopcategory/update","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_177"}},"responseCodes":["200"],"pointer":"/product/shopcategory/update","href":"keetaid-based/updateshopcategory","openApiOperationId":"updateShopCategory","summary":"Modify a ShopCategory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_177","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_177"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful update.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178"}},"schemaId":"schema_178"}],"pointer":"/paths/~1product~1shopcategory~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_178","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/updateshopcategory"}],"panels":[]}]},"httpPath":"/product/shopcategory/update"},{"label":"Delete ShopCategories(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/deleteshopcategories","routeSlug":"/apis/standard/menu/keetaid-based/deleteshopcategories","metadata":{"seo":{"title":"Delete ShopCategories(in batch)","description":"You can only delete ShopCategory that doesn't contain any product.Please make sure the ShopCategory.id is in-store."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteShopCategories","name":"Delete ShopCategories(in batch)","isWebhook":false,"pointer":"/paths/~1product~1shopcategory~1batchdel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete ShopCategories(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only delete ShopCategory that doesn't contain any product."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please make sure the ShopCategory.id is in-store."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179"}},"schemaId":"schema_179","pointer":"/paths/~1product~1shopcategory~1batchdel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/shopcategory/batchdel","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_179"}},"responseCodes":["200"],"pointer":"/product/shopcategory/batchdel","href":"keetaid-based/deleteshopcategories","openApiOperationId":"deleteShopCategories","summary":"Delete ShopCategories(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_179","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_179"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch deletion result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180"}},"schemaId":"schema_180"}],"pointer":"/paths/~1product~1shopcategory~1batchdel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_180","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_180"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/deleteshopcategories"}],"panels":[]}]},"httpPath":"/product/shopcategory/batchdel"},{"label":"Adjust order of a ShopCategory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/updateshopcategorysequence","routeSlug":"/apis/standard/menu/keetaid-based/updateshopcategorysequence","metadata":{"seo":{"title":"Adjust order of a ShopCategory","description":"Adjust one specific ShopCategory's order, the sequence need to be greater than 0 and less than the number of ShopCategories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateShopCategorySequence","name":"Adjust order of a ShopCategory","isWebhook":false,"pointer":"/paths/~1product~1shopcategory~1updatesequence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adjust order of a ShopCategory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adjust one specific ShopCategory's order, the sequence need to be greater than 0 and less than the number of ShopCategories."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_181"}},"schemaId":"schema_181","pointer":"/paths/~1product~1shopcategory~1updatesequence/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/shopcategory/updatesequence","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_181"}},"responseCodes":["200"],"pointer":"/product/shopcategory/updatesequence","href":"keetaid-based/updateshopcategorysequence","openApiOperationId":"updateShopCategorySequence","summary":"Adjust order of a ShopCategory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_181","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_181"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"}],"pointer":"/paths/~1product~1shopcategory~1updatesequence/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/updateshopcategorysequence"}],"panels":[]}]},"httpPath":"/product/shopcategory/updatesequence"},{"label":"Adjust order of ShopCategories(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/batchupdateshopcategorysequence","routeSlug":"/apis/standard/menu/keetaid-based/batchupdateshopcategorysequence","metadata":{"seo":{"title":"Adjust order of ShopCategories(in batch)","description":"Adjust all ShopCategories' sequence in store.Please make sure openShopCategorySequenceDTOList contains all shopCategory in store, otherwise the interface invoke will be rejected."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchUpdateShopCategorySequence","name":"Adjust order of ShopCategories(in batch)","isWebhook":false,"pointer":"/paths/~1product~1shopcategory~1batchupdatesequence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adjust order of ShopCategories(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adjust all ShopCategories' sequence in store."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please make sure openShopCategorySequenceDTOList contains all shopCategory in store, otherwise the interface invoke will be rejected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_182"}},"schemaId":"schema_182","pointer":"/paths/~1product~1shopcategory~1batchupdatesequence/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/shopcategory/batchupdatesequence","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_182"}},"responseCodes":["200"],"pointer":"/product/shopcategory/batchupdatesequence","href":"keetaid-based/batchupdateshopcategorysequence","openApiOperationId":"batchUpdateShopCategorySequence","summary":"Adjust order of ShopCategories(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_182","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_182"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"}],"pointer":"/paths/~1product~1shopcategory~1batchupdatesequence/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/batchupdateshopcategorysequence"}],"panels":[]}]},"httpPath":"/product/shopcategory/batchupdatesequence"},{"label":"Query category attribute list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/querycategorypropertylist","routeSlug":"/apis/standard/menu/keetaid-based/querycategorypropertylist","metadata":{"seo":{"title":"Query category attribute list","description":"Get the category attribute list based on the final category ID, which is used for operations such as creating products.Since there is no backend category field for this period, the categoryId can be fixed to -1."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryCategoryPropertyList","name":"Query category attribute list","isWebhook":false,"pointer":"/paths/~1product~1categoryproperty~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query category attribute list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the category attribute list based on the final category ID, which is used for operations such as creating products."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Since there is no backend category field for this period, the categoryId can be fixed to -1."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 50 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_183"}},"schemaId":"schema_183","pointer":"/paths/~1product~1categoryproperty~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/categoryproperty/list","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_183"}},"responseCodes":["200"],"pointer":"/product/categoryproperty/list","href":"keetaid-based/querycategorypropertylist","openApiOperationId":"queryCategoryPropertyList","summary":"Query category attribute list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_183","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_183"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful returns category attribute list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}},"schemaId":"schema_184"}],"pointer":"/paths/~1product~1categoryproperty~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_184","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/querycategorypropertylist"}],"panels":[]}]},"httpPath":"/product/categoryproperty/list"},{"label":"Query products list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/queryproductslist","routeSlug":"/apis/standard/menu/keetaid-based/queryproductslist","metadata":{"seo":{"title":"Query products list","description":"Get all valid products in store."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductsList","name":"Query products list","isWebhook":false,"pointer":"/paths/~1product~1spu~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query products list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all valid products in store."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 50 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"schemaId":"schema_175","pointer":"/paths/~1product~1spu~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/list","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_175"}},"responseCodes":["200"],"pointer":"/product/spu/list","href":"keetaid-based/queryproductslist","openApiOperationId":"queryProductsList","summary":"Query products list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_175","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful returns product list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185"}},"schemaId":"schema_185"}],"pointer":"/paths/~1product~1spu~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_185","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_185"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/queryproductslist"}],"panels":[]}]},"httpPath":"/product/spu/list"},{"label":"Query a specific product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/queryproductdetail","routeSlug":"/apis/standard/menu/keetaid-based/queryproductdetail","metadata":{"seo":{"title":"Query a specific product","description":"Get a specific product info through ID, this is far more fast comparing to query products list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProductDetail","name":"Query a specific product","isWebhook":false,"pointer":"/paths/~1product~1spu~1detail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query a specific product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a specific product info through ID, this is far more fast comparing to query products list."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 100 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_186"}},"schemaId":"schema_186","pointer":"/paths/~1product~1spu~1detail/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/detail","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_186"}},"responseCodes":["200"],"pointer":"/product/spu/detail","href":"keetaid-based/queryproductdetail","openApiOperationId":"queryProductDetail","summary":"Query a specific product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_186","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_186"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful returns product detail.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}},"schemaId":"schema_187"}],"pointer":"/paths/~1product~1spu~1detail/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_187","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/queryproductdetail"}],"panels":[]}]},"httpPath":"/product/spu/detail"},{"label":"Create products(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/createproducts","routeSlug":"/apis/standard/menu/keetaid-based/createproducts","metadata":{"seo":{"title":"Create products(in batch)","description":"Product data that can be transmitted in one batch should not exceed 200. If there are more products, please create them in batches.The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail.You can not create \"ShopCategory\" or \"ChoiceGroup\" through this interface, please make sure all the ShopCategory.id and ChoiceGroup.id are already exist in store.Regarding the product image related Field, please use the \"Image upload API\" to upload the image to the KeeTa system first, than get the image URL and pass into the Picture.url field.If it is a tobacco and alcohol product, please be sure to fill in the relevant attributes in the [Product Attributes] field to avoid regulatory issues.If a Spu contains only one Sku, then the Sku.spec field is allowed to remain empty, otherwise the Sku.spec in a specific Spu need to be filled.The Sku.price is required and supports up to two decimal places.Spu.avaliableTime is required.\"Specialty\" dish can not exceed 15 in a store."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProducts","name":"Create products(in batch)","isWebhook":false,"pointer":"/paths/~1product~1spu~1batchcreate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create products(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product data that can be transmitted in one batch should not exceed 200. If there are more products, please create them in batches."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can not create \"ShopCategory\" or \"ChoiceGroup\" through this interface, please make sure all the ShopCategory.id and ChoiceGroup.id are already exist in store."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regarding the product image related Field, please use the \"Image upload API\" to upload the image to the KeeTa system first, than get the image URL and pass into the Picture.url field."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If it is a tobacco and alcohol product, please be sure to fill in the relevant attributes in the [Product Attributes] field to avoid regulatory issues."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a Spu contains only one Sku, then the Sku.spec field is allowed to remain empty, otherwise the Sku.spec in a specific Spu need to be filled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Sku.price is required and supports up to two decimal places."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spu.avaliableTime is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Specialty\" dish can not exceed 15 in a store."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_188"}},"schemaId":"schema_188","pointer":"/paths/~1product~1spu~1batchcreate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/batchcreate","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_188"}},"responseCodes":["200"],"pointer":"/product/spu/batchcreate","href":"keetaid-based/createproducts","openApiOperationId":"createProducts","summary":"Create products(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_188","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_188"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch creation result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}},"schemaId":"schema_189"}],"pointer":"/paths/~1product~1spu~1batchcreate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_189","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/createproducts"}],"panels":[]}]},"httpPath":"/product/spu/batchcreate"},{"label":"Modify products(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/updateproducts","routeSlug":"/apis/standard/menu/keetaid-based/updateproducts","metadata":{"seo":{"title":"Modify products(in batch)","description":"Mostly like 3.3.3.Through this interface, you can update Spu with its ID unchanged, this is very important for Promotion activities, which are based on Spu.id and Sku.id.As for Sku, if the Sku.id is filled, please make sure the Sku.id is belongs to this Spu. If Sku.id is not filled, we will treat it as a new one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProducts","name":"Modify products(in batch)","isWebhook":false,"pointer":"/paths/~1product~1spu~1batchupdate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify products(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mostly like 3.3.3."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Through this interface, you can update Spu with its ID unchanged, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this is very important for Promotion activities, which are based on Spu.id and Sku.id"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As for Sku, if the Sku.id is filled, please make sure the Sku.id is belongs to this Spu. If Sku.id is not filled, we will treat it as a new one."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_188"}},"schemaId":"schema_188","pointer":"/paths/~1product~1spu~1batchupdate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/batchupdate","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_188"}},"responseCodes":["200"],"pointer":"/product/spu/batchupdate","href":"keetaid-based/updateproducts","openApiOperationId":"updateProducts","summary":"Modify products(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_188","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_188"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch update result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}},"schemaId":"schema_190"}],"pointer":"/paths/~1product~1spu~1batchupdate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_190","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_190"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/updateproducts"}],"panels":[]}]},"httpPath":"/product/spu/batchupdate"},{"label":"Modify the available and unavailable status(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/updateproductsstatus","routeSlug":"/apis/standard/menu/keetaid-based/updateproductsstatus","metadata":{"seo":{"title":"Modify the available and unavailable status(in batch)","description":"Product data that can be transmitted in one batch should not exceed 200. If there are more products, please create them in batches.The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail.If there is no available product in a ShopCategory, the ShopCategory will disapear at user APP.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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductsStatus","name":"Modify the available and unavailable status(in batch)","isWebhook":false,"pointer":"/paths/~1product~1spustatus~1batchupdate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify the available and unavailable status(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product data that can be transmitted in one batch should not exceed 200. If there are more products, please create them in batches."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there is no available product in a ShopCategory, the ShopCategory will disapear at user APP."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_191"}},"schemaId":"schema_191","pointer":"/paths/~1product~1spustatus~1batchupdate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spustatus/batchupdate","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_191"}},"responseCodes":["200"],"pointer":"/product/spustatus/batchupdate","href":"keetaid-based/updateproductsstatus","openApiOperationId":"updateProductsStatus","summary":"Modify the available and unavailable status(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_191","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_191"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch status update result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192"}},"schemaId":"schema_192"}],"pointer":"/paths/~1product~1spustatus~1batchupdate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_192","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/updateproductsstatus"}],"panels":[]}]},"httpPath":"/product/spustatus/batchupdate"},{"label":"Query conflict ChoiceGroup before unavailable (in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/checkproductsconflict","routeSlug":"/apis/standard/menu/keetaid-based/checkproductsconflict","metadata":{"seo":{"title":"Query conflict ChoiceGroup before unavailable (in batch)","description":"Query if there is any rule-violated ChoiceGroup when unavailable a Spu with linkage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkProductsConflict","name":"Query conflict ChoiceGroup before unavailable (in batch)","isWebhook":false,"pointer":"/paths/~1product~1spu~1batchcheck/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query conflict ChoiceGroup before unavailable (in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query if there is any rule-violated ChoiceGroup when unavailable a Spu with linkage."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 50 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_193"}},"schemaId":"schema_193","pointer":"/paths/~1product~1spu~1batchcheck/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/batchcheck","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_193"}},"responseCodes":["200"],"pointer":"/product/spu/batchcheck","href":"keetaid-based/checkproductsconflict","openApiOperationId":"checkProductsConflict","summary":"Query conflict ChoiceGroup before unavailable (in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_193","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_193"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflict check result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}},"schemaId":"schema_194"}],"pointer":"/paths/~1product~1spu~1batchcheck/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_194","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/checkproductsconflict"}],"panels":[]}]},"httpPath":"/product/spu/batchcheck"},{"label":"Delete products(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/deleteproducts","routeSlug":"/apis/standard/menu/keetaid-based/deleteproducts","metadata":{"seo":{"title":"Delete products(in batch)","description":"Product data that can be transmitted in one batch should not exceed 200. If there are more products, please delete them in batches.The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail.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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProducts","name":"Delete products(in batch)","isWebhook":false,"pointer":"/paths/~1product~1spu~1batchdel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete products(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product data that can be transmitted in one batch should not exceed 200. If there are more products, please delete them in batches."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The interface supports partial synchronization success and partial synchronization failure. However, if there is a parameter format error, all will fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 50 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_195"}},"schemaId":"schema_195","pointer":"/paths/~1product~1spu~1batchdel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/batchdel","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_195"}},"responseCodes":["200"],"pointer":"/product/spu/batchdel","href":"keetaid-based/deleteproducts","openApiOperationId":"deleteProducts","summary":"Delete products(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_195","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_195"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch deletion result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196"}},"schemaId":"schema_196"}],"pointer":"/paths/~1product~1spu~1batchdel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_196","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/deleteproducts"}],"panels":[]}]},"httpPath":"/product/spu/batchdel"},{"label":"Adjust order of a product(in a specific ShopCategory)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/updateproductsequence","routeSlug":"/apis/standard/menu/keetaid-based/updateproductsequence","metadata":{"seo":{"title":"Adjust order of a product(in a specific ShopCategory)","description":"Adjust a product's sequence in a specific ShopCategory.0 < sequence <= number of spus."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductSequence","name":"Adjust order of a product(in a specific ShopCategory)","isWebhook":false,"pointer":"/paths/~1product~1spu~1updatesequence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adjust order of a product(in a specific ShopCategory)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adjust a product's sequence in a specific ShopCategory."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 < sequence <= number of spus."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_197"}},"schemaId":"schema_197","pointer":"/paths/~1product~1spu~1updatesequence/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/updatesequence","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_197"}},"responseCodes":["200"],"pointer":"/product/spu/updatesequence","href":"keetaid-based/updateproductsequence","openApiOperationId":"updateProductSequence","summary":"Adjust order of a product(in a specific ShopCategory)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_197","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_197"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"}],"pointer":"/paths/~1product~1spu~1updatesequence/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/updateproductsequence"}],"panels":[]}]},"httpPath":"/product/spu/updatesequence"},{"label":"Adjust products order in a ShopCategory(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/batchupdateproductsequence","routeSlug":"/apis/standard/menu/keetaid-based/batchupdateproductsequence","metadata":{"seo":{"title":"Adjust products order in a ShopCategory(in batch)","description":"Adjust all products' sequence in a specific ShopCategory.0 < sequence <= number of spus.Please make sure spuSequenceDTOList contains all Spu in the ShopCategory, otherwise it will fail."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchUpdateProductSequence","name":"Adjust products order in a ShopCategory(in batch)","isWebhook":false,"pointer":"/paths/~1product~1spu~1batchupdatesequence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adjust products order in a ShopCategory(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adjust all products' sequence in a specific ShopCategory."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 < sequence <= number of spus."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please make sure spuSequenceDTOList contains all Spu in the ShopCategory, otherwise it will fail."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_198"}},"schemaId":"schema_198","pointer":"/paths/~1product~1spu~1batchupdatesequence/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/batchupdatesequence","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_198"}},"responseCodes":["200"],"pointer":"/product/spu/batchupdatesequence","href":"keetaid-based/batchupdateproductsequence","openApiOperationId":"batchUpdateProductSequence","summary":"Adjust products order in a ShopCategory(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_198","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_198"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}},"schemaId":"components/schemas/CommonResponse"}],"pointer":"/paths/~1product~1spu~1batchupdatesequence/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CommonResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/batchupdateproductsequence"}],"panels":[]}]},"httpPath":"/product/spu/batchupdatesequence"},{"label":"Adjust products order in a Shop(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/batchupdateallproductsequence","routeSlug":"/apis/standard/menu/keetaid-based/batchupdateallproductsequence","metadata":{"seo":{"title":"Adjust products order in a Shop(in batch)","description":"Mostly like 3.3.9 but support multiple ShopCategories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchUpdateAllProductSequence","name":"Adjust products order in a Shop(in batch)","isWebhook":false,"pointer":"/paths/~1product~1spu~1batchupdateallsequence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adjust products order in a Shop(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mostly like 3.3.9 but support multiple ShopCategories."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_199"}},"schemaId":"schema_199","pointer":"/paths/~1product~1spu~1batchupdateallsequence/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spu/batchupdateallsequence","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_199"}},"responseCodes":["200"],"pointer":"/product/spu/batchupdateallsequence","href":"keetaid-based/batchupdateallproductsequence","openApiOperationId":"batchUpdateAllProductSequence","summary":"Adjust products order in a Shop(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_199","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_199"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch update all sequence result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_200"}},"schemaId":"schema_200"}],"pointer":"/paths/~1product~1spu~1batchupdateallsequence/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_200"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/batchupdateallproductsequence"}],"panels":[]}]},"httpPath":"/product/spu/batchupdateallsequence"},{"label":"Batch bind Spus picture(support other image urls)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/batchbindproductpictures","routeSlug":"/apis/standard/menu/keetaid-based/batchbindproductpictures","metadata":{"seo":{"title":"Batch bind Spus picture(support other image urls)","description":"Noticed this is an Asynchronous API, if you want to subscribe error messages, please configure webhook with 「eventId=1201」;Make sure all spuIds are belong to shopId;Image requirements:Image url can be access directly. We only support HTTP/HTTPS protocol for default port (80/tcp or 443/tcp), please don't use other ports;Image size cannot exceed 5M, the minimum aspect of image is 600px * 450px;In image url's header field, the Content-Type can only be \"image/jpeg\" or \"image/png\";"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchBindProductPictures","name":"Batch bind Spus picture(support other image urls)","isWebhook":false,"pointer":"/paths/~1product~1spupicture~1batchbind/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch bind Spus picture(support other image urls)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Noticed this is an Asynchronous API, if you want to subscribe error messages, please configure webhook with 「eventId=1201」;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make sure all spuIds are belong to shopId;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image requirements:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image url can be access directly. We only support HTTP/HTTPS protocol for default port (80/tcp or 443/tcp), please don't use other ports;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image size cannot exceed 5M, the minimum aspect of image is 600px * 450px;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In image url's header field, the Content-Type can only be \""},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image/jpeg"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\" or \""},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image/png"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\";"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_201"}},"schemaId":"schema_201","pointer":"/paths/~1product~1spupicture~1batchbind/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/spupicture/batchbind","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_201"}},"responseCodes":["200"],"pointer":"/product/spupicture/batchbind","href":"keetaid-based/batchbindproductpictures","openApiOperationId":"batchBindProductPictures","summary":"Batch bind Spus picture(support other image urls)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_201","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_201"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch bind pictures task submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_202"}},"schemaId":"schema_202"}],"pointer":"/paths/~1product~1spupicture~1batchbind/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_202","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_202"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/batchbindproductpictures"}],"panels":[]}]},"httpPath":"/product/spupicture/batchbind"},{"label":"Query ChoiceGroup list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/querychoicegrouplist","routeSlug":"/apis/standard/menu/keetaid-based/querychoicegrouplist","metadata":{"seo":{"title":"Query ChoiceGroup list","description":"Query all ChoiceGroups in store."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryChoiceGroupList","name":"Query ChoiceGroup list","isWebhook":false,"pointer":"/paths/~1product~1choicegroup~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query ChoiceGroup list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query all ChoiceGroups in store."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 50 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"schemaId":"schema_175","pointer":"/paths/~1product~1choicegroup~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/choicegroup/list","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_175"}},"responseCodes":["200"],"pointer":"/product/choicegroup/list","href":"keetaid-based/querychoicegrouplist","openApiOperationId":"queryChoiceGroupList","summary":"Query ChoiceGroup list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_175","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_175"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful returns ChoiceGroup list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203"}},"schemaId":"schema_203"}],"pointer":"/paths/~1product~1choicegroup~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_203","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/querychoicegrouplist"}],"panels":[]}]},"httpPath":"/product/choicegroup/list"},{"label":"Create ChoiceGroups(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/createchoicegroups","routeSlug":"/apis/standard/menu/keetaid-based/createchoicegroups","metadata":{"seo":{"title":"Create ChoiceGroups(in batch)","description":"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChoiceGroups","name":"Create ChoiceGroups(in batch)","isWebhook":false,"pointer":"/paths/~1product~1choicegroup~1batchcreate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create ChoiceGroups(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"if the ChoiceGroupSku.name is the same as Spu.name, normally they will bound."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ChoiceGroup.maxNumber should greater than or equals to ChoiceGroup.minNumber and ChoiceGroup.maxNumber should greater than 0."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ChoiceGroupSku.price is required, status is required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_204"}},"schemaId":"schema_204","pointer":"/paths/~1product~1choicegroup~1batchcreate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/choicegroup/batchcreate","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_204"}},"responseCodes":["200"],"pointer":"/product/choicegroup/batchcreate","href":"keetaid-based/createchoicegroups","openApiOperationId":"createChoiceGroups","summary":"Create ChoiceGroups(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_204","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_204"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch creation result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205"}},"schemaId":"schema_205"}],"pointer":"/paths/~1product~1choicegroup~1batchcreate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_205","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/createchoicegroups"}],"panels":[]}]},"httpPath":"/product/choicegroup/batchcreate"},{"label":"Modify ChoiceGroups(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/updatechoicegroups","routeSlug":"/apis/standard/menu/keetaid-based/updatechoicegroups","metadata":{"seo":{"title":"Modify ChoiceGroups(in batch)","description":"Mostly like 3.4.2 but ChoiceGroup.id is required.Please make sure the ChoiceGroup data object is complete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChoiceGroups","name":"Modify ChoiceGroups(in batch)","isWebhook":false,"pointer":"/paths/~1product~1choicegroup~1batchupdate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify ChoiceGroups(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mostly like 3.4.2 but ChoiceGroup.id is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please make sure the ChoiceGroup data object is complete."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_204"}},"schemaId":"schema_204","pointer":"/paths/~1product~1choicegroup~1batchupdate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/choicegroup/batchupdate","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_204"}},"responseCodes":["200"],"pointer":"/product/choicegroup/batchupdate","href":"keetaid-based/updatechoicegroups","openApiOperationId":"updateChoiceGroups","summary":"Modify ChoiceGroups(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_204","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_204"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch update result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205"}},"schemaId":"schema_205"}],"pointer":"/paths/~1product~1choicegroup~1batchupdate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_205","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_205"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/updatechoicegroups"}],"panels":[]}]},"httpPath":"/product/choicegroup/batchupdate"},{"label":"Batch query which products are using these ChoiceGroups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/querychoicegroupappliedspu","routeSlug":"/apis/standard/menu/keetaid-based/querychoicegroupappliedspu","metadata":{"seo":{"title":"Batch query which products are using these ChoiceGroups","description":"Query ChoiceGroup's applied products."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryChoiceGroupAppliedSpu","name":"Batch query which products are using these ChoiceGroups","isWebhook":false,"pointer":"/paths/~1product~1choicegroup~1listappliedspu/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch query which products are using these ChoiceGroups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query ChoiceGroup's applied products."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_206"}},"schemaId":"schema_206","pointer":"/paths/~1product~1choicegroup~1listappliedspu/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/choicegroup/listappliedspu","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_206"}},"responseCodes":["200"],"pointer":"/product/choicegroup/listappliedspu","href":"keetaid-based/querychoicegroupappliedspu","openApiOperationId":"queryChoiceGroupAppliedSpu","summary":"Batch query which products are using these ChoiceGroups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_206","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_206"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query applied SPU result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_207"}},"schemaId":"schema_207"}],"pointer":"/paths/~1product~1choicegroup~1listappliedspu/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_207","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_207"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/querychoicegroupappliedspu"}],"panels":[]}]},"httpPath":"/product/choicegroup/listappliedspu"},{"label":"Delete ChoiceGroups(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/deletechoicegroups","routeSlug":"/apis/standard/menu/keetaid-based/deletechoicegroups","metadata":{"seo":{"title":"Delete ChoiceGroups(in batch)","description":"Batch delete ChoiceGroups and related ChoiceGroupSkus."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteChoiceGroups","name":"Delete ChoiceGroups(in batch)","isWebhook":false,"pointer":"/paths/~1product~1choicegroup~1batchdel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete ChoiceGroups(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch delete ChoiceGroups and related ChoiceGroupSkus."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_206"}},"schemaId":"schema_206","pointer":"/paths/~1product~1choicegroup~1batchdel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/choicegroup/batchdel","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_206"}},"responseCodes":["200"],"pointer":"/product/choicegroup/batchdel","href":"keetaid-based/deletechoicegroups","openApiOperationId":"deleteChoiceGroups","summary":"Delete ChoiceGroups(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_206","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_206"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch deletion result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208"}},"schemaId":"schema_208"}],"pointer":"/paths/~1product~1choicegroup~1batchdel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_208","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_208"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/deletechoicegroups"}],"panels":[]}]},"httpPath":"/product/choicegroup/batchdel"},{"label":"Modify ChoiceGroupSkus available/unavailable status(in batch)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/keetaid-based/updatechoicegroupskustatus","routeSlug":"/apis/standard/menu/keetaid-based/updatechoicegroupskustatus","metadata":{"seo":{"title":"Modify ChoiceGroupSkus available/unavailable status(in batch)","description":"Notice that the available ChoiceGroupSkus should greater than or equals to minNumber."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChoiceGroupSkuStatus","name":"Modify ChoiceGroupSkus available/unavailable status(in batch)","isWebhook":false,"pointer":"/paths/~1product~1choicegroupskustatus~1batchupdate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify ChoiceGroupSkus available/unavailable status(in batch)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notice that the available ChoiceGroupSkus should greater than or equals to minNumber."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limit:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 10 QPS by appId dimension."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_209"}},"schemaId":"schema_209","pointer":"/paths/~1product~1choicegroupskustatus~1batchupdate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/product/choicegroupskustatus/batchupdate","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_209"}},"responseCodes":["200"],"pointer":"/product/choicegroupskustatus/batchupdate","href":"keetaid-based/updatechoicegroupskustatus","openApiOperationId":"updateChoiceGroupSkuStatus","summary":"Modify ChoiceGroupSkus available/unavailable status(in batch)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_209","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_209"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Batch status update result.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210"}},"schemaId":"schema_210"}],"pointer":"/paths/~1product~1choicegroupskustatus~1batchupdate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_210","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/keetaid-based/updatechoicegroupskustatus"}],"panels":[]}]},"httpPath":"/product/choicegroupskustatus/batchupdate"}],"content":{"contentType":"group","meta":{"name":"KeetaID-Based"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"KeetaID-Based","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/product/shopcategory/list","summary":"Query ShopCategory list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/queryshopcategorylist","deprecated":false},{"title":"/product/shopcategory/create","summary":"Create a ShopCategory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/createshopcategory","deprecated":false},{"title":"/product/shopcategory/update","summary":"Modify a ShopCategory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/updateshopcategory","deprecated":false},{"title":"/product/shopcategory/batchdel","summary":"Delete ShopCategories(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/deleteshopcategories","deprecated":false},{"title":"/product/shopcategory/updatesequence","summary":"Adjust order of a ShopCategory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/updateshopcategorysequence","deprecated":false},{"title":"/product/shopcategory/batchupdatesequence","summary":"Adjust order of ShopCategories(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/batchupdateshopcategorysequence","deprecated":false},{"title":"/product/categoryproperty/list","summary":"Query category attribute list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/querycategorypropertylist","deprecated":false},{"title":"/product/spu/list","summary":"Query products list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/queryproductslist","deprecated":false},{"title":"/product/spu/detail","summary":"Query a specific product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/queryproductdetail","deprecated":false},{"title":"/product/spu/batchcreate","summary":"Create products(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/createproducts","deprecated":false},{"title":"/product/spu/batchupdate","summary":"Modify products(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/updateproducts","deprecated":false},{"title":"/product/spustatus/batchupdate","summary":"Modify the available and unavailable status(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/updateproductsstatus","deprecated":false},{"title":"/product/spu/batchcheck","summary":"Query conflict ChoiceGroup before unavailable (in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/checkproductsconflict","deprecated":false},{"title":"/product/spu/batchdel","summary":"Delete products(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/deleteproducts","deprecated":false},{"title":"/product/spu/updatesequence","summary":"Adjust order of a product(in a specific ShopCategory)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/updateproductsequence","deprecated":false},{"title":"/product/spu/batchupdatesequence","summary":"Adjust products order in a ShopCategory(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/batchupdateproductsequence","deprecated":false},{"title":"/product/spu/batchupdateallsequence","summary":"Adjust products order in a Shop(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/batchupdateallproductsequence","deprecated":false},{"title":"/product/spupicture/batchbind","summary":"Batch bind Spus picture(support other image urls)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/batchbindproductpictures","deprecated":false},{"title":"/product/choicegroup/list","summary":"Query ChoiceGroup list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/querychoicegrouplist","deprecated":false},{"title":"/product/choicegroup/batchcreate","summary":"Create ChoiceGroups(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/createchoicegroups","deprecated":false},{"title":"/product/choicegroup/batchupdate","summary":"Modify ChoiceGroups(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/updatechoicegroups","deprecated":false},{"title":"/product/choicegroup/listappliedspu","summary":"Batch query which products are using these ChoiceGroups","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/querychoicegroupappliedspu","deprecated":false},{"title":"/product/choicegroup/batchdel","summary":"Delete ChoiceGroups(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/deletechoicegroups","deprecated":false},{"title":"/product/choicegroupskustatus/batchupdate","summary":"Modify ChoiceGroupSkus available/unavailable status(in batch)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/keetaid-based/updatechoicegroupskustatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Picture","link":"/apis/standard/menu/product-picture","routeSlug":"/apis/standard/menu/product-picture","items":[{"label":"Image Upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/menu/product-picture/uploadimage","routeSlug":"/apis/standard/menu/product-picture/uploadimage","metadata":{"seo":{"title":"Image Upload","description":"This endpoint allows merchants to upload images to the Keeta platform. The returned image URL can be used during menu synchronization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadImage","name":"Image Upload","isWebhook":false,"pointer":"/paths/~1base~1image~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Image Upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows merchants to upload images to the Keeta platform. The returned image URL can be used during menu synchronization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" App-level throttling: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QPS ≤ 50"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implementation Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Different store locations may safely reuse the same image URL, and developers should avoid redundant uploads of identical images to prevent triggering rate limits."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keeta exclusively accepts JPEG, JPG, PNG and WebP file formats for image submissions. Please also ensure the image URL's content-type is one of the following: image/jpeg, image/jpg, image/png, image/webp."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants should maintain consistent image dimensions across their catalog since significant variations in picture sizes may degrade display quality in consumer-facing applications, potentially hindering customers' ability to examine product details visually."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While the system enforces a hard "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"maximum file size limit of 5MB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", we strongly recommend keeping individual images "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"under 2MB"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure optimal performance; uploads exceeding 5MB will automatically fail."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Although a 4:3 aspect ratio is recommended for ideal rendering, non-compliant images will be automatically cropped by the system, which may result in unintended scaling or distortion."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum dimension requirements mandate images be at least "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"600 pixels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wide and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"450 pixels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tall to maintain baseline quality standards."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calls must utilize the multipart/form-data content type for parameter transmission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developers must exclude the imgData field from any signature calculation processes during authentication."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_211"}},"schemaId":"schema_211","pointer":"/paths/~1base~1image~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/base/image/upload","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_211"}},"responseCodes":["200"],"pointer":"/base/image/upload","href":"product-picture/uploadimage","openApiOperationId":"uploadImage","summary":"Image Upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_211","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_211"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful image upload.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_212"}},"schemaId":"schema_212"}],"pointer":"/paths/~1base~1image~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_212","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_212"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-picture/uploadimage"}],"panels":[]}]},"httpPath":"/base/image/upload"}],"content":{"contentType":"group","meta":{"name":"Product Picture"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Picture","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/base/image/upload","summary":"Image Upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-picture/uploadimage","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CommonResponse":{"id":"components/schemas/CommonResponse","kind":"json-schema","title":"CommonResponse","data":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","description":"A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully. \n","x-enumDescriptions":{"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},"message":{"type":"string","description":"Text description corresponding to the status code, explaining the operation result or error cause to users.","example":"Success"}}}},"components/schemas/ShopCategory":{"id":"components/schemas/ShopCategory","kind":"json-schema","title":"ShopCategory","data":{"type":"object","required":["name","sourceLanguageType","type","openItemCode"],"properties":{"id":{"type":"integer","format":"int64","example":12345,"description":"Keeta's menu category ID. Not required for OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs."},"name":{"type":"string","example":"Happy Meal","description":"Name of the category in a menu"},"sourceLanguageType":{"type":"string","example":"en","description":"Language type of the name field. Supported language enums can be found in Menu Integration Guide"},"nameTranslation":{"type":"string","example":"開心樂園餐","description":"Translated text for the name field"},"targetLanguageType":{"type":"string","example":"zh-HK","description":"Language type of nameTranslation. Required when nameTranslation is provided."},"nameTranslateType":{"type":"integer","example":1,"description":"Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant."},"type":{"type":"integer","example":0,"description":"Indicates the menu category type: \n","x-enumDescriptions":{"0":"indicates a regular optional category (customers may skip)","1":"indicates a required category (customers must select at least one item)"}},"description":{"type":"string","example":"Happy Meal description","description":"Brief description of the category in a menu"},"descSourceLanguageType":{"type":"string","example":"en","description":"Language type of description. Required if description exists."},"descriptionTranslation":{"type":"string","example":"開心樂園餐描述","description":"Translated text for description"},"descTargetLanguageType":{"type":"string","example":"zh-HK","description":"Language type of descriptionTranslation. Required when descriptionTranslation exists."},"descriptionTranslateType":{"type":"integer","example":1,"description":"Source of description translation. When the value equals 1, it indicates that the description translation was provided by the merchant."},"openItemCode":{"type":"string","example":"SHOP_CATEGORY#10001","description":"Third-party category ID. Mandatory and must be unique in OpenItemCode-based APIs. Optional in Keeta ID-based APIs."},"availableTime":{"allOf":[{"description":"Selling time slots for this category. Categories are unavailable outside these times."},{"$ref":"#/components/schemas/AvailableTime"}]}}}},"components/schemas/SPU":{"id":"components/schemas/SPU","kind":"json-schema","title":"SPU","data":{"type":"object","required":["name","sourceLanguageType","status","skuList","availableTime","isSpecialty","openItemCode","shopCategoryOpenItemCodeList","userGetModeList"],"properties":{"id":{"type":"integer","format":"int64","example":12345,"description":"Unique SPU ID generated by Keeta. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs. See \"Menu Development Guide\" for details."},"name":{"type":"string","example":"Spicy Chicken Burger","description":"Product name"},"sourceLanguageType":{"type":"string","example":"en","description":"Language code for name field (refer to Menu Integration Guide)"},"nameTranslation":{"type":"string","example":"辣雞腿漢堡","description":"Localized name translation"},"targetLanguageType":{"type":"string","example":"zh-HK","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code for nameTranslation (required if translation exists), please refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/standard/docs/menuintegrationguide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu API Integration Guide"},"children":[]}]}]}]}]},"nameTranslateType":{"type":"integer","example":1,"description":"Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant."},"status":{"type":"integer","example":1,"description":"Product availability status: \n","x-enumDescriptions":{"0":"indicates the SPU is unavailable","1":"indicates the SPU is available"}},"description":{"type":"string","example":"Spicy Chicken Burger description","description":"Product description"},"descSourceLanguageType":{"type":"string","example":"en","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code for description (required if description exists), please refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/standard/docs/menuintegrationguide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu API Integration Guide"},"children":[]}]}]}]}]},"descriptionTranslation":{"type":"string","example":"辣雞腿漢堡描述","description":"Localized description translation"},"descTargetLanguageType":{"type":"string","example":"zh-HK","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code for descriptionTranslation (required if translation exists), please refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/standard/docs/menuintegrationguide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu API Integration Guide"},"children":[]}]}]}]}]},"descriptionTranslateType":{"type":"integer","example":1,"description":"Source of description translation. When the value equals 1, it indicates that the description translation was provided by the merchant."},"shopCategoryList":{"type":"array","description":"Menu categories this SPU belongs to. The 'id' field is required when not using menuSync API. For all interfaces using this struct except menuSync, the id field in ShopCategory struct is required to associate SPUs with category.","items":{"$ref":"#/components/schemas/ShopCategory"}},"pictureList":{"type":"array","description":"Product image URLs","items":{"$ref":"#/components/schemas/Picture"}},"propertyList":{"type":"array","description":"SPU properties (Currently the only SPU property available is \"alcoholic\")","example":[{"propertyId":9999,"propertyType":1,"customizable":0,"propertyValueList":[{"valueId":9999}]}],"items":{"$ref":"#/components/schemas/CategoryProperty"}},"skuList":{"type":"array","description":"A list includes all SKUs under this SPU","items":{"$ref":"#/components/schemas/SKU"}},"availableTime":{"allOf":[{"description":"Selling time slots for this product"},{"$ref":"#/components/schemas/AvailableTime"}]},"isSpecialty":{"type":"integer","example":0,"description":"Signature dish indicator: \n","x-enumDescriptions":{"0":"indicates a regular item","1":"indicates a signature dish"}},"openItemCode":{"type":"string","example":"SPU#10001","description":"Developer-provided SPU identifier. Mandatory and unique in OpenItemCode-based APIs."},"shopCategoryOpenItemCodeList":{"type":"array","description":"This field contains the OpenItemCodes that correspond to menu categories in Keeta's system. When calling the menu synchronization (menuSync) API, this field becomes mandatory. The OpenItemCodes are provided by developers and maintain a one-to-one relationship with Keeta's internal menu category IDs. The Keeta platform will verify whether these OpenItemCodes actually exist in the merchant's store.","items":{"type":"string"},"example":["2$33419","3$34747"]},"userGetModeList":{"type":"array","description":"This field specifies the supported order fulfillment modes, with case-sensitive values. By default, all products support \"delivery\" mode. To enable \"pickup\" mode, the following conditions must be satisfied: First, every SKU in the skuList must have a valid pickPrice value specified. Second, all options within every choice group associated with these SKUs must also have pickPrice values defined. The system recognizes two mode values: \"delivery\" for standard food delivery services \"pickup\" for customer self-collection scenarios","items":{"type":"string"},"example":["delivery","pickup"]}}}},"components/schemas/SKU":{"id":"components/schemas/SKU","kind":"json-schema","title":"SKU","data":{"type":"object","required":["openItemCode"],"properties":{"id":{"type":"integer","format":"int64","example":12345,"description":"Unique SKU ID generated by Keeta system. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs. For details, see \"Menu Development Guide\" for details."},"spec":{"type":"string","example":"Large","description":"Specification name (optional for single-spec products)"},"sourceLanguageType":{"type":"string","example":"en","description":"Language code for name field (refer to Menu Integration Guide)"},"specTranslation":{"type":"string","example":"大份","description":"Localized specification translation"},"targetLanguageType":{"type":"string","example":"zh-HK","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code for specTranslation (required if translation exists), please refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/standard/docs/menuintegrationguide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu API Integration Guide"},"children":[]}]}]}]}]},"specTranslateType":{"type":"string","example":"1","description":"Source of spec translation. When the value equals 1, it indicates that the spec translation was provided by the merchant."},"price":{"type":"string","example":"28.0","description":"Delivery price (supports 3 decimal places, e.g. \"12.33\")"},"pickPrice":{"type":"string","example":"28.0","description":"Pickup price (supports 3 decimal places)"},"canteenPrice":{"type":"string","example":"28.0","description":"Dine-in price (supports 3 decimal places)"},"currency":{"type":"string","example":"HKD","description":"Currency code (refer to \"Currency Symbols\" enum). Defaults to merchant's currency if empty."},"choiceGroupList":{"type":"array","description":"List of ChoiceGroups associated with this SKU. Not used for menuSync API.","items":{"$ref":"#/components/schemas/ChoiceGroup"}},"openItemCode":{"type":"string","example":"SKU#10001","description":"Developer-provided SKU identifier. Mandatory and unique in OpenItemCode-based APIs. Optional for Keeta-based ID APIs."},"choiceGroupOpenItemCodeList":{"type":"array","description":"OpenItemCodes of associated ChoiceGroups. Required for menuSync API.","items":{"type":"string"}},"nutritionalInfo":{"type":"object","description":"Nutritional components (refer to Menu API Integration Guide - 4.3 Nutritional Information)","additionalProperties":{"type":"integer"}},"allergens":{"type":"array","description":"Allergen information (refer to Menu API Integration Guide - 4.4 Allergen Information Specification)","items":{"type":"string"}},"servingSize":{"type":"integer","example":4,"description":"The number of people the portion serves. (From 1 to 9)"},"caffeine":{"type":"number","example":0.39,"description":"The amount of caffeine contained in the item. (Must be a non-negative number, up to 2 decimal places)"}}}},"components/schemas/ChoiceGroup":{"id":"components/schemas/ChoiceGroup","kind":"json-schema","title":"ChoiceGroup","data":{"type":"object","required":["name","sourceLanguageType","minNumber","maxNumber","choiceGroupSkuList","openItemCode"],"properties":{"id":{"type":"integer","format":"int64","example":0,"description":"Unique ChoiceGroup ID generated by Keeta system. Not required in OpenItemCode-based APIs. Required for updates in Keeta ID-based APIs."},"name":{"type":"string","example":"Sauces","description":"Display name of the ChoiceGroup"},"sourceLanguageType":{"type":"string","example":"en","description":"Language code for name field (refer to Menu Integration Guide)"},"nameTranslation":{"type":"string","example":"選擇醬料","description":"Localized name translation"},"targetLanguageType":{"type":"string","example":"zh-HK","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code for nameTranslation (required if translation exists), please refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/standard/docs/menuintegrationguide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu API Integration Guide"},"children":[]}]}]}]}]},"nameTranslateType":{"type":"integer","example":1,"description":"Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant."},"minNumber":{"type":"integer","example":0,"description":"Minimum number of ChoiceGroupSkus that must be selected"},"maxNumber":{"type":"integer","example":3,"description":"Maximum number of ChoiceGroupSkus that can be selected"},"choiceGroupSkuList":{"type":"array","description":"List of available ChoiceGroupSkus in this ChoiceGroup","items":{"$ref":"#/components/schemas/ChoiceGroupSku"}},"openItemCode":{"type":"string","example":"GROUP#10001","description":"Developer-provided ChoiceGroup identifier. Mandatory and unique in OpenItemCode-based APIs."},"repeatable":{"type":"integer","example":0,"description":"Multiple selection flag: \n","x-enumDescriptions":{"0":"indicates single selection only","1":"allows multiple selections of the same ChoiceGroupSku"}}}}},"components/schemas/ChoiceGroupSku":{"id":"components/schemas/ChoiceGroupSku","kind":"json-schema","title":"ChoiceGroupSku","data":{"type":"object","required":["name","sourceLanguageType","status","openItemCode"],"properties":{"id":{"type":"integer","format":"int64","example":0,"description":"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."},"name":{"type":"string","example":"Ketchup","description":"Display name of the ChoiceGroupSku. Should match SPU name when representing the same product for internal correlation."},"sourceLanguageType":{"type":"string","example":"en","description":"Language code for name field (refer to Menu Integration Guide)"},"nameTranslation":{"type":"string","example":"番茄醬","description":"Localized name translation"},"targetLanguageType":{"type":"string","example":"zh-HK","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language code for nameTranslation (required if translation exists), please refer to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/standard/docs/menuintegrationguide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu API Integration Guide"},"children":[]}]}]}]}]},"nameTranslateType":{"type":"integer","example":1,"description":"Source of name translation. When the value equals 1, it indicates that the name translation was provided by the merchant."},"price":{"type":"string","example":"12.33","description":"Delivery price (supports 2 decimal places)"},"pickPrice":{"type":"string","example":"12.33","description":"Pickup price (supports 2 decimal places)"},"canteenPrice":{"type":"string","example":"12.33","description":"Dine-in price (supports 2 decimal places)"},"currency":{"type":"string","example":"HKD","description":"Currency code (refer to \"Currency Symbols\" enum). Defaults to merchant's currency."},"status":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability status:"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0:  indicates the ChoiceGroupSku is unavailable /"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1:  indicates ChoiceGroupSku is available"},"children":[]}]}]}]}]},"openItemCode":{"type":"string","example":"CHOICE#10001","description":"Third-party ChoiceGroupSku identifier. Mandatory and unique in OpenItemCode-based APIs."},"nutritionalInfo":{"type":"object","description":"Nutritional components (refer to Menu API Integration Guide - 4.3 Nutritional Information)","additionalProperties":{"type":"integer"}},"allergens":{"type":"array","description":"Allergen information (refer to Menu API Integration Guide - 4.4 Allergen Information Specification)","items":{"type":"string"}},"choiceGroupOpenItemCodeList":{"type":"array","description":"OpenItemCodes of associated nested ChoiceGroups. Using this field for addons (items not sold separately on the menu, and cannot share the same name as any other SPU on the menu) with nested selection needs.","items":{"type":"string"}},"pictureList":{"type":"array","description":"ChoiceGroupSku image URLs","items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","example":"https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b09999.jpg","description":"ChoiceGroupSku image URLs"}}}},"relatedSpuOpenItemCode":{"type":"string","description":"Third-party SPU identifier this ChoiceGroupSku should bind to. Using this to explicitly bind the ChoiceGroupSku to the given SPU."},"relatedSkuOpenItemCode":{"type":"string","description":"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."}}}},"components/schemas/CategoryProperty":{"id":"components/schemas/CategoryProperty","kind":"json-schema","title":"CategoryProperty","data":{"type":"object","required":["propertyId","propertyValueList"],"properties":{"propertyId":{"type":"integer","format":"int64","example":9999,"description":"Unique identifier for the property"},"propertyName":{"type":"string","example":"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name of the property (This field will not be used when propertyType = 1)"},"children":[]}]}]}]},"propertyType":{"type":"integer","example":1,"description":"Property classification: \n","x-enumDescriptions":{"1":"indicates a standard property","2":"indicates a sales property (currently unused)'"}},"minValueNumber":{"type":"integer","description":"Minimum number of values that must be selected"},"maxValueNumber":{"type":"integer","description":"Maximum number of values that can be selected"},"customizable":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom value allowance: 0: customizable = 0 prohibits custom values 1: customizable = 1 allows custom text input"},"children":[]}]}]}]},"propertyValueList":{"type":"array","description":"List of predefined property values","items":{"$ref":"#/components/schemas/CategoryPropertyValue"}}}}},"components/schemas/CategoryPropertyValue":{"id":"components/schemas/CategoryPropertyValue","kind":"json-schema","title":"CategoryPropertyValue","data":{"type":"object","required":["valueId"],"properties":{"valueId":{"type":"integer","format":"int64","example":9999,"description":"Unique identifier for the property value"},"valueName":{"type":"string","example":"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name of the property value (This field will not be used when customizable = 0)"},"children":[]}]}]}]}}}},"components/schemas/AvailableTime":{"id":"components/schemas/AvailableTime","kind":"json-schema","title":"AvailableTime","data":{"type":"object","required":["code"],"properties":{"code":{"type":"integer","example":0,"description":"Selling time type indicator: \n","x-enumDescriptions":{"0":"indicates all-day availability","1":"indicates weekly schedule","2":"indicates specific date ranges"}},"values":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when code=1. Contains 7 strings representing daily time slots (from Monday to Sunday). To represent multiple time slots within a day, use comma to separate between each time slots. Empty string means unavailable."},"children":[]}]}]}],"items":{"type":"string"}},"available":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines specific date ranges and time windows. Required when code=2."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Availability"}}}}},"components/schemas/Availability":{"id":"components/schemas/Availability","kind":"json-schema","title":"Availability","data":{"type":"object","properties":{"startTimestamp":{"type":"integer","format":"int64","example":1735660800000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beginning timestamp (milliseconds). Required when using absolute date ranges. If set without endTimestamp, indicates perpetual availability after start date. Required when AvailableTime.code = 2"},"children":[]}]}]}]},"endTimestamp":{"type":"integer","format":"int64","example":1736956799000,"description":"Ending timestamp (milliseconds). When omitted with startTimestamp, creates open-ended availability."}}}},"components/schemas/DaysOfWeek":{"id":"components/schemas/DaysOfWeek","kind":"json-schema","title":"DaysOfWeek","data":{"type":"object","properties":{"inWeek":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days of week when product is available (1=Monday through 7=Sunday). Required when using weekly availability mode."},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2,3,4,5,6,7]},"hoursOfDay":{"type":"array","description":"This field contains the time slots during which a product is available for sale on a given day. Time slots must not overlap with each other. The system will reject the request if any overlapping periods are detected.","items":{"$ref":"#/components/schemas/HoursOfDay"}}}}},"components/schemas/HoursOfDay":{"id":"components/schemas/HoursOfDay","kind":"json-schema","title":"HoursOfDay","data":{"type":"object","properties":{"start":{"type":"string","example":"00:00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates the beginning time when a product becomes available for sale during a day. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"HH:mm\" (24-hour format with leading zero)"},"children":[]}]}]}]},"end":{"type":"string","example":"23:59","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field indicates the ending time when a product stops being available during a day. When left empty, the system "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"HH:mm\" (24-hour format with leading zero)"},"children":[]}]}]}]}}}},"components/schemas/Picture":{"id":"components/schemas/Picture","kind":"json-schema","title":"Picture","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"Product image URLs"}}}},"components/schemas/choiceGroupSkuPicture":{"id":"components/schemas/choiceGroupSkuPicture","kind":"json-schema","title":"choiceGroupSkuPicture","data":{"type":"object","required":["url"],"properties":{"url":{"type":"string","example":"https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b09999.jpg","description":"ChoiceGroupSku image URLs"}}}},"components/schemas/ErrorSpu":{"id":"components/schemas/ErrorSpu","kind":"json-schema","title":"ErrorSpu","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier for the SPU (Standard Product Unit), generated by Keeta's system"},"name":{"type":"string","description":"Display name of the SPU"},"openItemCode":{"type":"string","example":"VGsku-00035","description":"Developer-provided external identifier that maintains a one-to-one mapping with Keeta's internal SPU ID. Refer to the \"Menu Development Guide\" for implementation details."},"errorPictureList":{"type":"array","description":"Contains information about failed image binding attempts during batch operations, including error details","items":{"$ref":"#/components/schemas/ErrorPicture"}},"code":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code value of 0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request was executed successfully"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any non-zero code value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request execution failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific error details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be viewed in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"message":{"type":"string","example":"","description":"Text description corresponding to the status code, explaining the operation result or error cause to users."}}}},"components/schemas/ErrorChoiceGroup":{"id":"components/schemas/ErrorChoiceGroup","kind":"json-schema","title":"ErrorChoiceGroup","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":45676543,"description":"Unique identifier for the Choicegroup (Standard Product Unit), generated by Keeta's system"},"name":{"type":"string","example":"","description":"Display name of the Choicegroup"},"openItemCode":{"type":"string","example":"SET-11001000005-3","description":"Developer-provided external identifier that maintains a one-to-one mapping with Keeta's internal Choicegroup ID. Refer to the \"Menu Development Guide\" for implementation details."},"code":{"type":"integer","example":107000104,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code value of 0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request was executed successfully"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any non-zero code value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request execution failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific error details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be viewed in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"message":{"type":"string","example":"Data does not exist","description":"Text description corresponding to the status code, explaining the operation result or error cause to users."}}}},"components/schemas/ErrorPicture":{"id":"components/schemas/ErrorPicture","kind":"json-schema","title":"ErrorPicture","data":{"type":"object","properties":{"url":{"type":"string","example":"https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b09999.jpg","description":"Product image URLs"},"code":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code value of 0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request was executed successfully"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any non-zero code value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request execution failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific error details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be viewed in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"message":{"type":"string","example":"","description":"Text description corresponding to the status code, explaining the operation result or error cause to users."}}}},"components/schemas/ChoiceGroupSkuCodePack":{"id":"components/schemas/ChoiceGroupSkuCodePack","kind":"json-schema","title":"ChoiceGroupSkuCodePack","data":{"type":"object","required":["choiceGroupCode","choiceGroupSkuCodes"],"properties":{"choiceGroupCode":{"type":"string","example":"SET-77017010009-3","description":"The OpenItemCode identifier for the ChoiceGroup, provided by the developer."},"choiceGroupSkuCodes":{"type":"array","description":"List of valid option OpenItemCodes that belong to the specified ChoiceGroup. All codes must exist within the given choiceGroupCode's option set.","items":{"type":"string","example":"54ee29c7271d4ce18c5f8c63811e7ab1#77017010009#3#66026020003"}}}}},"components/schemas/SpuMapping":{"id":"components/schemas/SpuMapping","kind":"json-schema","title":"SpuMapping","data":{"type":"object","required":["name","openItemCode","skuList","languageType"],"properties":{"name":{"type":"string","example":"Spicy Beef Noodles","description":"Display name of the SPU"},"openItemCode":{"type":"string","example":"SPU#10001","description":"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"},"skuList":{"type":"array","description":"List of SKUs associated with this SPU using OpenItemCode references For details, see Menu Integration Guide","items":{"$ref":"#/components/schemas/SkuMapping"}},"languageType":{"type":"string","example":"en","description":"Language code for the name field"}}}},"components/schemas/SkuMapping":{"id":"components/schemas/SkuMapping","kind":"json-schema","title":"SkuMapping","data":{"type":"object","required":["openItemCode"],"properties":{"spec":{"type":"string","example":"Big","description":"Display name of the SKU"},"openItemCode":{"type":"string","example":"1582","description":"Developer-provided external identifier that maintains a one-to-one mapping with Keeta's internal skuId. Must be unique across all SKUs. For details, see Menu Integration Guide"}}}},"components/schemas/ErrorShopCategory":{"id":"components/schemas/ErrorShopCategory","kind":"json-schema","title":"ErrorShopCategory","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique Category ID generated by Keeta."},"code":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A numeric status identifier indicating the result of the interface call, used to determine whether the operation executed successfully. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code value of 0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request was executed successfully"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any non-zero code value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request execution failed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific error details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be viewed in the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"message"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"message":{"type":"string","example":"","description":"Text description corresponding to the status code, explaining the operation result or error cause to users."}}}},"components/schemas/ConflictGroup":{"id":"components/schemas/ConflictGroup","kind":"json-schema","title":"ConflictGroup","data":{"type":"object","properties":{"spuId":{"type":"integer","format":"int64","description":"Unique SPU ID generated by Keeta."},"choiceGroupIdList":{"type":"array","description":"Contains the IDs of choice groups that have rule conflicts with this SPU.","items":{"type":"integer","format":"int64"}}}}},"components/schemas/SimpleSpu":{"id":"components/schemas/SimpleSpu","kind":"json-schema","title":"SimpleSpu","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier for the SPU, generated by Keeta system."},"name":{"type":"string","description":"Display name of the SPU."},"status":{"type":"integer","description":"Sales availability status of the SPU:\n","x-enumDescriptions":{"0":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicates the SPU is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not available"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for sale"},"children":[]}]}]}],"1":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"indicates the SPU is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for sale"},"children":[]}]}]}]}}}}},"components/schemas/OpenShopCategorySequenceDTO":{"id":"components/schemas/OpenShopCategorySequenceDTO","kind":"json-schema","title":"OpenShopCategorySequenceDTO","data":{"type":"object","properties":{"shopCategoryId":{"type":"integer","format":"int64","example":5675,"description":"Unique Category ID generated by Keeta system."},"sequence":{"type":"integer","example":345454657,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the sorting position of the category in menu displays. Uses 1-based indexing (1 = first position)."},"children":[]}]}]}]}}}},"components/schemas/OpenSpuSequenceDTO":{"id":"components/schemas/OpenSpuSequenceDTO","kind":"json-schema","title":"OpenSpuSequenceDTO","data":{"type":"object","properties":{"spuId":{"type":"integer","format":"int64","description":"Unique identifier for the SPU, generated by Keeta system."},"sequence":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines the sorting position of the SPU in menu displays. Uses 1-based indexing (1 = first position). Lower numbers appear before higher numbers."},"children":[]}]}]}]}}}},"components/schemas/ChoiceGroupAppliedSpu":{"id":"components/schemas/ChoiceGroupAppliedSpu","kind":"json-schema","title":"ChoiceGroupAppliedSpu","data":{"type":"object","properties":{"choiceGroupId":{"type":"integer","format":"int64","description":"Unique Choicegroup ID generated by Keeta."},"list":{"type":"array","description":"A list of SPUs (Standard Product Units) that currently utilize this choice group in their configurations.","items":{"$ref":"#/components/schemas/SimpleSpu"}}}}},"components/schemas/ChoiceGroupSkuIdPack":{"id":"components/schemas/ChoiceGroupSkuIdPack","kind":"json-schema","title":"ChoiceGroupSkuIdPack","data":{"type":"object","properties":{"choiceGroupId":{"type":"integer","format":"int64","description":"Unique identifier for the choice group, generated by Keeta system"},"choiceGroupSkuIds":{"type":"array","description":"List of ChoiceGroupSku IDs that belong to the specified choice group","items":{"type":"integer","format":"int64"}}}}},"components/schemas/SpuPicture":{"id":"components/schemas/SpuPicture","kind":"json-schema","title":"SpuPicture","data":{"type":"object","properties":{"spuId":{"type":"integer","format":"int64","description":"Unique identifier for the SPU, generated by Keeta system."},"urlList":{"type":"array","description":"List of external image URLs associated with the product.","items":{"type":"string"}}}}},"schema_165":{"kind":"json-schema","data":{"type":"object","required":["shopId","shopCategoryList","choiceGroupList","spuList"],"example":"{\"shopCategoryList\":[{\"nameTranslation\":\"開心樂園餐\",\"descriptionTranslation\":\"開心樂園餐描述\",\"description\":\"Happy Meal description\",\"type\":0,\"descSourceLanguageType\":\"en\",\"sourceLanguageType\":\"en\",\"descriptionTranslateType\":1,\"openItemCode\":\"SHOP_CATEGORY#10001\",\"availableTime\":{\"code\": 0, \"values\": [ \"00:00-05:59, 11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\" ],\"available\":[{\"endTimestamp\":1736956799000,\"startTimestamp\":1735660800000}]},\"targetLanguageType\":\"zh-HK\",\"descTargetLanguageType\":\"zh-HK\",\"name\":\"Happy Meal\",\"id\":12345,\"nameTranslateType\":1}],\"spuList\":[{\"nameTranslation\":\"辣雞腿漢堡\",\"skuList\":[{\"pickPrice\":\"28.0\",\"nutritionalInfo\":{\"property2\":0,\"property1\":0},\"specTranslateType\":\"1\",\"specTranslation\":\"大份\",\"choiceGroupList\":[],\"spec\":\"Large\",\"sourceLanguageType\":\"en\",\"allergens\":[\"string\"],\"openItemCode\":\"SKU#10001\",\"choiceGroupOpenItemCodeList\":[\"GROUP#10001\"],\"targetLanguageType\":\"zh-HK\",\"price\":\"28.0\",\"canteenPrice\":\"28.0\",\"currency\":\"HKD\",\"id\":12345}],\"shopCategoryList\":[],\"propertyList\":[{\"propertyName\":\"\",\"propertyType\":1,\"customizable\":0,\"propertyValueList\":[{\"valueId\":9999,\"valueName\":\"\"}],\"maxValueNumber\":0,\"minValueNumber\":0,\"propertyId\":9999}],\"descriptionTranslation\":\"辣雞腿漢堡描述\",\"description\":\"Spicy Chicken Burger description\",\"userGetModeList\":[\"delivery\",\"pickup\"],\"descSourceLanguageType\":\"en\",\"isSpecialty\":0,\"sourceLanguageType\":\"en\",\"descriptionTranslateType\":1,\"availableTime\":{\"code\": 0, \"values\": [ \"00:00-05:59, 11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\" ],\"available\":[{\"endTimestamp\":1736956799000,\"startTimestamp\":1735660800000}]},\"openItemCode\":\"SPU#10001\",\"targetLanguageType\":\"zh-HK\",\"descTargetLanguageType\":\"zh-HK\",\"name\":\"Spicy Chicken Burger\",\"shopCategoryOpenItemCodeList\":[\"SHOP_CATEGORY#10001\"],\"id\":12345,\"pictureList\":[{\"url\":\"string\"}],\"nameTranslateType\":1,\"status\":1},{\"nameTranslation\":\"漢堡套餐\",\"skuList\":[{\"pickPrice\":\"15.0\",\"nutritionalInfo\":{\"property2\":0,\"property1\":0},\"specTranslateType\":\"1\",\"specTranslation\":\"中份\",\"choiceGroupList\":[],\"spec\":\"Regular\",\"sourceLanguageType\":\"en\",\"allergens\":[\"string\"],\"openItemCode\":\"SKU#10002\",\"choiceGroupOpenItemCodeList\":[\"GROUP#10002\"],\"targetLanguageType\":\"zh-HK\",\"price\":\"15.0\",\"canteenPrice\":\"15.0\",\"currency\":\"HKD\",\"id\":12345}],\"shopCategoryList\":[],\"propertyList\":[{\"propertyName\":\"\",\"propertyType\":1,\"customizable\":0,\"propertyValueList\":[{\"valueId\":9999,\"valueName\":\"\"}],\"maxValueNumber\":0,\"minValueNumber\":0,\"propertyId\":9999}],\"descriptionTranslation\":\"漢堡套餐\",\"description\":\"Burger Meal description\",\"userGetModeList\":[\"delivery\",\"pickup\"],\"descSourceLanguageType\":\"en\",\"isSpecialty\":0,\"sourceLanguageType\":\"en\",\"descriptionTranslateType\":1,\"availableTime\":{\"code\": 0, \"values\": [ \"00:00-05:59, 11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\", \"11:00-23:45\" ],\"available\":[{\"endTimestamp\":1736956799000,\"startTimestamp\":1735660800000}]},\"openItemCode\":\"SPU#10002\",\"targetLanguageType\":\"zh-HK\",\"descTargetLanguageType\":\"zh-HK\",\"name\":\"Burger Meal\",\"shopCategoryOpenItemCodeList\":[\"SHOP_CATEGORY#10001\"],\"id\":12345,\"pictureList\":[{\"url\":\"string\"}],\"nameTranslateType\":1,\"status\":1}],\"spuSequenceCodeMap\":{\"shopCategoryOpenItemCode2\":[\"spuOpenItemCode1\",\"spuOpenItemCode3\"],\"shopCategoryOpenItemCode1\":[\"spuOpenItemCode1\",\"spuOpenItemCode2\"]},\"choiceGroupList\":[{\"nameTranslation\":\"選擇醬料\",\"minNumber\":0,\"openItemCode\":\"GROUP#10001\",\"targetLanguageType\":\"zh-HK\",\"maxNumber\":3,\"repeatable\":0,\"name\":\"Sauces\",\"id\":0,\"choiceGroupSkuList\":[{\"pickPrice\":\"12.33\",\"nutritionalInfo\":{\"property2\":0,\"property1\":0},\"nameTranslation\":\"番茄醬\",\"sourceLanguageType\":\"en\",\"allergens\":[\"string\"],\"openItemCode\":\"CHOICE#10001\",\"targetLanguageType\":\"zh-HK\",\"price\":\"12.33\",\"canteenPrice\":\"12.33\",\"name\":\"Ketchup\",\"currency\":\"HKD\",\"id\":0,\"nameTranslateType\":1,\"status\":1}],\"sourceLanguageType\":\"en\",\"nameTranslateType\":1},{\"nameTranslation\":\"選擇漢堡\",\"minNumber\":1,\"openItemCode\":\"GROUP#10002\",\"targetLanguageType\":\"zh-HK\",\"maxNumber\":1,\"repeatable\":0,\"name\":\"Choose a Burger\",\"id\":0,\"choiceGroupSkuList\":[{\"pickPrice\":\"10.00\",\"nutritionalInfo\":{\"property2\":0,\"property1\":0},\"nameTranslation\":\"辣雞腿漢堡\",\"relatedSkuOpenItemCode\":\"SKU#10001\",\"sourceLanguageType\":\"en\",\"allergens\":[\"string\"],\"openItemCode\":\"CHOICE#10002\",\"targetLanguageType\":\"zh-HK\",\"price\":\"10.00\",\"canteenPrice\":\"10.00\",\"name\":\"Spicy Chicken Burger\",\"currency\":\"HKD\",\"id\":0,\"nameTranslateType\":1,\"status\":1}],\"sourceLanguageType\":\"en\",\"nameTranslateType\":1}],\"shopId\":12345}","properties":{"shopId":{"type":"integer","format":"int64","description":"Unique identifier of the Keeta store.","example":12345},"shopCategoryList":{"type":"array","description":"Please send all the menu category info of the specific store to this field.","items":{"$ref":"#/components/schemas/ShopCategory"}},"choiceGroupList":{"type":"array","description":"Please send all the choicegroup info of the specific store to this field.","items":{"$ref":"#/components/schemas/ChoiceGroup"}},"spuList":{"type":"array","description":"Please send all the SPU info of the specific store to this field.","items":{"$ref":"#/components/schemas/SPU"}},"spuSequenceCodeMap":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field allows developers to set product sorting within menu categories. When the value equals null, product sorting follows Keeta's default sorting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data Structure"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Menu category's OpenItemCode"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Array of SPU OpenItemCodes in desired display order"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants can specify exact product order by listing SPU OpenItemCodes in the desired sequence for each category. The specified order updates the in-app display, showcasing products in the defined arrangement."},"children":[]}]}]}],"additionalProperties":{"type":"array","description":"Ordered list of SPU OpenItemCodes for this category","items":{"type":"string","description":"SPU OpenItemCode"}},"example":{"shopCategoryOpenItemCode1":["spuOpenItemCode1","spuOpenItemCode2"],"shopCategoryOpenItemCode2":["spuOpenItemCode1","spuOpenItemCode3"]}}}},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"integer","format":"int64","description":"When interacting with Keeta's platform for actions that require asynchronous processing, such as complex data operations or system integrations, the platform will initiate a task that may not complete immediately upon request submission. Instead of providing immediate completion confirmation, Keeta's system generates a taskId, which serves as a unique identifier for that specific task in the internal execution system.\n"}}}]},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuOpenItemCodeList","status"],"properties":{"shopId":{"type":"integer","format":"int64","description":"Unique identifier of the Keeta store.","example":12345},"spuOpenItemCodeList":{"type":"array","description":"A list of SPU OpenItemCode","items":{"type":"string"},"example":["aCV","2code"]},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}],"example":1},"needLinkage":{"type":"integer","description":"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}}},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Contains a list of OpenItemCodes for all SPUs whose statuses were successfully changed.","items":{"type":"string"}},"errorList":{"type":"array","description":"Failed SPUs list includes OpenItemCode and Error Message.","items":{"$ref":"#/components/schemas/ErrorSpu"}}}}]},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","required":["shopId","choiceGroupSkuCodePackList","status"],"properties":{"shopId":{"type":"integer","format":"int64","description":"Unique identifier of the Keeta store.","example":12345},"choiceGroupSkuCodePackList":{"type":"array","description":"This field includes ChoicegroupSkus that required status updates.","items":{"$ref":"#/components/schemas/ChoiceGroupSkuCodePack"}},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field controls the visibility and availability of a ChoiceGroupSku in the merchant storefront."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status = 0, this setting will immediately deactivate the specified ChoiceGroupSku."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status = 1, this setting activates the ChoiceGroupSku for public visibility and ordering."},"children":[]}]}]}],"example":1}}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"integer","format":"int64","example":239,"description":"The quality of OpenItemCodes of choicegroupsku whose statuses were successfully changed."},"errorList":{"type":"array","description":"A list contains the OpenItemCode for each option whose status update failed.","items":{"$ref":"#/components/schemas/ErrorChoiceGroup"}}}}]},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuMappingList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"Unique identifier of the Keeta store","example":12345},"spuMappingList":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please specify the mapping relationship between SPU names and their corresponding openItemCodes in this field. For detailed definitions of openItemCode, please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Menu Development Guide documentation."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SpuMapping"}}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Returns a list of OpenItemCode values for all SPUs that were successfully bound during this API request.","items":{"type":"string"}},"errorList":{"type":"array","description":"Returns detailed information about SPUs that failed to bind, including SPU OpenItemCode and error message.","items":{"$ref":"#/components/schemas/ErrorSpu"}}}}]},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"object","required":["shopId","taskId"],"properties":{"shopId":{"type":"integer","format":"int64","example":25381,"description":"Unique identifier of the Keeta store.Identifies the store to which the current operation belongs"},"taskId":{"type":"integer","format":"int64","example":939569332,"description":"Task ID, the unique identifier for the current image binding task"},"mainTaskId":{"type":"integer","format":"int64","example":41666617,"description":"The task ID of the menu sync task associated with the current menu image sync task."},"errorList":{"type":"array","description":"Error list, contains a list of failed item processing information","items":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","example":92462142,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item SPU_ID, the unique identifier for the item"},"children":[]}]}]}]},"name":{"type":"string","example":"Kyrushu Pork Soup Vegetable Stew","description":"Item name"},"openItemCode":{"type":"string","description":"Third-party SPU ID"},"errorPictureList":{"type":"array","description":"List of erroneous image details","items":{"type":"object","required":["url","code","message"],"properties":{"url":{"type":"string","example":"https://oms.seito.com.hk/ftp-tsuiwah/C93024/00000001/007013_6d86e8f94xxxxxxx6f95734.png","description":"Image URL, the address of the erroneous image"},"code":{"type":"integer","example":107000711,"description":"Error Code, the specific error type of image processing"},"message":{"type":"string","example":"The image's width should be greater than 600px and height should be greater than 450px","description":"Error Details, the detailed description of the image processing error"}}}}}}}}},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"object","required":["shopId","taskId"],"properties":{"shopId":{"type":"integer","format":"int64","example":25381,"description":"Unique identifier of the Keeta store."},"taskId":{"type":"integer","format":"int64","example":897354,"description":"Due to this being an asynchronous task, when Keeta platform receives the request, it cannot complete the task immediately. Keeta platform will submit a task to run in the internal system, and this field represents the unique ID of that task."},"pictureTaskId":{"type":"integer","format":"int64","example":266675845,"description":"The task ID of the image sync task within the current menu sync task. This field is null when there is no image sync task."},"errorSpuDTOList":{"type":"array","description":"This field represents detailed information about the product list that failed menu synchronization.","items":{"type":"object","properties":{"id":{"type":"integer","example":123},"name":{"type":"string","example":"banana tea"},"code":{"type":"integer","example":199999},"message":{"type":"string","example":"error message info"},"openItemCode":{"type":"string","example":"y123456"}}}}}},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"object","required":["shopId"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381}}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"In-store ShopCategory list","items":{"$ref":"#/components/schemas/ShopCategory"}}}}]},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"object","required":["shopId","shopCategory"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"shopCategory":{"$ref":"#/components/schemas/ShopCategory"}}},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ShopCategory"}}}]},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"object","required":["shopId","shopCategoryIdList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"shopCategoryIdList":{"type":"array","description":"ShopCategory id list to be deleted","items":{"type":"integer","format":"int64"},"example":[2313,4342]}}},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"successful ShopCategory id list","items":{"type":"integer","format":"int64"}},"errorList":{"type":"array","description":"failed ShopCategory data","items":{"$ref":"#/components/schemas/ErrorShopCategory"}}}}]},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"object","required":["id","shopId","sequence"],"properties":{"id":{"type":"integer","format":"int64","description":"ShopCategory id"},"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"sequence":{"type":"integer","example":2455425486,"description":"target sequence"}}},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"object","required":["shopId","openShopCategorySequenceDTOList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"openShopCategorySequenceDTOList":{"type":"array","description":"ShopCategory target sequence data model","items":{"$ref":"#/components/schemas/OpenShopCategorySequenceDTO"}}}},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"object","required":["shopId"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"categoryId":{"type":"integer","format":"int64","description":"KeeTa platform categoryId","example":-1}}},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"attributes related to the category","items":{"$ref":"#/components/schemas/CategoryProperty"}}}}]},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Spu data model","items":{"$ref":"#/components/schemas/SPU"}}}}]},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuId"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"spuId":{"type":"integer","format":"int64","description":"spuId in KeeTa","example":2}}},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SPU"}}}]},"id":"schema_187"},"schema_188":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"spuList":{"type":"array","description":"Spu data model","items":{"$ref":"#/components/schemas/SPU"}}}},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"successful Spu data model","items":{"$ref":"#/components/schemas/SPU"}},"errorList":{"type":"array","description":"failed Spu informations","items":{"$ref":"#/components/schemas/ErrorSpu"}}}}]},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Successful Spu data model","items":{"$ref":"#/components/schemas/SPU"}},"errorList":{"type":"array","description":"failed Spu informations","items":{"$ref":"#/components/schemas/ErrorSpu"}}}}]},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuIdList","status"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"spuIdList":{"type":"array","description":"Spu id list","items":{"type":"integer","format":"int64"},"example":[1,2,3]},"status":{"type":"integer","description":"1 - available 0 - unavailable","example":1},"needLinkage":{"type":"integer","description":"1 - need linkage modification else - no need","example":1,"default":0}}},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Successful Spu data model","items":{"$ref":"#/components/schemas/SPU"}},"errorList":{"type":"array","description":"Failed Spu informations","items":{"$ref":"#/components/schemas/ErrorSpu"}}}}]},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuIdList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"spuIdList":{"type":"array","description":"spuId list","items":{"type":"integer","format":"int64"},"example":[1,2,3]}}},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"conflict group data model","items":{"$ref":"#/components/schemas/ConflictGroup"}},"errorList":{"type":"array","description":"failed Spu information","items":{"$ref":"#/components/schemas/ErrorSpu"}}}}]},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuIdList","linkedDel"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"spuIdList":{"type":"array","description":"spuId list","items":{"type":"integer","format":"int64"},"example":[1,2,3]},"linkedDel":{"type":"boolean","description":"true: need linkage deletion false:no need","example":true}}},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"successful spuId list","items":{"type":"integer","format":"int64"}},"errorList":{"type":"array","description":"failed Spu informations","items":{"$ref":"#/components/schemas/ErrorSpu"}}}}]},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"type":"object","required":["shopId","shopCategoryId","spuId","sequence"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":1},"shopCategoryId":{"type":"integer","format":"int64","description":"ShopCategory.id","example":22},"spuId":{"type":"integer","format":"int64","description":"spuId","example":333},"sequence":{"type":"integer","description":"target sequence","example":2}}},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"type":"object","required":["shopId","shopCategoryId","spuSequenceDTOList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa"},"shopCategoryId":{"type":"integer","format":"int64","description":"ShopCategory id"},"spuSequenceDTOList":{"type":"array","description":"Spu sequence data model","items":{"$ref":"#/components/schemas/OpenSpuSequenceDTO"}}}},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"type":"object","required":["shopId","shopCategoryId2SpuSeqMap"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa"},"shopCategoryId2SpuSeqMap":{"type":"object","description":"key: ShopCategory.id value: Spu sequence data model","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/OpenSpuSequenceDTO"}}}}},"id":"schema_199"},"schema_200":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Successful ShopCategory id","items":{"type":"integer","format":"int64"}},"errorList":{"type":"array","description":"failed ShopCategory informations","items":{"$ref":"#/components/schemas/ErrorShopCategory"}}}}]},"id":"schema_200"},"schema_201":{"kind":"json-schema","data":{"type":"object","required":["shopId","spuPictureList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":123},"spuPictureList":{"type":"array","items":{"$ref":"#/components/schemas/SpuPicture"}}}},"id":"schema_201"},"schema_202":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"integer","format":"int64","description":"taskId of this invocation"}}}]},"id":"schema_202"},"schema_203":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"ChoiceGroup data model","items":{"$ref":"#/components/schemas/ChoiceGroup"}}}}]},"id":"schema_203"},"schema_204":{"kind":"json-schema","data":{"type":"object","required":["shopId","choiceGroupList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"choiceGroupList":{"type":"array","description":"ChoiceGroup data model","items":{"$ref":"#/components/schemas/ChoiceGroup"}}}},"id":"schema_204"},"schema_205":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Successful ChoiceGroup data model","items":{"$ref":"#/components/schemas/ChoiceGroup"}},"errorList":{"type":"array","description":"Failed ChoiceGroup informations","items":{"$ref":"#/components/schemas/ErrorChoiceGroup"}}}}]},"id":"schema_205"},"schema_206":{"kind":"json-schema","data":{"type":"object","required":["shopId","choiceGroupIdList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa","example":25381},"choiceGroupIdList":{"type":"array","description":"ChoiceGroup id list","items":{"type":"integer","format":"int64"},"example":[3123,4343]}}},"id":"schema_206"},"schema_207":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Successful ChoiceGroupAppliedSpu data model","items":{"$ref":"#/components/schemas/ChoiceGroupAppliedSpu"}},"errorList":{"type":"array","description":"Failed choiceGroup informations, mostly the wrong ChoiceGroup.id","items":{"$ref":"#/components/schemas/ErrorChoiceGroup"}}}}]},"id":"schema_207"},"schema_208":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"array","description":"Successful ChoiceGroup id list","items":{"type":"integer","format":"int64"}},"errorList":{"type":"array","description":"Failed ChoiceGroup informations","items":{"$ref":"#/components/schemas/ErrorChoiceGroup"}}}}]},"id":"schema_208"},"schema_209":{"kind":"json-schema","data":{"type":"object","required":["shopId","status","choiceGroupSkuIdPackList"],"properties":{"shopId":{"type":"integer","format":"int64","description":"store id in KeeTa"},"status":{"type":"integer","description":"0 - unavailable 1 - available"},"choiceGroupSkuIdPackList":{"type":"array","description":"Please make sure choiceGroupSkuIds are all belongs to choiceGroupId","items":{"$ref":"#/components/schemas/ChoiceGroupSkuIdPack"}}}},"id":"schema_209"},"schema_210":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"integer","format":"int64","description":"Successful count"}}}]},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"type":"object","required":["shopId","imageName","imageData"],"properties":{"shopId":{"type":"integer","format":"int64","description":"Unique identifier of the Keeta store.","example":12345},"imageName":{"type":"string","description":"The name of the image.","example":"imageName"},"imageData":{"type":"string","format":"binary","description":"The byte array of the image."}}},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"type":"string","description":"Photo's URL","example":"https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b09999.jpg"}}}]},"id":"schema_212"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://open.mykeeta.com/api/open"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/@standard/menu.json?download"},{"url":"/_bundle/apis/@standard/menu.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Keeta Menu Management API","description":"This API provides comprehensive menu management capabilities for Keeta platform integration, including menu synchronization, product status management, and real-time notifications.\n"}},"baseSlug":"/apis/standard/menu","routesMapping":{}}