{"items":[{"type":"separator","version":"standard","versionFolderId":"58c9a61d","label":"Overview"},{"type":"link","fsPath":"apis/@standard/docs/intro.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/apis/standard/docs/intro","routeSlug":"/apis/standard/docs/intro","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/developResource.md","metadata":{"type":"markdown"},"label":"Development Resources","link":"/apis/standard/docs/developresource","routeSlug":"/apis/standard/docs/developresource","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/apiRequest.md","metadata":{"type":"markdown"},"label":"API Request Protocol","link":"/apis/standard/docs/apirequest","routeSlug":"/apis/standard/docs/apirequest","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/webhook.md","metadata":{"type":"markdown"},"label":"Webhook","link":"/apis/standard/docs/webhook","routeSlug":"/apis/standard/docs/webhook","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/selfAuthor.md","metadata":{"type":"markdown"},"label":"Merchant Self-Authorization Integration Guide","link":"/apis/standard/docs/selfauthor","routeSlug":"/apis/standard/docs/selfauthor","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/author.md","metadata":{"type":"markdown"},"label":"Authorization Guide","link":"/apis/standard/docs/author","routeSlug":"/apis/standard/docs/author","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","version":"standard","versionFolderId":"58c9a61d","label":"Development Guides","items":[{"type":"link","fsPath":"apis/@standard/docs/basicIntegrationGuide.md","metadata":{"type":"markdown"},"label":"Basic API Integration Guide","link":"/apis/standard/docs/basicintegrationguide","routeSlug":"/apis/standard/docs/basicintegrationguide","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/orderIntegrationGuide.md","metadata":{"type":"markdown"},"label":"Order API Integration Guide","link":"/apis/standard/docs/orderintegrationguide","routeSlug":"/apis/standard/docs/orderintegrationguide","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/storeIntegrationGuide.md","metadata":{"type":"markdown"},"label":"Store API Integration Guide","link":"/apis/standard/docs/storeintegrationguide","routeSlug":"/apis/standard/docs/storeintegrationguide","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@standard/docs/menuIntegrationGuide.md","metadata":{"type":"markdown"},"label":"Menu API Integration Guide","link":"/apis/standard/docs/menuintegrationguide","routeSlug":"/apis/standard/docs/menuintegrationguide","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}]},{"type":"link","fsPath":"apis/@standard/docs/changelog.md","metadata":{"type":"markdown"},"label":"Release Notes","link":"/apis/standard/docs/changelog","routeSlug":"/apis/standard/docs/changelog","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"separator","version":"standard","versionFolderId":"58c9a61d","label":"API Reference"},{"type":"group","fsPath":"apis/@standard/basic.yaml","link":"/apis/standard/basic","routeSlug":"/apis/standard/basic","label":"Basic","items":[{"type":"group","label":"Endpoints","link":"/apis/standard/basic/endpoints","routeSlug":"/apis/standard/basic/endpoints","items":[{"label":"Webhook URL Configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/basic/endpoints/configurewebhookurl","routeSlug":"/apis/standard/basic/endpoints/configurewebhookurl","metadata":{"seo":{"title":"Webhook URL Configuration","description":"This API enables developers to configure webhook URLs for receiving real-time notifications from the Keeta platform regarding orders, stores, menus, and other relevant business events."}},"httpPath":"/base/callback/url/set","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Get Merchant Authorization Information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/basic/endpoints/getauthorizedresources","routeSlug":"/apis/standard/basic/endpoints/getauthorizedresources","metadata":{"seo":{"title":"Get Merchant Authorization Information","description":"This API retrieves merchant information and authorized store lists based on the authentication token provided in the request, enabling developers to validate access permissions and obtain essential business context."}},"httpPath":"/base/authorized/resource/get","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"OAuth Token Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/basic/endpoints/oauthtoken","routeSlug":"/apis/standard/basic/endpoints/oauthtoken","metadata":{"seo":{"title":"OAuth Token Operations","description":"This endpoint handles both access token acquisition and token refresh operations based on the grantType parameter."}},"httpPath":"/base/oauth/token","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Batch Decrypt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/basic/endpoints/batchdecrypt","routeSlug":"/apis/standard/basic/endpoints/batchdecrypt","metadata":{"seo":{"title":"Batch Decrypt","description":"For merchant self-delivery or third-party logistics (3PL) orders, this endpoint can be called to decrypt the user's phone number and address.A maximum of 50 data items can be decrypted at once.The encrypted data generally uses ENC_ as a prefix."}},"httpPath":"/base/batchDecrypt","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","label":"Webhooks","link":"/apis/standard/basic/webhooks","routeSlug":"/apis/standard/basic/webhooks","items":[{"label":"OAuth2 Authorization Code Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/basic/webhooks/oauth2authorizationcodenotification","routeSlug":"/apis/standard/basic/webhooks/oauth2authorizationcodenotification","metadata":{"seo":{"title":"OAuth2 Authorization Code Notification","description":"This webhook is sent by Keeta to notify the vendor's system when a merchant completes the merchant self-authorization process. Upon receiving this notification, the developer should use the provided authorization code to obtain an access token."}},"httpPath":"oauth2AuthorizationCodeNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Store Authorization Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/basic/webhooks/storeauthorizationnotification","routeSlug":"/apis/standard/basic/webhooks/storeauthorizationnotification","metadata":{"seo":{"title":"Store Authorization Notification","description":"This webhook is sent by Keeta to notify the vendor's system when a merchant grants authorization for a store. This event is triggered when a new store is added to the merchant's authorized store list. This event is triggered when a merchant adds one or more stores to an existing brand authorization. For example, when stores were not fully included during the initial authorization and are subsequently added."}},"httpPath":"storeAuthorizationNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Store Authorization Removal Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/basic/webhooks/storeauthorizationremovalnotification","routeSlug":"/apis/standard/basic/webhooks/storeauthorizationremovalnotification","metadata":{"seo":{"title":"Store Authorization Removal Notification","description":"This webhook is sent by Keeta to notify the vendor's system when a merchant reduces the authorized store scope for a brand. This event is triggered when one or more stores are removed from an existing brand authorization."}},"httpPath":"storeAuthorizationRemovalNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Brand Authorization Removal Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/basic/webhooks/brandauthorizationremovalnotification","routeSlug":"/apis/standard/basic/webhooks/brandauthorizationremovalnotification","metadata":{"seo":{"title":"Brand Authorization Removal Notification","description":"This webhook is sent by Keeta to notify the vendor's system when a merchant fully revokes authorization for a brand. This event is triggered only when the entire brand authorization is removed, meaning all stores under the brand are deauthorized simultaneously. Upon receiving this notification, the developer's system should treat the associated access token as invalid."}},"httpPath":"brandAuthorizationRemovalNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Basic API Reference","version":"v.1.0.0","description":"This API provides basic functionality for Keeta platform integration, including webhook configuration, authorization management, and OAuth token operations.\n"},"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","fsPath":"apis/@standard/order.yaml","link":"/apis/standard/order","routeSlug":"/apis/standard/order","label":"Order","items":[{"type":"group","label":"Endpoints","link":"/apis/standard/order/endpoints","routeSlug":"/apis/standard/order/endpoints","items":[{"label":"Query on Order Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/getorderdetails","routeSlug":"/apis/standard/order/endpoints/getorderdetails","metadata":{"seo":{"title":"Query on Order Details","description":"This endpoint allows the third party system to retrieve comprehensive details about a specific order from Keeta platform."}},"httpPath":"/order/get","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/confirmorder","routeSlug":"/apis/standard/order/endpoints/confirmorder","metadata":{"seo":{"title":"Order Confirmation","description":"This endpoint allows the third party to inform the Keeta ordering application that an order has been accepted and food preparation will begin shortly."}},"httpPath":"/order/confirm","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/cancelorder","routeSlug":"/apis/standard/order/endpoints/cancelorder","metadata":{"seo":{"title":"Order Cancellation","description":"This endpoint allows merchants to request order cancellation through the Keeta platform when they are unable to fulfill a customer's order."}},"httpPath":"/order/cancel","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Refund Confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/agreerefund","routeSlug":"/apis/standard/order/endpoints/agreerefund","metadata":{"seo":{"title":"Refund Confirmation","description":"This endpoint allows merchants to programmatically approve customer refund requests that were initiated through the Keeta platform."}},"httpPath":"/order/agree","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Refund Rejection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/rejectrefund","routeSlug":"/apis/standard/order/endpoints/rejectrefund","metadata":{"seo":{"title":"Refund Rejection","description":"This endpoint enables merchant to formally reject customer refund requests initiated through the Keeta platform."}},"httpPath":"/order/reject","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Ready","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/orderready","routeSlug":"/apis/standard/order/endpoints/orderready","metadata":{"seo":{"title":"Order Ready","description":"This endpoint allows merchant to notify the Keeta platform that an order has been fully prepared and is ready for rider pickup."}},"httpPath":"/order/prepare","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Partial Refundable Item Query","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/querypartialrefundableitems","routeSlug":"/apis/standard/order/endpoints/querypartialrefundableitems","metadata":{"seo":{"title":"Partial Refundable Item Query","description":"This API is designed to retrieve detailed information about items that are eligible for partial refunds. It allows developers to access and display specific product details related to refund eligibility."}},"httpPath":"/order/refund/part/products/preview","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Initiate a Partial Refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/initiatepartialrefund","routeSlug":"/apis/standard/order/endpoints/initiatepartialrefund","metadata":{"seo":{"title":"Initiate a Partial Refund","description":"This API allows merchants to submit requests for partial refunds on specific products within an order. It is designed to adjust billing and chargeback processes when certain items in an order will not incur costs due to various reasons, such as promotions, errors, or customer satisfaction measures."}},"httpPath":"/order/refund/part/apply","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Picked-up Confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/endpoints/confirmorderpickup","routeSlug":"/apis/standard/order/endpoints/confirmorderpickup","metadata":{"seo":{"title":"Order Picked-up Confirmation","description":"This API is designed to notify the Keeta platform that a customer has personally collected their order. It ensures that the system accurately reflects the order's completion through customer self-pickup."}},"httpPath":"/order/collect","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","label":"Webhooks","link":"/apis/standard/order/webhooks","routeSlug":"/apis/standard/order/webhooks","items":[{"label":"Order Placed Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/order/webhooks/orderplacednotification","routeSlug":"/apis/standard/order/webhooks/orderplacednotification","metadata":{"seo":{"title":"Order Placed Notification","description":"This webhook is sent by Keeta to notify the developer's system that a new order has been placed."}},"httpPath":"orderPlacedNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Acceptance Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/order/webhooks/orderacceptancenotification","routeSlug":"/apis/standard/order/webhooks/orderacceptancenotification","metadata":{"seo":{"title":"Order Acceptance Notification","description":"This webhook serves to notify the developer's system when an order's status changes to 'Order Confirmed' on the Keeta platform."}},"httpPath":"orderAcceptanceNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Completion Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/order/webhooks/ordercompletionnotification","routeSlug":"/apis/standard/order/webhooks/ordercompletionnotification","metadata":{"seo":{"title":"Order Completion Notification","description":"This webhook serves to notify the developer's system when an order's status changes to 'Delivered' on the Keeta platform."}},"httpPath":"orderCompletionNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Cancellation Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/order/webhooks/ordercancellationnotification","routeSlug":"/apis/standard/order/webhooks/ordercancellationnotification","metadata":{"seo":{"title":"Order Cancellation Notification","description":"This webhook serves to notify the developer's system when an order's status changes to 'Cancelled' on the Keeta platform."}},"httpPath":"orderCancellationNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Refund Status Change Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/order/webhooks/orderrefundstatuschangenotification","routeSlug":"/apis/standard/order/webhooks/orderrefundstatuschangenotification","metadata":{"seo":{"title":"Order Refund Status Change Notification","description":"This webhook is designed to inform the developer's system whenever there is a change in the status of an order's refund application on the Keeta platform."}},"httpPath":"orderRefundStatusChangeNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Delivery Status Change Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/order/webhooks/deliverystatuschangenotification","routeSlug":"/apis/standard/order/webhooks/deliverystatuschangenotification","metadata":{"seo":{"title":"Delivery Status Change Notification","description":"This webhook is designed to inform the developer's system whenever there is a change in the status of Keeta Couriers."}},"httpPath":"deliveryStatusChangeNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Partial Product Refund Request Status Change Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/order/webhooks/partialproductrefundstatuschangenotification","routeSlug":"/apis/standard/order/webhooks/partialproductrefundstatuschangenotification","metadata":{"seo":{"title":"Partial Product Refund Request Status Change Notification","description":"This webhook is designed to notify your system when the status of a partial product refund request within an order changes on the Keeta platform."}},"httpPath":"partialProductRefundStatusChangeNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","label":"MerchanSelfDelivery","link":"/apis/standard/order/merchanselfdelivery","routeSlug":"/apis/standard/order/merchanselfdelivery","items":[{"label":"Order Dispatched","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/merchanselfdelivery/orderdispatched","routeSlug":"/apis/standard/order/merchanselfdelivery/orderdispatched","metadata":{"seo":{"title":"Order Dispatched","description":"This endpoint allows merchants to notify the Keeta platform that a courier has picked up the order and the delivery is in progress for merchant self-delivery orders."}},"httpPath":"/order/dispatched","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Delivered","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/merchanselfdelivery/orderdelivered","routeSlug":"/apis/standard/order/merchanselfdelivery/orderdelivered","metadata":{"seo":{"title":"Order Delivered","description":"This endpoint allows merchants to notify the Keeta platform that an order has been successfully delivered to the customer for merchant self-delivery orders."}},"httpPath":"/order/delivered","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Update Courier Information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/merchanselfdelivery/updatecourierinfo","routeSlug":"/apis/standard/order/merchanselfdelivery/updatecourierinfo","metadata":{"seo":{"title":"Update Courier Information","description":"This endpoint allows merchants to update courier information for merchant self-delivery orders, including courier name, phone number, vehicle information, and other delivery-related details."}},"httpPath":"/order/updateCourierInfo","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Update Delivery Tracking Information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/order/merchanselfdelivery/updatedeliverytracking","routeSlug":"/apis/standard/order/merchanselfdelivery/updatedeliverytracking","metadata":{"seo":{"title":"Update Delivery Tracking Information","description":"This endpoint allows merchants to provide real-time delivery tracking updates for merchant self-delivery orders, including ETA(estimated time of arrival) and courier location coordinates."}},"httpPath":"/delivery/merchant/self/delivery/callback","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Order Management API","version":"v.1.0.0","description":"This API provides comprehensive order management capabilities for Keeta platform integration, including order operations, refund management, and real-time notifications.\n"},"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","fsPath":"apis/@standard/shop.yaml","link":"/apis/standard/shop","routeSlug":"/apis/standard/shop","label":"Store","items":[{"type":"group","label":"Endpoints","link":"/apis/standard/shop/endpoints","routeSlug":"/apis/standard/shop/endpoints","items":[{"label":"Get Store Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/getstoredetails","routeSlug":"/apis/standard/shop/endpoints/getstoredetails","metadata":{"seo":{"title":"Get Store Details","description":"This endpoint allows developer to request comprehensive store details, including:"}},"httpPath":"/scm/shop/base/get","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Update Store Profile Image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/updatestoreprofileimage","routeSlug":"/apis/standard/shop/endpoints/updatestoreprofileimage","metadata":{"seo":{"title":"Update Store Profile Image","description":"Update Store Profile Image"}},"httpPath":"/scm/shop/picture/main/update","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Update Store Contact Phone Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/updatestorecontactphone","routeSlug":"/apis/standard/shop/endpoints/updatestorecontactphone","metadata":{"seo":{"title":"Update Store Contact Phone Number","description":"This endpoint allows updating a store's contact phone numbers."}},"httpPath":"/scm/shop/contact/update","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Query Store Business Hours","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/querystorebusinesshours","routeSlug":"/apis/standard/shop/endpoints/querystorebusinesshours","metadata":{"seo":{"title":"Query Store Business Hours","description":"This endpoint allows querying a store business hours."}},"httpPath":"/scm/shop/business/hour/effective/get","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Update Store Business Hours","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/updatestorebusinesshours","routeSlug":"/apis/standard/shop/endpoints/updatestorebusinesshours","metadata":{"seo":{"title":"Update Store Business Hours","description":"This endpoint allows updating a store's business hours."}},"httpPath":"/scm/shop/business/hour/effective/update","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Suspend Store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/suspendstore","routeSlug":"/apis/standard/shop/endpoints/suspendstore","metadata":{"seo":{"title":"Suspend Store","description":"Use this endpoint to suspend store operations. Suspended stores remain hidden from customers until manually reactivated. This endpoint will suspend both delivery and pickup at the same time."}},"httpPath":"/scm/shop/status/rest","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Store Reactivation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/reactivatestore","routeSlug":"/apis/standard/shop/endpoints/reactivatestore","metadata":{"seo":{"title":"Store Reactivation","description":"Use this endpoint to reactivate suspended stores, transitioning them from a non-operational state back to operational status for order acceptance and customer visibility. This endpoint will reactivate both delivery and pickup at the same time."}},"httpPath":"/scm/shop/status/open","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Query Special Business Hours","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/queryspecialbusinesshours","routeSlug":"/apis/standard/shop/endpoints/queryspecialbusinesshours","metadata":{"seo":{"title":"Query Special Business Hours","description":"This endpoint retrieves a store's currently active special business hours, which temporarily override regular operating hours for specific dates (e.g., holidays, events)."}},"httpPath":"/scm/shop/special/business/hour/effective/get","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Update Special Business Hours","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/standard/shop/endpoints/updatespecialbusinesshours","routeSlug":"/apis/standard/shop/endpoints/updatespecialbusinesshours","metadata":{"seo":{"title":"Update Special Business Hours","description":"This endpoint updates a store's special business hours, enforcing non-overlapping date ranges and supporting full-day closures or complete configuration clearance."}},"httpPath":"/scm/shop/special/business/hour/effective/update","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","label":"Webhooks","link":"/apis/standard/shop/webhooks","routeSlug":"/apis/standard/shop/webhooks","items":[{"label":"Store Business Hour Update Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/shop/webhooks/businesshourupdatenotification","routeSlug":"/apis/standard/shop/webhooks/businesshourupdatenotification","metadata":{"seo":{"title":"Store Business Hour Update Notification","description":"Keeta pushes real-time notifications when either regular business hours or special business hours are modified."}},"httpPath":"businessHourUpdateNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Store Status Update Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/apis/standard/shop/webhooks/storestatusupdatenotification","routeSlug":"/apis/standard/shop/webhooks/storestatusupdatenotification","metadata":{"seo":{"title":"Store Status Update Notification","description":"Keeta pushes real-time notifications when a store's operational status changes, enabling immediate order availability updates based on status codes and business hours."}},"httpPath":"storeStatusUpdateNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Store Management API","version":"v.1.0.0","description":"This API provides comprehensive store management capabilities for Keeta platform integration."},"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","fsPath":"apis/@standard/menu.yaml","link":"/apis/standard/menu","routeSlug":"/apis/standard/menu","label":"Menu","items":[{"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."}},"httpPath":"/product/menu/sync","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spustatus/batchupdatebycode","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/choicegroupskustatus/batchupdatebycode","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/mapping/batchupdatebyname","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"PictureBindTaskCompletionNotification","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"menuSynchronizationTaskCompletionWebhook","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/shopcategory/list","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/shopcategory/create","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/shopcategory/update","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/shopcategory/batchdel","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/shopcategory/updatesequence","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/shopcategory/batchupdatesequence","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/categoryproperty/list","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/list","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/detail","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/batchcreate","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/batchupdate","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spustatus/batchupdate","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/batchcheck","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/batchdel","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/updatesequence","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/batchupdatesequence","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/spu/batchupdateallsequence","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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\";"}},"httpPath":"/product/spupicture/batchbind","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/choicegroup/list","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/choicegroup/batchcreate","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/choicegroup/batchupdate","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/choicegroup/listappliedspu","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/choicegroup/batchdel","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/product/choicegroupskustatus/batchupdate","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"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."}},"httpPath":"/base/image/upload","version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Menu Management API","version":"v.1.0.0","description":"This API provides comprehensive menu management capabilities for Keeta platform integration, including menu synchronization, product status management, and real-time notifications.\n"},"version":"standard","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"separator","version":"yhsu3hu21cH23yabx4xuUuq7","versionFolderId":"58c9a61d","label":"Overview"},{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/intro.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/intro","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/intro","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","version":"yhsu3hu21cH23yabx4xuUuq7","versionFolderId":"58c9a61d","label":"Development Guides","items":[{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/auth.md","metadata":{"type":"markdown"},"label":"Authorization Guide","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/auth","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/auth","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/orderIntegrationGuide.md","metadata":{"type":"markdown"},"label":"Order API Integration Guide","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/orderintegrationguide","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/orderintegrationguide","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/promotionIntegrationGuide.md","metadata":{"type":"markdown"},"label":"Promotion API Integration Guide","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/promotionintegrationguide","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/promotionintegrationguide","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/sftpIntegrationGuide.md","metadata":{"type":"markdown"},"label":"SFTP Integration Guide","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/sftpintegrationguide","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/sftpintegrationguide","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}]},{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/releaseNotes.md","metadata":{"type":"markdown"},"label":"Release Notes","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/releasenotes","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/releasenotes","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"separator","version":"yhsu3hu21cH23yabx4xuUuq7","versionFolderId":"58c9a61d","label":"API Reference"},{"type":"group","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/basic.yaml","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/basic","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/basic","label":"Authentication API","items":[{"label":"Generate Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/basic/other/generateaccesstoken","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/basic/other/generateaccesstoken","metadata":{"seo":{"title":"Generate Access Token","description":"Generate an OAuth 2.0 access token to include in the Authorization header of Partner API requests."}},"httpPath":"/v1/oauth/token","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Basic API Reference","version":"v.1.0.0","description":"This API provides basic functionality for Keeta platform integration, including webhook configuration, authorization management, and OAuth token operations.\n"},"version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/order.yaml","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/order","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/order","label":"Order API","items":[{"label":"Order Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/order/other/getorderwithchain","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/order/other/getorderwithchain","metadata":{"seo":{"title":"Order Details","description":"Retrieve the latest information for a specific order, including its status, customer delivery information, items, payment, cancellation, and delivery type. Use this endpoint to recover the latest state if a webhook notification is missed."}},"httpPath":"/v1/order/query/chains/{chainId}/orders/{orderId}","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Vendor Orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/order/other/getorders","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/order/other/getorders","metadata":{"seo":{"title":"Vendor Orders","description":"Retrieve a paginated order history for a specific vendor. Use this endpoint for reconciliation and analysis. Orders can be queried for up to the most recent 60 days."}},"httpPath":"/v1/order/chains/{chainId}/vendors/{vendorId}/orders","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Grocery Order API","version":"v1.0.0","description":"Streamline your order processing and fulfillment workflows for a seamless\ncustomer experience. This section provides endpoints to access order\ninformation in real-time, ensuring efficient and accurate order fulfillment.\norder fulfillment.\n\n**Key Features:**\n\n- **Real-time Order Updates:** Receive and process order updates as they\n  happen, enabling immediate action and reducing delays.\n- **Order Status Visibility:** Receive order statuses reflecting the progress\n  of each order, keeping customers informed and improving transparency.\n- **Item State Visibility and Cancellation:** View the latest item state\n  through order details and webhooks, and manage order cancellations.\n- **Order History and Reconciliation:** Retrieve detailed order history for\n  reconciliation, analysis, and reporting purposes.\n"},"version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/menu.yaml","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu","label":"Catalog API","items":[{"label":"Update Product","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu/other/updateproduct","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu/other/updateproduct","metadata":{"seo":{"title":"Update Product","description":"Update product information efficiently, whether it's a single item or a whole batch. We'll process your request in the background and provide a 202 Accepted status with a jobId for tracking. Stay updated via webhook notifications."}},"httpPath":"/v1/product/update/chains/{chainId}/vendors/{vendorId}","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Get Categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu/other/getcategories","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu/other/getcategories","metadata":{"seo":{"title":"Get Categories","description":"This API queries platform categories for a specified region and returns only leaf categories."}},"httpPath":"/v1/product/categories","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Get Properties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu/other/getpropertise","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/menu/other/getpropertise","metadata":{"seo":{"title":"Get Properties","description":"This API supports batch querying supported properties under specified platform categories."}},"httpPath":"/v1/product/category/properties","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Catalog Management API","version":"v.1.0.0","description":"This API provides comprehensive catalog management capabilities for Keeta platform integration, including catalog synchronization, product status management, and real-time notifications.\n"},"version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/promotion.yaml","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/promotion","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/promotion","label":"Promotion API","items":[{"label":"Manage Promotion","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/promotion/other/managepromotion","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/promotion/other/managepromotion","metadata":{"seo":{"title":"Manage Promotion","description":"This endpoint allows a third-party system to create, update, or deactivate SKU-level promotions on the Keeta platform."}},"httpPath":"/v1/promotion/chains/{chainId}","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Promotion API Reference","version":"v1.0.0","description":"This API provides comprehensive promotion management capabilities for Keeta platform integration, including promotion management, promotion status query and notification.\n"},"version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"group","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/webhook.yaml","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook","label":"Webhook","items":[{"label":"Merchant Authorization Change Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/receiveauthorizationchangeevent","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/receiveauthorizationchangeevent","metadata":{"seo":{"title":"Merchant Authorization Change Notification","description":"This webhook is sent by Keeta to notify the third-party system when a merchant's authorization changes."}},"httpPath":"/authorization/change/notification","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Order Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/webhookorder","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/webhookorder","metadata":{"seo":{"title":"Order Notification","description":"Keeta sends this webhook when a new order is created or when the orderstatus or final item facts change."}},"httpPath":"/orderNotification","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Promotion Offline Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/receivepromotionofflineevent","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/receivepromotionofflineevent","metadata":{"seo":{"title":"Promotion Offline Notification","description":"This webhook is sent by Keeta to notify the third-party system when an existing promotion is taken offline."}},"httpPath":"/promotion/offline/notification","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"label":"Asynchronization Task Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/asynchronizationtaskwebhook","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/webhook/other/asynchronizationtaskwebhook","metadata":{"seo":{"title":"Asynchronization Task Notification","description":"When Keeta's platform receives an asynchronous request, it creates an internal task for processing. Upon task completion (success or failure), Keeta will notify the vendor via this webhook."}},"httpPath":"/asynchronization/task/notification","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}],"metadata":{"type":"openapi","title":"Keeta Basic API Reference","version":"v.1.0.0","description":"This API provides basic functionality for Keeta platform integration, including webhook configuration, authorization management, and OAuth token operations.\n"},"version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"separator","version":"yhsu3hu21cH23yabx4xuUuq7","versionFolderId":"58c9a61d","label":"SFTP Reference"},{"type":"group","version":"yhsu3hu21cH23yabx4xuUuq7","versionFolderId":"58c9a61d","label":"Catalog","items":[{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/addProductPlatformSftp.md","metadata":{"type":"markdown"},"label":"Add Product SFTP with Keeta's property","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/addproductplatformsftp","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/addproductplatformsftp","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/addProductSelfSftp.md","metadata":{"type":"markdown"},"label":"Add Products SFTP with vendor's property","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/addproductselfsftp","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/addproductselfsftp","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"},{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/updateProductSftp.md","metadata":{"type":"markdown"},"label":"Update Product SFTP","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/updateproductsftp","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/updateproductsftp","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}]},{"type":"group","version":"yhsu3hu21cH23yabx4xuUuq7","versionFolderId":"58c9a61d","label":"Promotion","items":[{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/managePromotionSftp.md","metadata":{"type":"markdown"},"label":"Manage Promotion SFTP","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/managepromotionsftp","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/managepromotionsftp","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}]},{"type":"group","version":"yhsu3hu21cH23yabx4xuUuq7","versionFolderId":"58c9a61d","label":"Catalog and Promotion","items":[{"type":"link","fsPath":"apis/@yhsu3hu21cH23yabx4xuUuq7/docs/updateProductPromotionSftp.md","metadata":{"type":"markdown"},"label":"Update Product and Promotion SFTP","link":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/updateproductpromotionsftp","routeSlug":"/apis/yhsu3hu21ch23yabx4xuuuq7/docs/updateproductpromotionsftp","version":"yhsu3hu21cH23yabx4xuUuq7","isDefault":false,"versionFolderId":"58c9a61d"}]}]}