{"items":[{"type":"link","label":"Keeta Order Management API","link":"/apis/standard/order","routeSlug":"/apis/standard/order","content":{"contentType":"overview","meta":{"name":"Keeta Order Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"order.json","url":"/_bundle/apis/@standard/order.json?download"},{"kind":"download","label":"order.yaml","url":"/_bundle/apis/@standard/order.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 Order Management API (v.1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This API provides comprehensive order management capabilities for Keeta platform integration, including order operations, refund management, and real-time notifications."}],"sectionId":"/apis/standard/order"}],"sectionId":"/apis/standard/order"}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderDetails","name":"Query on Order Details","isWebhook":false,"pointer":"/paths/~1order~1get/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query on Order Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows the third party system to retrieve comprehensive details about a specific order from Keeta platform."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"schemaId":"schema_213","pointer":"/paths/~1order~1get/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/get","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_213"}},"responseCodes":["200"],"pointer":"/order/get","href":"endpoints/getorderdetails","openApiOperationId":"getOrderDetails","summary":"Query on Order Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_213","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"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 order details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214"}},"schemaId":"schema_214"}],"pointer":"/paths/~1order~1get/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_214","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/endpoints/getorderdetails"}],"panels":[]}]},"httpPath":"/order/get"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirmOrder","name":"Order Confirmation","isWebhook":false,"pointer":"/paths/~1order~1confirm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Confirmation","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 third party to inform the Keeta ordering application that an order has been accepted and food preparation will begin shortly."},"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":"Timing Requirements"},"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":"Developers must call this endpoint immediately upon receiving new order notifications from Keeta."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Keeta platform will automatically cancel any order that remains unconfirmed after 5 minutes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"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":"State Management"},"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":"The endpoint rejects requests under these conditions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order was already accepted through a Keeta POS terminal - The order status has already progressed beyond the initial state"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"schemaId":"schema_213","pointer":"/paths/~1order~1confirm/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/confirm","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_213"}},"responseCodes":["200"],"pointer":"/order/confirm","href":"endpoints/confirmorder","openApiOperationId":"confirmOrder","summary":"Order Confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_213","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"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/~1order~1confirm/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":"/endpoints/confirmorder"}],"panels":[]}]},"httpPath":"/order/confirm"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelOrder","name":"Order Cancellation","isWebhook":false,"pointer":"/paths/~1order~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Cancellation","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 request order cancellation through the Keeta platform when they are unable to fulfill a customer's order."},"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":"text","inline":true,"attributes":{"content":"The developers should only invoke this API when the merchant is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unable to fulfill the order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon successful cancellation, the order status will be updated to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"CANCELLED\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Keeta's system and Keeta will "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"automatically initiate a full refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does not support duplicate calls"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the order is already in a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"CANCELLED\""},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, the system will return an error response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants should "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"confirm the necessity of cancellation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before proceeding to avoid unnecessary losses."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_215"}},"schemaId":"schema_215","pointer":"/paths/~1order~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/cancel","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_215"}},"responseCodes":["200"],"pointer":"/order/cancel","href":"endpoints/cancelorder","openApiOperationId":"cancelOrder","summary":"Order Cancellation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_215","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_215"}},"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/~1order~1cancel/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":"/endpoints/cancelorder"}],"panels":[]}]},"httpPath":"/order/cancel"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"agreeRefund","name":"Refund Confirmation","isWebhook":false,"pointer":"/paths/~1order~1agree/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund Confirmation","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 programmatically approve customer refund requests that were initiated through the Keeta platform."},"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":"text","inline":true,"attributes":{"content":"When a customer submits a refund request on the Keeta platform, the system will send a webhook notification to the third-party system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the third-party system supports refund management, merchants can review and approve refund requests directly within their system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once approved, the third-party system "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must call this API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm the refund with Keeta."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does not support duplicate calls"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the refund has already been approved or rejected (e.g., via Keeta POS), subsequent calls will return an error."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"schemaId":"schema_213","pointer":"/paths/~1order~1agree/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/agree","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_213"}},"responseCodes":["200"],"pointer":"/order/agree","href":"endpoints/agreerefund","openApiOperationId":"agreeRefund","summary":"Refund Confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_213","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"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/~1order~1agree/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":"/endpoints/agreerefund"}],"panels":[]}]},"httpPath":"/order/agree"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rejectRefund","name":"Refund Rejection","isWebhook":false,"pointer":"/paths/~1order~1reject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund Rejection","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 merchant to formally reject customer refund requests initiated through the Keeta platform."},"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":"text","inline":true,"attributes":{"content":"When a customer submits a refund request on the Keeta platform, the system will send a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook notification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the third-party system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the third-party system has implemented refund processing capabilities, merchants can review and evaluate customer refund requests directly within their own system endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When merchants decide to reject a refund request after careful consideration, the third-party system must explicitly call this rejection API endpoint to formally communicate the decision to Keeta's platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does not support duplicate calls"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the refund has already been approved or rejected (e.g., via Keeta POS), subsequent calls will return an error."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_216"}},"schemaId":"schema_216","pointer":"/paths/~1order~1reject/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/reject","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_216"}},"responseCodes":["200"],"pointer":"/order/reject","href":"endpoints/rejectrefund","openApiOperationId":"rejectRefund","summary":"Refund Rejection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_216","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_216"}},"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/~1order~1reject/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":"/endpoints/rejectrefund"}],"panels":[]}]},"httpPath":"/order/reject"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderReady","name":"Order Ready","isWebhook":false,"pointer":"/paths/~1order~1prepare/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Ready","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 merchant to notify the Keeta platform that an order has been fully prepared and is ready for rider pickup."},"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":"text","inline":true,"attributes":{"content":"Keeta strongly recommends that developers integrate this API to significantly enhance delivery efficiency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint automatically updates the order status to '"},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Ready"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"' in Keeta's system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does not support duplicate calls"},"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":"It is crucial to call this API only after meal preparation is fully completed to avoid disrupting the delivery workflow. Premature or mistaken invocations could lead to delivery inefficiencies and negatively affect the overall customer experience."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"schemaId":"schema_213","pointer":"/paths/~1order~1prepare/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/prepare","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_213"}},"responseCodes":["200"],"pointer":"/order/prepare","href":"endpoints/orderready","openApiOperationId":"orderReady","summary":"Order Ready"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_213","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"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/~1order~1prepare/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":"/endpoints/orderready"}],"panels":[]}]},"httpPath":"/order/prepare"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPartialRefundableItems","name":"Partial Refundable Item Query","isWebhook":false,"pointer":"/paths/~1order~1refund~1part~1products~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial Refundable Item Query","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_217"}},"schemaId":"schema_217","pointer":"/paths/~1order~1refund~1part~1products~1preview/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/refund/part/products/preview","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_217"}},"responseCodes":["200"],"pointer":"/order/refund/part/products/preview","href":"endpoints/querypartialrefundableitems","openApiOperationId":"queryPartialRefundableItems","summary":"Partial Refundable Item Query"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_217","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_217"}},"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 partial refundable item details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}},"schemaId":"schema_218"}],"pointer":"/paths/~1order~1refund~1part~1products~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_218","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_218"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/endpoints/querypartialrefundableitems"}],"panels":[]}]},"httpPath":"/order/refund/part/products/preview"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiatePartialRefund","name":"Initiate a Partial Refund","isWebhook":false,"pointer":"/paths/~1order~1refund~1part~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiate a Partial Refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_219"}},"schemaId":"schema_219","pointer":"/paths/~1order~1refund~1part~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/refund/part/apply","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_219"}},"responseCodes":["200"],"pointer":"/order/refund/part/apply","href":"endpoints/initiatepartialrefund","openApiOperationId":"initiatePartialRefund","summary":"Initiate a Partial Refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_219","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_219"}},"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/~1order~1refund~1part~1apply/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":"/endpoints/initiatepartialrefund"}],"panels":[]}]},"httpPath":"/order/refund/part/apply"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirmOrderPickup","name":"Order Picked-up Confirmation","isWebhook":false,"pointer":"/paths/~1order~1collect/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Picked-up Confirmation","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 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."},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API should be invoked in situations where the customer opts for self-service pickup, collecting their order directly from the merchant premises. It updates Keeta's system with the order's completed status."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"schemaId":"schema_213","pointer":"/paths/~1order~1collect/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/collect","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_213"}},"responseCodes":["200"],"pointer":"/order/collect","href":"endpoints/confirmorderpickup","openApiOperationId":"confirmOrderPickup","summary":"Order Picked-up Confirmation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_213","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213"}},"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/~1order~1collect/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":"/endpoints/confirmorderpickup"}],"panels":[]}]},"httpPath":"/order/collect"}],"content":{"contentType":"group","meta":{"name":"Endpoints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Endpoints","showPageActions":true},{"nodeType":"markdoc","content":"Request APIs - All endpoints for requesting order information and making updates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/order/get","summary":"Query on Order Details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/getorderdetails","deprecated":false},{"title":"/order/confirm","summary":"Order Confirmation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/confirmorder","deprecated":false},{"title":"/order/cancel","summary":"Order Cancellation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/cancelorder","deprecated":false},{"title":"/order/agree","summary":"Refund Confirmation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/agreerefund","deprecated":false},{"title":"/order/reject","summary":"Refund Rejection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/rejectrefund","deprecated":false},{"title":"/order/prepare","summary":"Order Ready","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/orderready","deprecated":false},{"title":"/order/refund/part/products/preview","summary":"Partial Refundable Item Query","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/querypartialrefundableitems","deprecated":false},{"title":"/order/refund/part/apply","summary":"Initiate a Partial Refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/initiatepartialrefund","deprecated":false},{"title":"/order/collect","summary":"Order Picked-up Confirmation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/endpoints/confirmorderpickup","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderPlacedNotification","name":"Order Placed Notification","isWebhook":true,"pointer":"/paths/orderPlacedNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Placed 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":"This webhook is sent by Keeta to notify the developer's system that a new order has been placed."},"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":" 1001"},"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":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the event that Keeta's platform sends a new order notification but does not receive an acknowledgment from the developer's system, Keeta will attempt to resend the notification up to a maximum of three additional times."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ IMPORTANT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Certain merchant settlement amount fields within the order detail query API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and order push notifications may be subject to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculation delays"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeDtl.merchantFee"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which represent various components"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the merchant settlement breakdown, may not be fully computed at the time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the order detail is first returned or the order push notification is received."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In such cases, the affected fields may be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"absent, null, or contain incomplete"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Service providers "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" treat "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"feeDtl.merchantFee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"hard dependencies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their integration logic. If missing or incomplete"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement data is encountered, it is recommended to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"re-query the Order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detail API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after a short delay to retrieve the updated settlement"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information. Downstream business logic such as reconciliation and invoicing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"should be designed to handle the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"temporary unavailability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of these fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gracefully, without blocking or failing the overall order processing flow."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FindMerchantOrderByViewIdResp"}},"schemaId":"components/schemas/FindMerchantOrderByViewIdResp","pointer":"/paths/orderPlacedNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"orderPlacedNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/FindMerchantOrderByViewIdResp"}},"responseCodes":["200"],"pointer":"orderPlacedNotification","href":"webhooks/orderplacednotification","openApiOperationId":"orderPlacedNotification","summary":"Order Placed Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"components/schemas/FindMerchantOrderByViewIdResp","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FindMerchantOrderByViewIdResp"}},"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/orderPlacedNotification/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/orderplacednotification"}],"panels":[]}]},"httpPath":"orderPlacedNotification"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderAcceptanceNotification","name":"Order Acceptance Notification","isWebhook":true,"pointer":"/paths/orderAcceptanceNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Acceptance 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":"This webhook serves to notify the developer's system when an order's status changes to 'Order Confirmed' on the Keeta platform."},"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":" 1002"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_220"}},"schemaId":"schema_220","pointer":"/paths/orderAcceptanceNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"orderAcceptanceNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_220"}},"responseCodes":["200"],"pointer":"orderAcceptanceNotification","href":"webhooks/orderacceptancenotification","openApiOperationId":"orderAcceptanceNotification","summary":"Order Acceptance Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_220","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_220"}},"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/orderAcceptanceNotification/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/orderacceptancenotification"}],"panels":[]}]},"httpPath":"orderAcceptanceNotification"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderCompletionNotification","name":"Order Completion Notification","isWebhook":true,"pointer":"/paths/orderCompletionNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order 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":"This webhook serves to notify the developer's system when an order's status changes to 'Delivered' on the Keeta platform."},"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":" 1003"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_221"}},"schemaId":"schema_221","pointer":"/paths/orderCompletionNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"orderCompletionNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_221"}},"responseCodes":["200"],"pointer":"orderCompletionNotification","href":"webhooks/ordercompletionnotification","openApiOperationId":"orderCompletionNotification","summary":"Order Completion Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_221","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_221"}},"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/orderCompletionNotification/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/ordercompletionnotification"}],"panels":[]}]},"httpPath":"orderCompletionNotification"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderCancellationNotification","name":"Order Cancellation Notification","isWebhook":true,"pointer":"/paths/orderCancellationNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Cancellation 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":"This webhook serves to notify the developer's system when an order's status changes to 'Cancelled' on the Keeta platform."},"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":" 1004"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_222"}},"schemaId":"schema_222","pointer":"/paths/orderCancellationNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"orderCancellationNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_222"}},"responseCodes":["200"],"pointer":"orderCancellationNotification","href":"webhooks/ordercancellationnotification","openApiOperationId":"orderCancellationNotification","summary":"Order Cancellation Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_222","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_222"}},"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/orderCancellationNotification/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/ordercancellationnotification"}],"panels":[]}]},"httpPath":"orderCancellationNotification"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderRefundStatusChangeNotification","name":"Order Refund Status Change Notification","isWebhook":true,"pointer":"/paths/orderRefundStatusChangeNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Refund Status Change 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":"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."},"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":" 1005"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_223"}},"schemaId":"schema_223","pointer":"/paths/orderRefundStatusChangeNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"orderRefundStatusChangeNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_223"}},"responseCodes":["200"],"pointer":"orderRefundStatusChangeNotification","href":"webhooks/orderrefundstatuschangenotification","openApiOperationId":"orderRefundStatusChangeNotification","summary":"Order Refund Status Change Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_223","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_223"}},"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/orderRefundStatusChangeNotification/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/orderrefundstatuschangenotification"}],"panels":[]}]},"httpPath":"orderRefundStatusChangeNotification"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deliveryStatusChangeNotification","name":"Delivery Status Change Notification","isWebhook":true,"pointer":"/paths/deliveryStatusChangeNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivery Status Change 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":"This webhook is designed to inform the developer's system whenever there is a change in the status of Keeta Couriers."},"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":" 1006"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_224"}},"schemaId":"schema_224","pointer":"/paths/deliveryStatusChangeNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"deliveryStatusChangeNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_224"}},"responseCodes":["200"],"pointer":"deliveryStatusChangeNotification","href":"webhooks/deliverystatuschangenotification","openApiOperationId":"deliveryStatusChangeNotification","summary":"Delivery Status Change Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_224","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_224"}},"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/deliveryStatusChangeNotification/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/deliverystatuschangenotification"}],"panels":[]}]},"httpPath":"deliveryStatusChangeNotification"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialProductRefundStatusChangeNotification","name":"Partial Product Refund Request Status Change Notification","isWebhook":true,"pointer":"/paths/partialProductRefundStatusChangeNotification/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial Product Refund Request Status Change 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":"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."},"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":" 1007"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225"}},"schemaId":"schema_225","pointer":"/paths/partialProductRefundStatusChangeNotification/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"partialProductRefundStatusChangeNotification","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_225"}},"responseCodes":["200"],"pointer":"partialProductRefundStatusChangeNotification","href":"webhooks/partialproductrefundstatuschangenotification","openApiOperationId":"partialProductRefundStatusChangeNotification","summary":"Partial Product Refund Request Status Change Notification"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_225","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225"}},"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/partialProductRefundStatusChangeNotification/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/partialproductrefundstatuschangenotification"}],"panels":[]}]},"httpPath":"partialProductRefundStatusChangeNotification"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Webhooks - Webhook notifications sent by Keeta to third-party systems"}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"orderPlacedNotification","summary":"Order Placed Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/orderplacednotification","deprecated":false},{"title":"orderAcceptanceNotification","summary":"Order Acceptance Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/orderacceptancenotification","deprecated":false},{"title":"orderCompletionNotification","summary":"Order Completion Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/ordercompletionnotification","deprecated":false},{"title":"orderCancellationNotification","summary":"Order Cancellation Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/ordercancellationnotification","deprecated":false},{"title":"orderRefundStatusChangeNotification","summary":"Order Refund Status Change Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/orderrefundstatuschangenotification","deprecated":false},{"title":"deliveryStatusChangeNotification","summary":"Delivery Status Change Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/deliverystatuschangenotification","deprecated":false},{"title":"partialProductRefundStatusChangeNotification","summary":"Partial Product Refund Request Status Change Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/partialproductrefundstatuschangenotification","deprecated":false}]}]}]}]}},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderDispatched","name":"Order Dispatched","isWebhook":false,"pointer":"/paths/~1order~1dispatched/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Dispatched","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 notify the Keeta platform that a courier has picked up the order and the delivery is in progress for merchant self-delivery orders."},"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":"text","inline":true,"attributes":{"content":"This API is exclusively for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant self-delivery orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where the merchant manages their own delivery service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint updates the order status to indicate that the courier has collected the order and delivery is underway."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The courier information provided helps customers track their delivery and contact the delivery person if needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API can only be called after the order has been accepted by the merchant. It cannot be used to update orders that have been "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed"},"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":"cancelled"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_226"}},"schemaId":"schema_226","pointer":"/paths/~1order~1dispatched/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/dispatched","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_226"}},"responseCodes":["200"],"pointer":"/order/dispatched","href":"merchanselfdelivery/orderdispatched","openApiOperationId":"orderDispatched","summary":"Order Dispatched"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_226","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_226"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Courier pickup notification successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227"}},"schemaId":"schema_227"}],"pointer":"/paths/~1order~1dispatched/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_227","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_227"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchanselfdelivery/orderdispatched"}],"panels":[]}]},"httpPath":"/order/dispatched"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderDelivered","name":"Order Delivered","isWebhook":false,"pointer":"/paths/~1order~1delivered/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order Delivered","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 notify the Keeta platform that an order has been successfully delivered to the customer for merchant self-delivery orders."},"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":"text","inline":true,"attributes":{"content":"This API is exclusively for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant self-delivery orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where the merchant manages their own delivery service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Calling this endpoint marks the order as completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Courier information can be updated if needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API does not support duplicate calls for the same order."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_226"}},"schemaId":"schema_226","pointer":"/paths/~1order~1delivered/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/delivered","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_226"}},"responseCodes":["200"],"pointer":"/order/delivered","href":"merchanselfdelivery/orderdelivered","openApiOperationId":"orderDelivered","summary":"Order Delivered"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_226","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_226"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order delivery confirmation successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228"}},"schemaId":"schema_228"}],"pointer":"/paths/~1order~1delivered/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_228","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchanselfdelivery/orderdelivered"}],"panels":[]}]},"httpPath":"/order/delivered"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourierInfo","name":"Update Courier Information","isWebhook":false,"pointer":"/paths/~1order~1updateCourierInfo/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Courier Information","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 update courier information for merchant self-delivery orders, including courier name, phone number, vehicle information, and other delivery-related details."},"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":"text","inline":true,"attributes":{"content":"This API is exclusively for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant self-delivery orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where the merchant manages their own delivery service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updated courier information helps customers track their delivery and contact the delivery person."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API can be called multiple times to update different courier details as needed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one courier information field must be provided in the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API can only be called after the order has been accepted by the merchant. It cannot be used to update orders that have been "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"completed"},"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":"cancelled"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229","pointer":"/paths/~1order~1updateCourierInfo/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/order/updateCourierInfo","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_229"}},"responseCodes":["200"],"pointer":"/order/updateCourierInfo","href":"merchanselfdelivery/updatecourierinfo","openApiOperationId":"updateCourierInfo","summary":"Update Courier Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_229"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Courier information update successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230"}},"schemaId":"schema_230"}],"pointer":"/paths/~1order~1updateCourierInfo/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_230","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_230"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchanselfdelivery/updatecourierinfo"}],"panels":[]}]},"httpPath":"/order/updateCourierInfo"},{"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."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDeliveryTracking","name":"Update Delivery Tracking Information","isWebhook":false,"pointer":"/paths/~1delivery~1merchant~1self~1delivery~1callback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Delivery Tracking Information","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 provide real-time delivery tracking updates for merchant self-delivery orders, including "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ETA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(estimated time of arrival) and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"courier location coordinates"},"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":"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":"text","inline":true,"attributes":{"content":"This API is exclusively for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant self-delivery orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where the merchant manages their own delivery service."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular updates help improve customer experience by providing accurate delivery estimates and tracking."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Coordinate information should use GPS coordinates with precision of 6 decimal places for accuracy."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At least one tracking parameter (besides orderViewId) must be provided in each request."},"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":"Time Range Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedTimeStampLeft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"estimatedTimeStampRight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both have values or both be omitted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot provide only one of these fields."},"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":"Coordinate Requirements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"courierCoordinateLng"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"courierCoordinateLat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both have values or both be omitted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You cannot provide only one coordinate."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_231"}},"schemaId":"schema_231","pointer":"/paths/~1delivery~1merchant~1self~1delivery~1callback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/delivery/merchant/self/delivery/callback","servers":[{"url":"https://open.mykeeta.com/api/open"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_231"}},"responseCodes":["200"],"pointer":"/delivery/merchant/self/delivery/callback","href":"merchanselfdelivery/updatedeliverytracking","openApiOperationId":"updateDeliveryTracking","summary":"Update Delivery Tracking Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open"}],"schemaId":"schema_231","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_231"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delivery tracking information update successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_232"}},"schemaId":"schema_232"}],"pointer":"/paths/~1delivery~1merchant~1self~1delivery~1callback/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_232","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_232"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchanselfdelivery/updatedeliverytracking"}],"panels":[]}]},"httpPath":"/delivery/merchant/self/delivery/callback"}],"content":{"contentType":"group","meta":{"name":"MerchanSelfDelivery"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"MerchanSelfDelivery","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'The endpoint below is restricted to merchant self-delivery orders and is only available for updates after the merchant accepts the order. Orders that are completed or cancelled cannot be updated. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Availability:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API is available starting August 16, 2025.'"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/order/dispatched","summary":"Order Dispatched","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchanselfdelivery/orderdispatched","deprecated":false},{"title":"/order/delivered","summary":"Order Delivered","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchanselfdelivery/orderdelivered","deprecated":false},{"title":"/order/updateCourierInfo","summary":"Update Courier Information","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchanselfdelivery/updatecourierinfo","deprecated":false},{"title":"/delivery/merchant/self/delivery/callback","summary":"Update Delivery Tracking Information","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchanselfdelivery/updatedeliverytracking","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/FindMerchantOrderByViewIdResp":{"id":"components/schemas/FindMerchantOrderByViewIdResp","kind":"json-schema","title":"FindMerchantOrderByViewIdResp","data":{"type":"object","required":["orderInfo"],"properties":{"orderInfo":{"allOf":[{"description":"This structure contains all the detailed information about the order (such as order delivery information, recipient information, cost information, etc.)"},{"$ref":"#/components/schemas/OrderInfoDTO"}]}}}},"components/schemas/OrderInfoDTO":{"id":"components/schemas/OrderInfoDTO","kind":"json-schema","title":"OrderInfoDTO","data":{"type":"object","description":"Contains foundational order details: customer requirements, estimated delivery time, and basic order metadata.","required":["baseOrder","merchantOrder","recipientInfo","feeDtl","rebatesTag","products","bigOrderTag"],"properties":{"baseOrder":{"allOf":[{"description":"Contains foundational order details: customer requirements (e.g., utensils needed), estimated delivery time, and basic order metadata."},{"$ref":"#/components/schemas/BaseOrderDTO"}]},"merchantOrder":{"allOf":[{"description":"Order information acquired from order data model from merchant ends."},{"$ref":"#/components/schemas/MerchantOrderDTO"}]},"merchantOrderDeliveries":{"type":"array","description":"Provides delivery personnel details, including rider name, contact number, etc. This field is only available after a delivery has been initiated for the order, and will always contain only the most recent delivery record.","items":{"$ref":"#/components/schemas/MerchantOrderDeliveryDTO"}},"deliveryInfos":{"type":"array","description":"Tracks real-time logistics data including remaining delivery time, live location updates, and ETA adjustments. This field is only available after a delivery has been initiated for the order.","items":{"$ref":"#/components/schemas/DeliveryInfoDTO"}},"orderPromotionDtlList":{"type":"array","description":"Lists all applied promotions, including coupon details, discount breakdowns, etc. This field is only available when a promotion has been applied to the order.","items":{"$ref":"#/components/schemas/OrderPromotionDtlDTO"}},"refundInfos":{"type":"array","description":"Documents refund history, including initiation reasons, approval statuses, etc. This field is only available after a refund has been issued on the order, and each object represents a single after-sales record.","items":{"$ref":"#/components/schemas/RefundInfos"}},"recipientInfo":{"allOf":[{"description":"Encapsulates recipient details, including full name, phone number, and complete delivery address."},{"$ref":"#/components/schemas/RecipientInfo"}]},"feeDtl":{"allOf":[{"description":"A breakdown of payment components. For details, please check FAQ"},{"$ref":"#/components/schemas/FeeDtl"}]},"rebates":{"allOf":[{"description":"Records partial refunds (item-level reimbursements). Null for full-order refunds. This field is only available when a refund has been issued on the order."},{"$ref":"#/components/schemas/Rebates"}]},"rebatesTag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field explicitly identifies whether an order has undergone a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial item refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This flag enables quick differentiation between fully refunded orders and those with selective item reimbursements."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the value of rebatesTag equals True, it indicates that a partial item refund has been processed for this order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the value of rebatesTag equals False, it means that no partial refunds exist for this order."},"children":[]}]}]}]},"products":{"type":"array","description":"Details all ordered items, including dish names, quantities, customization notes, and pricing.","items":{"$ref":"#/components/schemas/ProductDTO"}},"bigOrderTag":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies large orders requiring split delivery:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When bigOrderTag = True, the order is a \"Large Order\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When bigOrderTag = False, the order is a standard single-delivery order"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Large Order Definition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Orders exceeding logistical capacity thresholds, necessitating division into sub-orders."},"children":[]}]}]}]},"subOrderInfoList":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains an array of sub-order objects that collectively represent the disaggregated components of a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"large parent order."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This field is only available when the order is a large order that has been split into multiple sub-orders."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SubOrderInfoDTO"}}}}},"components/schemas/BaseOrderDTO":{"id":"components/schemas/BaseOrderDTO","kind":"json-schema","title":"BaseOrderDTO","data":{"type":"object","required":["orderViewId","chooseTableware","ctime","payType","payTypeDesc"],"properties":{"orderViewId":{"type":"integer","format":"int64","description":"The unique identifier for orders on Keeta platform.","example":756823555555859},"chooseTableware":{"type":"integer","description":"This field indicates whether utensils are requested for an order.\n","x-enumDescriptions":{"0":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it explicitly means the customer does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" require utensils."},"children":[]}]}]}],"1":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it signifies the customer "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"does"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" need standard utensils."},"children":[]}]}]}],"2":"it indicates that the utensils selection module has been hidden from Keeta C-app."},"example":1},"deliveryTime":{"type":"integer","format":"int64","example":1751444617821,"description":"This field represents Keeta calculated estimated time of arrival (ETA) for order delivery, expressed as milliseconds since Jan 1, 1970 (Unix epoch)"},"ctime":{"type":"integer","format":"int64","example":1751442900803,"description":"This immutable timestamp records the exact moment when the customer successfully placed the order on Keeta platform, using Unix epoch time (milliseconds since 01/01/1970)."},"estimatedDiningReadyUrgeTime":{"type":"integer","format":"int64","example":1751442900883,"description":"For self-pickup orders, this field stores the expected ready-for-collection time as a Unix millisecond timestamp."},"payType":{"type":"string","example":"applepay","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field represents the order payment method. When payType = 'Cash', it indicates that the order is Cash on Delivery (COD)."},"children":[]}]}]}]},"payTypeDesc":{"type":"string","example":"Apple Pay","description":"This field is the description of the 'payType' field."}}}},"components/schemas/MerchantOrderDTO":{"id":"components/schemas/MerchantOrderDTO","kind":"json-schema","title":"MerchantOrderDTO","data":{"type":"object","required":["ctime","status","orderViewId","shopId","shopName","userId","userGetMode"],"properties":{"ctime":{"type":"integer","format":"int64","example":1751442900855,"description":"Records the exact timestamp (in Unix milliseconds since 01/01/1970) when the merchant first receives and creates the order in their system"},"seqNoStr":{"type":"string","example":"29332222","description":"A unique sequential identifier displayed to customers in the Keeta app as the official order reference number. This code will be displayed on order receipts."},"status":{"type":"integer","example":40,"description":"This integer field represents the current state of a merchant's order in the fulfillment lifecycle. The system updates this value in real-time as the order progresses through different stages:\n","x-enumDescriptions":{"10":"(Order Submitted) - The order has been successfully placed by the customer, but is still awaiting merchant confirmation.","20":"(Order Pending Confirmation) - The order is ready and awaiting confirmation.","30":"(Food Preparation) - The kitchen staff has begun cooking the order.","35":"(Preparation Complete) - All items have been cooked and packaged, ready for courier pickup (for delivery orders) or customer collection (for self pickup orders)","40":"(Order Fulfilled) - Successful completion of the entire order process","50":"(Order Cancelled) - The order has been terminated. For specified cancel reasons please refer to cancelReason fields."}},"pushOrderResult":{"type":"integer","example":1,"description":"This field indicates whether the order has been successfully transmitted to the third party's system for processing.\n","x-enumDescriptions":{"0":"(Push Failed) This status indicates the order information was not successfully delivered to the third party's system.","1":"(Push Successful)This status confirms the order has been properly received by the merchant's system."}},"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"The unique identifier for the order in Keeta platform."},"shopId":{"type":"integer","format":"int64","example":611469,"description":"Unique identifier of the Keeta store."},"shopName":{"type":"string","example":"Adani Bar","description":"The official display name of the specific branch location."},"unconfirmedStatusTime":{"type":"integer","format":"int64","example":1751442911840,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp when order entered \"Pending Acceptance\" state (Status=10)"},"children":[]}]}]}]},"confirmedStatusTime":{"type":"integer","format":"int64","example":1751442900883,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp when merchant accepted order (Status=20)"},"children":[]}]}]}]},"readiedStatusTime":{"type":"integer","format":"int64","example":1751442900883,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp when order was marked \"Ready for Pickup\" (Status=35)"},"children":[]}]}]}]},"completedStatusTime":{"type":"integer","format":"int64","example":1751442900883,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp when order reached final completion (Status=40)"},"children":[]}]}]}]},"canceledStatusTime":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp when order was cancelled (Status=50)"},"children":[]}]}]}]},"userId":{"type":"integer","format":"int64","example":10000011133443,"description":"Unique identifier of the customer who placed the order, linking to user profile and order history."},"userGetMode":{"type":"string","example":"delivery","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies delivery method"},"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":"delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Requires courier dispatch"},"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":"pickup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Customer self-collection"},"children":[]}]}]}]}]},"estimatedDiningReadyUrgeTime":{"type":"integer","format":"int64","example":1751442900883,"description":"(For pickup orders only) The expected ready-for-collection timestamp."}}}},"components/schemas/MerchantOrderDeliveryDTO":{"id":"components/schemas/MerchantOrderDeliveryDTO","kind":"json-schema","title":"MerchantOrderDeliveryDTO","data":{"type":"object","required":["deliveryMode"],"properties":{"waybillId":{"type":"integer","format":"int64","example":34524,"description":"Internal delivery tracking ID. It can be ignored by the third party developers."},"subimitDeliveryResult":{"type":"integer","example":1,"description":"Indicates the success or failure of a delivery request submission:\n","x-enumDescriptions":{"0":"the delivery request failed to process (developers should implement retry logic with exponential backoff when encountering this status)","1":"the delivery request was successfully accepted by Keeta's logistics platform"}},"deliveryStatus":{"type":"integer","example":50,"description":"The current operational state of the delivery order in the fulfillment workflow, with the following possible values\n","x-enumDescriptions":{"0":"(Order Created) - The delivery request has been successfully registered in Keeta's system but rider assignment has not yet begun.","10":"(Dispatching) - The system is actively searching for and assigning an available rider to fulfill the order.","20":"(Rider Assigned) - A rider has accepted the delivery task and is preparing to travel to the merchant location.","25":"(Rider Arrived at Store) - The assigned rider has reached the merchant's physical location and is waiting to collect the order.","30":"(Order Collected) - The rider has physically received the order package and begun the delivery journey to the customer.","50":"(Delivery Completed) - The order has been successfully delivered to and acknowledged by the customer.","99":"(Order Cancelled) - The delivery process was terminated."}},"deliveryStatusTime":{"type":"integer","format":"int64","example":1751444617911,"description":"This field contains a Unix timestamp (in milliseconds since January 1, 1970) indicating when the current delivery status (deliveryStatus) was updated."},"arrivedStatusTime":{"type":"integer","format":"int64","example":1751444617999,"description":"This field provides a Unix timestamp recording the actual time when the order was successfully delivered to the customer."},"deliveryMode":{"type":"string","example":"9001","description":"The deliveryMode field specifies the logistics method for order fulfillment:\n","x-enumDescriptions":{"1001":"indicates that delivery tracking available through Keeta's logistics system.","1098":"indicates that delivery is fulfilled by drone.","9001":"indicates that merchant manages own delivery process."}},"courierName":{"type":"string","example":"Jack Ma","description":"Displays the verified name of the rider assigned to the delivery."},"courierPhone":{"type":"string","example":"+966540505598","description":"Provides the actual contact number of the Keeta Courier."},"courierPrivacyPhone":{"type":"string","example":"+96234232424","description":"Contains a temporary virtual phone number of Keeta Courier provided by Keeta privacy protection system."},"merchantOrderDeliveryHisList":{"type":"array","description":"The merchantOrderDeliveryHisList field maintains a complete chronological record of all delivery status change, including change time and status.","items":{"$ref":"#/components/schemas/MerchantOrderDeliveryHisDTO"}}}}},"components/schemas/MerchantOrderDeliveryHisDTO":{"id":"components/schemas/MerchantOrderDeliveryHisDTO","kind":"json-schema","title":"MerchantOrderDeliveryHisDTO","data":{"type":"object","required":["opTime","deliveryStatus"],"properties":{"opTime":{"type":"integer","format":"int64","example":1751444617999,"description":"This field contains a Unix timestamp (in milliseconds since January 1, 1970) indicating when the current delivery status (deliveryStatus) was updated."},"deliveryStatus":{"type":"integer","example":50,"description":"The current operational state of the delivery order in the fulfillment workflow, with the following possible values\n","x-enumDescriptions":{"0":"(Order Created) - The delivery request has been successfully registered in Keeta's system but rider assignment has not yet begun.","10":"(Dispatching) - The system is actively searching for and assigning an available rider to fulfill the order.","20":"(Rider Assigned) - A rider has accepted the delivery task and is preparing to travel to the merchant location.","25":"(Rider Arrived at Store) - The assigned rider has reached the merchant's physical location and is waiting to collect the order.","30":"(Order Collected) - The rider has physically received the order package and begun the delivery journey to the customer.","50":"(Delivery Completed) - The order has been successfully delivered to and acknowledged by the customer.","99":"(Order Cancelled) - The delivery process was terminated."}}}}},"components/schemas/DeliveryInfoDTO":{"id":"components/schemas/DeliveryInfoDTO","kind":"json-schema","title":"DeliveryInfoDTO","data":{"type":"object","properties":{"waybillId":{"type":"integer","format":"int64","example":3456565342356,"description":"Internal delivery tracking ID. It can be ignored by the third party developers."},"estimatedTime":{"type":"integer","example":1800,"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 "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remaining duration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in seconds) from the current time until the order is expected to reach its next status milestone"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Scenario:"},"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":"Current Time: 14:00:00"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next Status ETA: 14:30:00"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estimatedTime = "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1800"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (30 minutes × 60 seconds)"},"children":[]}]}]}]}]},"estimatedAbsolutelyTime":{"type":"integer","example":1751444617999,"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 "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exact predicted moment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the next status transition should occur, expressed as milliseconds since Jan 1, 1970 (Unix epoch)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example Scenario:"},"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":"Next Status ETA: 2024-01-01 14:30:00 UTC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"estimatedAbsolutelyTime = "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1704126600"},"children":[]}]}]}]}]}]}}}},"components/schemas/OrderPromotionDtlDTO":{"id":"components/schemas/OrderPromotionDtlDTO","kind":"json-schema","title":"OrderPromotionDtlDTO","data":{"type":"object","required":["i18n","type","activityId","reduceFee","sillAmount"],"properties":{"i18n":{"allOf":[{"description":"Currency information"},{"$ref":"#/components/schemas/I18nDTO"}]},"type":{"type":"integer","description":"Numeric code representing promotion type. \nEsp. 4, 21,31,32 are enum values for shipping-related discounts. \n"},"typeName":{"type":"string","example":"Delivery charge discount","description":"Promotion type name. Common values:\n","x-enumDescriptions":{"Use red packets":"it indicates that the customer used discount coupon.","Delivery charge discount":"the order received reduced/free delivery fees.","Promo items":"the customer purchased specially marked promotional products."}},"promotionRuleDesc":{"type":"string","example":"delivery fee 8 off 0","description":"Detailed terms and conditions of the promotion, which help merchants to understand how the promotion events work."},"activityId":{"type":"string","example":5620053,"description":"Unique identifier for the promotion campaign"},"reduceFee":{"type":"integer","format":"int64","example":800,"description":"This field indicates the total discount amount applied to the order through the promotion activity."},"sillAmount":{"type":"integer","format":"int64","description":"Some promotional activities require the order amount to meet a minimum threshold before becoming eligible. This field specifies that minimum qualifying amount. When present, the order subtotal must exceed this value for the promotion to be applicable."},"merchantActivityFee":{"type":"integer","format":"int64","example":400,"description":"This field shows the portion of the total discount amount (reduceFee) that is financially borne by the merchant. It represents the merchant contribution to the promotional discount, which will be deducted from the merchant settlement amount with the platform."},"platformActivityFee":{"type":"integer","format":"int64","example":400,"description":"This field displays the portion of the total discount amount (reduceFee) that is subsidized by Keeta platform. It reflects the platform share of the promotional cost, which Keeta absorbs as part of its marketing initiatives or partnership agreements with merchants."},"mainCategory":{"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":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"mainCategory"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates the type of coupon used in the transaction through a numeric code value. This classification system helps identify the scope and applicability of each coupon."},"children":[]}]}]}],"x-enumDescriptions":{"1":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the mainCategory =1, it signifies that the customer applied a universal coupon valid for all products across the platform without restrictions."},"children":[]}]}]}],"2":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the mainCategory = 2 denotes a merchant-specific coupon that can only be redeemed at particular partnered stores."},"children":[]}]}]}],"3":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the mainCategory = 3 represents a product-specific coupon that applies only to designated items in the catalog."},"children":[]}]}]}],"4":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the mainCategory = 4, it indicates the customer used a delivery fee coupon specifically designed to discount shipping costs."},"children":[]}]}]}]}}}}},"components/schemas/Rebates":{"id":"components/schemas/Rebates","kind":"json-schema","title":"Rebates","data":{"type":"object","required":["rebatesInfos","valuationRule","applyOpType"],"properties":{"rebatesInfos":{"type":"array","description":"This field contains detailed information about all products in the order that are included in the refund process.","items":{"$ref":"#/components/schemas/RebatesInfo"}},"residueProducts":{"type":"array","description":"This field contains information about products in the order that are not part of the refund.","items":{"$ref":"#/components/schemas/ProductDTO"}},"valuationRule":{"type":"string","example":"Refund formula: [Item price / (Subtotal + Top-up to minimum)] × [Actual payment amount - Tips - Platform fee - Delivery fee]","description":"This field displays the mathematical formula used to calculate the refund amount."},"applyOpType":{"type":"integer","description":"This code identifies who initiated the partial refund request:\n","x-enumDescriptions":{"0":"indicates a system-automated refund","10":"indicates a customer-initiated refund","20":"indicates a merchant-initiated refund","30":"indicates a customer service-initiated refund"}},"rebatesPrintWarnSuffix":{"type":"string","example":"","description":"After partial refund processing, this text appears at the end of the special notice section on the order receipt."},"rebatesPrintWarnTitle":{"type":"string","example":"","description":"This field serves as the heading/title for the partial refund notification that appears on the order receipt."},"rebatesPrintWarnInfo":{"type":"string","example":"","description":"This field contains the main explanatory text about the partial refund that appears on the order receipt."}}}},"components/schemas/RebatesInfo":{"id":"components/schemas/RebatesInfo","kind":"json-schema","title":"RebatesInfo","data":{"type":"object","required":["rebatesProducts","customerRefundPriceStr","merchantRefundPriceStr"],"properties":{"rebatesProducts":{"type":"array","example":[{"spuId":11020674,"skuId":9968694,"count":1,"price":8925,"priceStr":"$89.25","originPrice":11900,"originPriceStr":"$119.00","name":"Sweet & Sour Pork Ribs","id":325842225,"currency":"HKD","groups":[{"groupId":4709910,"groupName":"AmoHamza Zawrag Variants","minNumber":0,"maxNumber":0,"status":0,"groupOpenItemCode":"VGsku-00035","shopProductGroupSkuList":[{"groupSkuId":26518586,"spuId":9979492,"spuName":"Fried","price":0,"priceStr":"--","currency":"SAR","spuPvList":[],"groupSkuOpenItemCode":"sku-00036-#V0#-","spuNameI18n":{"ar":"مقلي","en":"Fried","default":"Fried"},"groupSkuCount":1,"count":1,"groupSkuExtra":{}}]}],"remark":"","picList":["http://img-ap-hongkong.mykeeta.net/sailorproduct/99903319d53a2fa1e704d2a2ea016cbb167763.jpg"],"spec":"Sweet & Sour Pork Ribs","priceWithoutGroup":{"amount":8925,"amountStr":"$89.25","originAmount":11900,"originAmountStr":"$119.00"},"spuOpenItemCode":"menu.89.category.225.product.1013090","skuOpenItemCode":"89.1013090","refundPrice":7957,"refundPriceStr":"$79.57","priceWithGroup":{"amount":8925,"amountStr":"$89.25","originAmount":11900,"originAmountStr":"$119.00"},"nameI18n":{"en":"Sweet & Sour Pork Ribs","default":"糖醋排骨","zh-HK":"糖醋排骨"},"specI18n":{"en":"Sweet & Sour Pork Ribs","default":"糖醋排骨","zh-HK":"糖醋排骨"}}],"description":"This field contains detailed information about all products included in the refund process for this order.","items":{"$ref":"#/components/schemas/ProductDTO"}},"customerRefundPriceStr":{"type":"string","example":"$14.28","description":"This field represents the total refund amount that will be actually returned to the customer."},"merchantRefundPriceStr":{"type":"string","example":"$14.28","description":"This field represents the total refund amount to be borne by the merchant, calculated as the sum of three components: the refunded commission (merchantBrokerageStr), the merchant share of promotional discounts (merchantActivityFeeStr), and the base product price (merchantProductPriceStr)."},"merchantBrokerageStr":{"type":"string","example":"$1.07","description":"This field represents the amount of commission fee that Keeta platform will refund back to the merchant. When Keeta originally processed the order, a commission fee was deducted from the merchant earnings."},"merchantActivityFeeStr":{"type":"string","example":"$6.58","description":"This field indicates the promotional discount amount that Keeta platform will refund back to the merchant. During the original order, any applied discounts were shared between Keeta and the merchant according to their agreement. With the customer now requesting a refund, Keeta must return the merchant contributed portion of these promotional discounts."},"merchantProductPriceStr":{"type":"string","example":"$28.00","description":"This field contains the product cost amount that the merchant needs to refund to the customer. It represents the base price of the items being refunded, excluding any platform fees or promotional discounts."}}}},"components/schemas/RefundInfos":{"id":"components/schemas/RefundInfos","kind":"json-schema","title":"RefundInfos","data":{"type":"object","required":["applyType","refundMoney","i18n","status","refundType"],"properties":{"applyType":{"type":"integer","example":4001,"description":[{"$$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":"applyType"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is an integer value that identifies the specific type of refund request being processed. Each numeric code corresponds to a distinct refund initiation scenario, providing clear categorization of how and why the refund was triggered."},"children":[]}]}]}],"x-enumDescriptions":{"1001":"This code indicates the refund was voluntarily initiated by the customer through order detail page.","1002":"When a merchant declines a customer's initial refund request (1001), the customer may escalate the case. This code signifies such an appeal, triggering platform review.","2001":"Keeta's customer service representatives may file refunds on behalf of users who encounter technical issues or need special assistance during the process.","2002":"Reserved for refunds directly initiated by Keeta's internal systems or staff due to operational/technical requirements, independent of customer requests.","3001":"Order cancellation auto-refund, which applied when orders are canceled through standard workflows, automatically triggering refunds without manual intervention.","3002":"The system detects and processes refunds for identical duplicate requests to prevent accidental double refunds.","3003":"Occurs when payment confirmation arrives after order cancellation, requiring automatic reversal of the payment.","4001":"Merchant-originated refund. Merchants may proactively issue refunds for operational reasons (e.g., inventory shortages, service failures)."}},"refundMoney":{"type":"string","example":"2600","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actual refund amount"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will be credited back to the customer."},"children":[]}]}]}]},"i18n":{"allOf":[{"description":"This field contains currency localization details for the refund amount."},{"$ref":"#/components/schemas/I18nDTO"}]},"status":{"type":"integer","example":5002,"description":"","x-enumDescriptions":{"1001":"the customer has just created an after-sales request which is pending merchant review.","1002":"the customer voluntarily withdrew their request before any action was taken.","1003":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the customer escalated the case to Keeta's support team after the merchant rejected their initial request (1001 → 2002 → 1003)."},"children":[]}]}]}],"1004":"the customer withdrew their appeal (1003) before Keeta's review team could process it.","2000":"the merchant initiated an after-sales request, typically for order cancellation.","2001":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the merchant accepted the customer's request (1001 → 2001), allowing the refund/return to proceed."},"children":[]}]}]}],"2002":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the merchant declined the customer's request (1001 → 2002), often prompting an appeal (1003)."},"children":[]}]}]}],"3000":"Keeta's customer service team filed an after-sales request on behalf of either user or merchant.","3001":"Keeta's support team manually approved the request after review, common for disputed cases.","3002":"Keeta's support team denied the request after evaluation, typically due to policy violations.","4001":"he customer did not process the after-sales request within the required timeframe and Keeta's system automatically cancelled it.","4002":"the merchant did not respond to the request within the required timeframe and Keeta's system automatically approved it.","4003":"the merchant cancelled the order.","4004":"Keeta's customer service cancelled the order.","4011":"Keeta's system automatically reviewed order records and rejected the refund request based on liability determination.","4012":"Keeta's system automatically reviewed order records and approved the refund request based on liability determination.","5001":"the order refund is currently being processed and will be completed shortly.","5002":"the order refund has been successfully processed.","5003":"the order refund failed to process."}},"refundType":{"type":"integer","example":0,"description":"This field indicates the method by which the refund amount will be returned to the customer. The possible values are:\n","x-enumDescriptions":{"0":"the refund amount will be returned through the original payment method used for the order. This is the default refund method.","1":"the refund amount will be credited to the customer's Keeta account balance."}},"applyReason":{"type":"string","example":"Item unavailable. Additional information: Insufficient dishes","description":"This field provides a description of the reason for the refund request."},"opTime":{"type":"integer","format":"int64","example":1744559452999,"description":"This field contains a Unix timestamp (in milliseconds since January 1, 1970) that records when the refund request transitioned to its current status. This timestamp is essential for tracking the exact timing of status changes throughout the refund process."},"refundStatusHisList":{"type":"array","description":"This field maintains a complete chronological history of all status changes for the refund request.","items":{"$ref":"#/components/schemas/RefundStatusHis"}}}}},"components/schemas/I18nDTO":{"id":"components/schemas/I18nDTO","kind":"json-schema","title":"I18nDTO","data":{"type":"object","required":["currency"],"properties":{"currency":{"type":"string","example":"SAR","description":"This field contains the currency code that indicates the monetary unit used for the transaction or display."},"region":{"type":"string","example":"","description":"This field specifies a geographic region code that represents a sub-national area, typically providing more granular location information than country-level."},"country":{"type":"string","example":"","description":"This field contains the country code that identifies the nation or territory associated with the transaction."},"locale":{"type":"string","example":"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field provides the language and region combination used for localization purposes. It determines the language for text displays and formatting conventions for dates/numbers. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is typically empty/null unless specific localization is required."},"children":[]}]}]}]}]}}}},"components/schemas/RefundStatusHis":{"id":"components/schemas/RefundStatusHis","kind":"json-schema","title":"RefundStatusHis","data":{"type":"object","required":["opTime","toStatus"],"properties":{"opReason":{"type":"string","example":"Item unavailable. Additional information: Insufficient dishes","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field documents the reason for the after-sales request status change. It may contain:"},"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":"The customer's original refund reason when initiating the request (e.g., \"Received wrong item\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's justification for approving/rejecting the request (e.g., \"Verified delivery completion\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System-generated explanations for automatic status changes (e.g., \"Auto-approved due to merchant timeout\")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keeta custom service team's decision rationale when intervening in disputes"},"children":[]}]}]}]}]},"opTime":{"type":"integer","format":"int64","example":1751444617999,"description":"This field records the precise timestamp (in milliseconds since Unix epoch January 1, 1970 00:00:00 UTC) when the refund status transition occurred. This provides an auditable timeline of all state changes throughout the refund lifecycle."},"toStatus":{"type":"integer","example":2000,"description":"This field indicates the target status code that the refund request is transitioning to. The numeric values and their meanings exactly correspond to those defined in the RefundInfos.status field."}}}},"components/schemas/RecipientInfo":{"id":"components/schemas/RecipientInfo","kind":"json-schema","title":"RecipientInfo","data":{"type":"object","required":["name","phone","interCode"],"properties":{"name":{"type":"string","example":"Pony Ma","description":"This field contains the full name of the order recipient who will receive the delivery."},"phone":{"type":"string","example":"+966540505555","description":"This field provides the primary contact phone number of the order recipient."},"interCode":{"type":"string","example":"+96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field specifies the international dialing code for the recipient phone number (e.g., \"+86\" for China, \"+1\" for USA). This enables proper international calling format when needed."},"children":[]}]}]}]},"addressName":{"type":"string","example":"Sha Tian, HongKong District","description":"This field contains the complete address information including administrative divisions and street information (e.g., \"Beijing, Haidian District, Zhongguancun Street\"). It provides the main location context for delivery."},"houseNumber":{"type":"string","example":"No. 27, Building 5, Unit 302","description":"This field provides the detailed building and unit number information to precisely identify the delivery location (e.g., \"No. 27, Building 5, Unit 302\"). Combined with addressName, it forms the complete delivery address."},"point":{"allOf":[{"description":"This object contains the precise geographic coordinates of the delivery location with Latitude and Longitude "},{"$ref":"#/components/schemas/PointDTO"}]},"addressStruct":{"type":"string","example":"{\"address\":\"822W+F8 ****, Kuwait\",\"city\":\"Jabriya\",\"country\":\"Kuwait\",\"distance\":\"0\",\"district\":\"B**an\",\"name\":\"8****8 Jabriya, Kuwait\",\"neighborhood\":\"\",\"plusCode\":\"822W+F8\",\"postalCode\":\"\",\"province\":\"Hawalli Governorate\",\"source\":\"google\",\"street\":\"\",\"streetNumber\":\"\"}","description":"This field is address struct with json string format from locate. It is not null.PlusCode field means Google Coordinate encoding, postalCode field means postal code."},"detailAddressStruct":{"type":"string","example":"{ \"additionalDirection\": \"\", \"aptNumber\": \"30\", \"avenue\": \"\", \"block\": \"6\", \"buildingName\": \"Home\", \"street\": \"1\", \"unitOrFloor\": \"0\", \"companyName\": \"\", \"streetNumber\": \"\", \"streetName\": \"\", \"addressDetail\": \"\", \"way\": \"\", \"cityName\": \"\", \"district\": \"\" }","description":"This field is address struct with json string format by customer write in Keeta APP.It can be null. additionalDirection means Unstructured detailed address address, only used for Saudi Arabia."}}}},"components/schemas/PointDTO":{"id":"components/schemas/PointDTO","kind":"json-schema","title":"PointDTO","data":{"type":"object","properties":{"latitude":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the north-south position of the delivery location in decimal degrees format, ranging from -90.0 to +90.0. Positive values indicate positions north of the equator, while negative values represent locations south of the equator."},"children":[]}]}]}]},"longitude":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the east-west position of the delivery location in decimal degrees format, ranging from -180.0 to +180.0. Positive values indicate positions east of the prime meridian, while negative values represent locations west of the prime meridian."},"children":[]}]}]}]}}}},"components/schemas/FeeDtl":{"id":"components/schemas/FeeDtl","kind":"json-schema","title":"FeeDtl","data":{"type":"object","required":["merchantFee","customerFee"],"properties":{"merchantFee":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field contains the complete breakdown of all charges that the merchant should collect from the customer for the order. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ IMPORTANT:"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The following fields may be subject to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculation delays"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which can result in the data being "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"temporarily unavailable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If you encounter missing or incomplete values, it is recommended to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"retry the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api-docs.mykeeta.com/apis/standard/order/endpoints/getorderdetails"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order Detail Query API"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after a short delay."},"children":[]}]}]}]},{"$ref":"#/components/schemas/MerchantFee"}]},"customerFee":{"allOf":[{"description":"This field details the actual amount paid by the customer."},{"$ref":"#/components/schemas/CustomerFee"}]}}}},"components/schemas/MerchantFee":{"id":"components/schemas/MerchantFee","kind":"json-schema","title":"MerchantFee","data":{"type":"object","required":["i18n"],"properties":{"i18n":{"allOf":[{"description":"This field contains currency information."},{"$ref":"#/components/schemas/I18nDTO"}]},"productPrice":{"type":"integer","format":"int64","example":4600,"description":"The total base price of all items in the order before any adjustments."},"brokerage":{"type":"integer","format":"int64","example":592,"description":"The commission fee that Keeta platform will deduct from the merchant settlement, calculated as a percentage of productPrice according to the merchant contract terms."},"activityFee":{"type":"integer","format":"int64","example":900,"description":"The portion of promotional discounts that the merchant is responsible for absorbing. This amount is deducted from the merchant settlement."},"diffPrice":{"type":"integer","format":"int64","example":0,"description":"The minimum order value surcharge applied when an order subtotal (productPrice) falls below the store required minimum spend threshold."},"total":{"type":"integer","format":"int64","example":2976,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant receivable amount after all adjustment. Calculated as: total = productPrice - brokerage - activityFee + diffPrice"},"children":[]}]}]}]},"platformServiceFee":{"type":"integer","format":"int64","example":0,"description":"A service fee charged by Keeta platform directly to the customer (not deducted from merchant funds)."}}}},"components/schemas/CustomerFee":{"id":"components/schemas/CustomerFee","kind":"json-schema","title":"CustomerFee","data":{"type":"object","required":["i18n","productPrice","shippingFee","tip","diffPrice","payTotal"],"properties":{"i18n":{"allOf":[{"description":"This field contains currency information."},{"$ref":"#/components/schemas/I18nDTO"}]},"productPrice":{"type":"integer","format":"int64","example":4600,"description":"The total price of all menu items before any discounts or promotions."},"shippingFee":{"type":"integer","format":"int64","example":1900,"description":"The delivery fee charged for the order."},"platformFee":{"type":"integer","format":"int64","example":0,"description":"The service fee Keeta charges to users for using the platform."},"discounts":{"type":"integer","format":"int64","example":1900,"description":"The total amount discounted from the order through all applicable promotions, coupons, and special offers."},"tip":{"type":"integer","format":"int64","example":0,"description":"The optional gratuity amount given by the customer to the Keeta courier."},"diffPrice":{"type":"integer","format":"int64","example":0,"description":"The minimum order value surcharge applied when an order subtotal (productPrice) falls below the store required minimum spend threshold."},"payTotal":{"type":"integer","format":"int64","example":4600,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The final amount actually paid by the customer. Calculated as: (productPrice) + (shippingFee) + (platformFee) + (diffPrice) - (discounts) + (tip)"},"children":[]}]}]}]}}}},"components/schemas/ProductDTO":{"id":"components/schemas/ProductDTO","kind":"json-schema","title":"ProductDTO","data":{"type":"object","required":["spuId","skuId","count","price","priceStr","orderViewId","originPrice","originPriceStr","name","id","currency","spec","priceWithoutGroup","priceWithGroup","nameI18n","specI18n"],"properties":{"spuId":{"type":"integer","format":"int64","example":41669804,"description":"The unique ID of the SPU, generated by Keeta platform"},"skuId":{"type":"integer","format":"int64","example":41009754,"description":"The unique ID of the SKU, generated by Keeta platform"},"count":{"type":"integer","format":"int64","example":2,"description":"The quantity of this SKU purchased by the user"},"price":{"type":"integer","format":"int64","example":4600,"description":"The discounted price of this SKU (after applying all promotions)"},"priceStr":{"type":"string","example":"SAR 46.00","description":"The discounted price with currency information (e.g., \"SAR 24.00\")"},"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"The unique order ID generated by Keeta"},"originPrice":{"type":"integer","format":"int64","example":7156,"description":"The original price of this SKU before any discounts"},"originPriceStr":{"type":"string","example":"SAR 46.00","description":"The original price with currency information (e.g., \"SAR 24.00\")"},"name":{"type":"string","example":"ULTIMATE-TUNA","description":"The name of the product/SKU (usually same as SPU name)"},"id":{"type":"integer","format":"int64","example":368813062,"description":"The internal SKU ID used only within Keeta system (developers can ignore)"},"currency":{"type":"string","example":"SAR","description":"The currency used for all price-related fields in this structure"},"groups":{"type":"array","description":"All option group information for this SKU","example":[{"groupId":4587525,"groupName":"Extras","minNumber":0,"maxNumber":2,"status":1,"groupOpenItemCode":"2345432","shopProductGroupSkuList":[{"groupSkuId":25703896,"spuId":8544619,"spuName":"Without Extras","price":0,"priceStr":"-","currency":"SAR","groupSkuOpenItemCode":"9992","refundPrice":0,"refundPriceStr":"","spuNameI18n":{"en":"Without Extras","default":"Without Extras"},"groupSkuCount":1,"count":1,"groups":[{"groupId":4587526,"groupName":"Size","minNumber":0,"maxNumber":1,"status":1,"groupOpenItemCode":"2345433","shopProductGroupSkuList":[{"groupSkuId":25703897,"spuId":8544620,"spuName":"Large","price":0,"priceStr":"-","currency":"SAR","groupSkuOpenItemCode":"9993","refundPrice":0,"refundPriceStr":"","spuNameI18n":{"en":"Large","default":"Large"},"groupSkuCount":1,"count":1}]}]}]}],"items":{"$ref":"#/components/schemas/ProductGroupDTO"}},"remark":{"type":"string","example":"","description":"User remarks for this product (e.g., \"I prefer it spicy\")"},"desc":{"type":"string","description":"Description information about this SPU"},"picList":{"type":"array","description":"Image URLs for this SPU to help customers understand the product","items":{"type":"string","example":"https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e34565311.jpg"}},"spec":{"type":"string","example":"","description":"Specification information for this SKU (e.g., \"Large\" or \"Small\" for pizza sizes)"},"priceWithoutGroup":{"allOf":[{"description":"The unit price of the product without option groups"},{"$ref":"#/components/schemas/AmountDTO"}]},"spuOpenItemCode":{"type":"string","example":"p|c-1305444:p-10259676","description":"Developer-provided code that corresponds to Keeta spuId (see Menu Development Guide)"},"skuOpenItemCode":{"type":"string","example":"p|c-1305444:p-10259676","description":"Developer-provided code that corresponds to Keeta skuId (see Menu Development Guide)"},"refundPrice":{"type":"integer","format":"int64","description":"The refund amount the user will receive if returning this product"},"refundPriceStr":{"example":"$ 3.00","type":"string","description":"The refund amount with currency information (e.g., \"SAR 24.00\")"},"priceWithGroup":{"allOf":[{"description":"The price of the product including Choicegroupsku"},{"$ref":"#/components/schemas/AmountDTO"}]},"nameI18n":{"type":"object","example":{"en":"7-SELECT Chicken Cutlet &Lettuce Sandwich 148g","default":"7-SELECT吉列雞扒生菜軟包三文治","zh-HK":"7-SELECT吉列雞扒生菜軟包三文治"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-language translations of the product name. (key=language code, value=translation)"},"children":[]}]}]}],"additionalProperties":{"type":"string"}},"descI18n":{"type":"object","example":{"zh-HK":"","default":""},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-language translations of the product description. (key=language code, value=translation)"},"children":[]}]}]}],"additionalProperties":{"type":"string"}},"specI18n":{"type":"object","example":{"zh-HK":"","default":""},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-language translations of the product specifications. (key=language code, value=translation)"},"children":[]}]}]}],"additionalProperties":{"type":"string"}}}}},"components/schemas/ProductPVDTO":{"id":"components/schemas/ProductPVDTO","kind":"json-schema","title":"ProductPVDTO","data":{"type":"object","required":["propertyKey","valueList"],"properties":{"propertyKey":{"allOf":[{"description":"Represents the attribute name in product specifications, such as \"Size\" for a pizza"},{"$ref":"#/components/schemas/IdAndName"}]},"valueList":{"type":"array","description":"List of available values for this specification attribute, such as \"Large\", \"Medium\", \"Small\" for size options","items":{"$ref":"#/components/schemas/IdAndName"}}}}},"components/schemas/IdAndName":{"id":"components/schemas/IdAndName","kind":"json-schema","title":"IdAndName","data":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer","format":"int64","description":"This structure is commonly used to represent product specification information. This field indicates the ID of the related attribute."},"name":{"type":"string","description":"This structure is commonly used to represent product specification information. This field indicates the name of the related attribute."}}}},"components/schemas/ProductGroupDTO":{"id":"components/schemas/ProductGroupDTO","kind":"json-schema","title":"ProductGroupDTO","data":{"type":"object","required":["groupId","groupName","status"],"properties":{"groupId":{"type":"integer","format":"int64","example":4587525,"description":"Unique identifier for the ChoiceGroup, generated by Keeta system"},"groupName":{"type":"string","example":"Extras","description":"Display name of the ChoiceGroup"},"minNumber":{"type":"integer","description":"Minimum required selections for this ChoiceGroup (enforced during ordering)"},"maxNumber":{"type":"integer","description":"Maximum allowed selections for this ChoiceGroup (enforced during ordering)"},"status":{"type":"integer","example":1,"description":"Availability status of the ChoiceGroup\n","x-enumDescriptions":{"0":"indicates that the ChoiceGroup is not available,","1":"indicates that the ChoiceGroup is available"}},"shopProductGroupSkuList":{"type":"array","description":"Contains all available ChoiceGroupSkus (selectable items) within this ChoiceGroup","example":[{"groupSkuId":25703896,"spuId":8544619,"spuName":"Without Extras","price":0,"priceStr":"-","currency":"SAR","groupSkuOpenItemCode":"9992","refundPrice":0,"refundPriceStr":"","spuNameI18n":{"en":"Without Extras","default":"Without Extras"},"groupSkuCount":1,"count":1,"groups":[{"groupId":4587526,"groupName":"Size","minNumber":0,"maxNumber":1,"status":1,"groupOpenItemCode":"2345433","shopProductGroupSkuList":[{"groupSkuId":25703897,"spuId":8544620,"spuName":"Large","price":0,"priceStr":"-","currency":"SAR","groupSkuOpenItemCode":"9993","refundPrice":0,"refundPriceStr":"","spuNameI18n":{"en":"Large","default":"Large"},"groupSkuCount":1,"count":1}]}]}],"items":{"$ref":"#/components/schemas/ProductGroupSkuDTO"}},"groupOpenItemCode":{"type":"string","example":"2345432","description":"Developer-provided external reference code that maps to groupId (see Menu Development Guide)"}}}},"components/schemas/ProductSubGroupDTO":{"id":"components/schemas/ProductSubGroupDTO","kind":"json-schema","title":"ProductSubGroupDTO","data":{"type":"object","required":["groupId","groupName","status"],"properties":{"groupId":{"type":"integer","format":"int64","example":4587525,"description":"Unique identifier for the ChoiceGroup, generated by Keeta system"},"groupName":{"type":"string","example":"Extras","description":"Display name of the ChoiceGroup"},"minNumber":{"type":"integer","description":"Minimum required selections for this ChoiceGroup (enforced during ordering)"},"maxNumber":{"type":"integer","description":"Maximum allowed selections for this ChoiceGroup (enforced during ordering)"},"status":{"type":"integer","example":1,"description":"Availability status of the ChoiceGroup\n","x-enumDescriptions":{"0":"indicates that the ChoiceGroup is not available,","1":"indicates that the ChoiceGroup is available"}},"shopProductGroupSkuList":{"type":"array","description":"Contains all available ChoiceGroupSkus (selectable items) within this ChoiceGroup","example":[{"groupSkuId":25703896,"spuId":8544619,"spuName":"Without Extras","price":0,"priceStr":"-","currency":"SAR","groupSkuOpenItemCode":"9992","refundPrice":0,"refundPriceStr":"","spuNameI18n":{"en":"Without Extras","default":"Without Extras"},"groupSkuCount":1,"count":1}],"items":{"$ref":"#/components/schemas/ProductSubGroupSkuDTO"}},"groupOpenItemCode":{"type":"string","example":"2345432","description":"Developer-provided external reference code that maps to groupId (see Menu Development Guide)"}}}},"components/schemas/ProductGroupSkuDTO":{"id":"components/schemas/ProductGroupSkuDTO","kind":"json-schema","title":"ProductGroupSkuDTO","data":{"type":"object","required":["groupSkuId","spuId","spuName","price","priceStr","currency","spuNameI18n","groupSkuCount","count"],"properties":{"groupSkuId":{"type":"integer","format":"int64","example":25703896,"description":"Unique identifier for the ChoiceGroupSku, generated by Keeta system"},"spuId":{"type":"integer","format":"int64","example":8544619,"description":"Unique identifier for the parent SPU, generated by Keeta system"},"spuName":{"type":"string","example":"Without Extras","description":"Name of the Standard Product Unit (SPU)"},"price":{"type":"integer","format":"int64","example":0,"description":"Price of this ChoiceGroupSku"},"priceStr":{"type":"string","example":"-","description":"Formatted price with currency symbol (e.g., \"SAR 24.00\")"},"currency":{"type":"string","example":"SAR","description":"Currency code (e.g., \"SAR\" for Saudi Riyal)"},"groupSkuOpenItemCode":{"type":"string","example":"9992","description":"Developer-provided external code mapping to groupSkuId (see Menu Development Guide)"},"refundPrice":{"type":"integer","format":"int64","example":0,"description":"Refund amount for this ChoiceGroupSku in smallest currency unit"},"refundPriceStr":{"type":"string","example":"","description":"Formatted refund amount with currency (e.g., \"SAR 24.00\")"},"spuNameI18n":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Localized SPU names (key=language code, value=translation)"},"children":[]}]}]}],"additionalProperties":{"type":"string"}},"groupSkuCount":{"type":"integer","format":"int64","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total purchased quantity (count × parent ProductDTO.count)"},"children":[]}]}]}]},"count":{"type":"integer","example":1,"description":"Customer selected quantity of the ChoicegroupSku"},"groups":{"type":"array","description":"All option group information for this SKU","example":[{"groupId":4587525,"groupName":"Toppings","minNumber":0,"maxNumber":3,"status":1,"groupOpenItemCode":"2345432","shopProductGroupSkuList":[{"groupSkuId":25703896,"spuId":8544619,"spuName":"Cheese","price":500,"priceStr":"SAR 5.00","currency":"SAR","groupSkuOpenItemCode":"9992","refundPrice":0,"refundPriceStr":"","spuNameI18n":{"en":"Cheese","default":"Cheese"},"groupSkuCount":1,"count":1}]}],"items":{"$ref":"#/components/schemas/ProductSubGroupDTO"}}}}},"components/schemas/ProductSubGroupSkuDTO":{"id":"components/schemas/ProductSubGroupSkuDTO","kind":"json-schema","title":"ProductSubGroupSkuDTO","data":{"type":"object","required":["groupSkuId","spuId","spuName","price","priceStr","currency","spuNameI18n","groupSkuCount","count"],"properties":{"groupSkuId":{"type":"integer","format":"int64","example":25703896,"description":"Unique identifier for the ChoiceGroupSku, generated by Keeta system"},"spuId":{"type":"integer","format":"int64","example":8544619,"description":"Unique identifier for the parent SPU, generated by Keeta system"},"spuName":{"type":"string","example":"Without Extras","description":"Name of the Standard Product Unit (SPU)"},"price":{"type":"integer","format":"int64","example":0,"description":"Price of this ChoiceGroupSku"},"priceStr":{"type":"string","example":"-","description":"Formatted price with currency symbol (e.g., \"SAR 24.00\")"},"currency":{"type":"string","example":"SAR","description":"Currency code (e.g., \"SAR\" for Saudi Riyal)"},"groupSkuOpenItemCode":{"type":"string","example":"9992","description":"Developer-provided external code mapping to groupSkuId (see Menu Development Guide)"},"refundPrice":{"type":"integer","format":"int64","example":0,"description":"Refund amount for this ChoiceGroupSku in smallest currency unit"},"refundPriceStr":{"type":"string","example":"","description":"Formatted refund amount with currency (e.g., \"SAR 24.00\")"},"spuNameI18n":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Localized SPU names (key=language code, value=translation)"},"children":[]}]}]}],"additionalProperties":{"type":"string"}},"groupSkuCount":{"type":"integer","format":"int64","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total purchased quantity (count × parent ProductDTO.count)"},"children":[]}]}]}]},"count":{"type":"integer","example":1,"description":"Customer selected quantity of the ChoicegroupSku"}}}},"components/schemas/AmountDTO":{"id":"components/schemas/AmountDTO","kind":"json-schema","title":"AmountDTO","data":{"type":"object","required":["amount","unitPrice","amountStr","originAmount","originUnitPrice","originAmountStr"],"properties":{"amount":{"type":"integer","format":"int64","example":4600,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total discounted price for the product (discounted unit price × quantity)"},"children":[]}]}]}]},"unitPrice":{"type":"integer","format":"int64","example":2300,"description":"Discounted price per unit of the product"},"amountStr":{"type":"string","example":"SAR 23.00","description":"Formatted total discounted price with currency symbol (e.g., \"SAR 24.00\")"},"originAmount":{"type":"integer","format":"int64","example":4600,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original total price before discounts (original unit price × quantity)"},"children":[]}]}]}]},"originUnitPrice":{"type":"integer","format":"int64","example":2300,"description":"Original price per unit before any discounts"},"originAmountStr":{"type":"string","example":"SAR 23.00","description":"Formatted original unit price with currency symbol (e.g., \"SAR 24.00\")"}}}},"components/schemas/SubOrderInfoDTO":{"id":"components/schemas/SubOrderInfoDTO","kind":"json-schema","title":"SubOrderInfoDTO","data":{"type":"object","required":["merchantSubOrder","products"],"properties":{"merchantSubOrder":{"allOf":[{"description":"Contains basic sub-order information(see MerchantSubOrderDTO section for details)"},{"$ref":"#/components/schemas/MerchantSubOrderDTO"}]},"products":{"type":"array","description":"Lists all products included in this sub-order (see ProductDTO section for details)","items":{"$ref":"#/components/schemas/ProductDTO"}},"merchantOrderDeliveries":{"type":"array","description":"Contains all delivery-related information for this sub-order (see MerchantOrderDeliveryDTO section)","items":{"$ref":"#/components/schemas/MerchantOrderDeliveryDTO"}},"deliveryInfos":{"type":"array","description":"Provides real-time delivery tracking information for the sub-order (see DeliveryInfoDTO section)","items":{"$ref":"#/components/schemas/DeliveryInfoDTO"}},"partRefund":{"allOf":[{"description":"Contains refund details specific to this sub-order (see PartRefundDTO section)"},{"$ref":"#/components/schemas/PartRefundDTO"}]}}}},"components/schemas/MerchantSubOrderDTO":{"id":"components/schemas/MerchantSubOrderDTO","kind":"json-schema","title":"MerchantSubOrderDTO","data":{"type":"object","required":["merchantSubOrderId","orderViewId","shopId","userId","subOrderSeq","ctime","utime"],"properties":{"merchantSubOrderId":{"type":"integer","format":"int64","description":"Unique identifier for the suborder"},"orderViewId":{"type":"integer","format":"int64","description":"Unique ID of the main/parent order from which this suborder was split"},"shopId":{"type":"integer","format":"int64","description":"Unique store ID generated by Keeta system"},"userId":{"type":"integer","format":"int64","description":"Unique user ID generated by Keeta system"},"subOrderSeq":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suborder sequence number printed on receipts (Format: #MainOrderID-SuborderIndex/TotalSuborders, e.g., \"#9527-1/3\" means main order 9527, suborder 1 of 3)"},"children":[]}]}]}]},"extra":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional suborder metadata containing:"},"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":"Main order ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suborder sequence index"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total suborder count"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: \"#9527-1/3\" shows main order 9527, suborder 1 of 3"},"children":[]}]}]}]}]},"ctime":{"type":"integer","format":"int64","description":"Suborder creation time as Unix timestamp (milliseconds since January 1, 1970)"},"utime":{"type":"integer","format":"int64","description":"Suborder update time as Unix timestamp. Typically equals ctime unless modified."}}}},"components/schemas/PartRefundDTO":{"id":"components/schemas/PartRefundDTO","kind":"json-schema","title":"PartRefundDTO","data":{"type":"object","required":["products"],"properties":{"products":{"type":"array","description":"Contains detailed information about all products in the suborder that are included in the refund process","items":{"$ref":"#/components/schemas/ProductDTO"}},"residueProducts":{"type":"array","description":"Contains detailed information about products in the suborder that are not part of the refund","items":{"$ref":"#/components/schemas/ProductDTO"}}}}},"components/schemas/AfterSaleProductDTO":{"id":"components/schemas/AfterSaleProductDTO","kind":"json-schema","title":"AfterSaleProductDTO","data":{"type":"object","required":["orderProductId","refundCount"],"properties":{"orderProductId":{"type":"integer","format":"int64","example":1234534224,"description":"Unique identifier for the SPU, generated by Keeta platform"},"refundCount":{"type":"integer","format":"int64","example":1,"description":"The quantity of this specific product to be refunded"}}}},"components/schemas/PartRefundPreviewResp":{"id":"components/schemas/PartRefundPreviewResp","kind":"json-schema","title":"PartRefundPreviewResp","data":{"type":"object","properties":{"products":{"type":"array","description":"This field returns the detailed information of all products specified in the refund request parameters that require processing.","items":{"$ref":"#/components/schemas/AfterSaleOrderPartRefundProductsPreviewVO"}},"promotionInfoList":{"type":"array","description":"This field contains comprehensive amount details related to the product refunds.","items":{"$ref":"#/components/schemas/AfterSalePromotionVO"}},"refundPrice":{"allOf":[{"description":"This field represents the total calculated refund amount for all products included in the refund request parameters."},{"$ref":"#/components/schemas/AfterSalePriceCurrency"}]},"valuationRule":{"type":"string","example":"Refund formula: [Item price / (Subtotal + Top-up to minimum)] × [Actual payment amount - Tips - Platform fee - Delivery fee]","description":"This field provides the detailed calculation methodology used to determine the refundPrice value."}}}},"components/schemas/AfterSaleOrderPartRefundProductsPreviewVO":{"id":"components/schemas/AfterSaleOrderPartRefundProductsPreviewVO","kind":"json-schema","title":"AfterSaleOrderPartRefundProductsPreviewVO","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":9312039,"description":"Unique identifier for the SPU, generated by Keeta system"},"spuId":{"type":"integer","format":"int64","example":9312039,"description":"Unique identifier for the SPU, generated by Keeta system"},"skuId":{"type":"integer","format":"int64","example":8414079,"description":"Unique identifier for the SKU, generated by Keeta system"},"count":{"type":"integer","format":"int64","example":2,"description":"Total quantity of this product purchased by the customer"},"price":{"type":"string","example":"$10.00","description":"Unit price of the product"},"name":{"type":"string","example":"Lemon Tea Double Cup Set Meal","description":"Display name of the product"},"refundType":{"type":"integer","example":0,"description":"Indicates the refund status of the product:\n","x-enumDescriptions":{"0":"indicates that the product has not been refunded","1":"indicates that the product has been fully refunded","2":"indicates that the product has been partially refunded"}},"refundCount":{"type":"integer","format":"int64","example":0,"description":"Quantity of this product to be refunded"},"refundPrice":{"type":"string","example":"$0.00","description":"Total refund amount for this product"},"choiceGroupList":{"type":"array","description":"Detailed ChoiceGroup and ChoiceGroupSku information for refunded items","items":{"$ref":"#/components/schemas/AfterSaleOrderProductGroupPreviewVO"}},"associatedChoiceGroupList":{"type":"array","description":"ChoiceGroups associated with the refunded product","items":{"$ref":"#/components/schemas/AfterSaleOrderProductAssociatedGroupPreviewVO"}},"spec":{"type":"string","example":"","description":"Product specifications (e.g., size)"}}}},"components/schemas/AfterSaleOrderProductGroupPreviewVO":{"id":"components/schemas/AfterSaleOrderProductGroupPreviewVO","kind":"json-schema","title":"AfterSaleOrderProductGroupPreviewVO","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":3271540,"description":"Unique identifier for the ChoiceGroup, generated by Keeta system"},"name":{"type":"string","example":"sweetness","description":"Display name of the ChoiceGroup (e.g., \"Toppings\", \"Size Options\")"},"choiceGroupSkuList":{"type":"array","example":[{"id":16320510,"spuId":0,"name":"Slightly sweet","price":"$0.00","refundCount":0,"refundPrice":0,"groupSkuCount":0}],"description":"Contains all ChoiceGroupSkus (selectable items) belonging to this ChoiceGroup","items":{"$ref":"#/components/schemas/AfterSaleOrderProductGroupSkuPreviewVO"}}}}},"components/schemas/AfterSaleOrderProductGroupSkuPreviewVO":{"id":"components/schemas/AfterSaleOrderProductGroupSkuPreviewVO","kind":"json-schema","title":"AfterSaleOrderProductGroupSkuPreviewVO","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier for the ChoiceGroupSku (option item), generated by Keeta system","example":3443},"spuId":{"type":"integer","format":"int64","description":"Unique identifier of the parent SPU (Standard Product Unit), generated by Keeta system","example":45325445},"name":{"type":"string","description":"Display name of the ChoiceGroupSku","example":"ChoiceGroupSkuName"},"price":{"type":"string","description":"Unit price of the ChoiceGroupSku with currency formatting","example":"$24.00"},"refundCount":{"type":"integer","format":"int64","description":"Quantity of this ChoiceGroupSku to be refunded","example":3},"refundPrice":{"type":"integer","format":"int64","description":"Total refund amount for this ChoiceGroupSku","example":156},"groupSkuCount":{"type":"integer","format":"int64","description":"Preview of option group quantity for partial refunds","example":3}}}},"components/schemas/AfterSalePromotionVO":{"id":"components/schemas/AfterSalePromotionVO","kind":"json-schema","title":"AfterSalePromotionVO","data":{"type":"object","properties":{"type":{"type":"integer","description":"Type of promotion/discount applied","example":3},"title":{"type":"string","description":"This field indicates the discount category code currently being applied, with the following values:\n","x-enumDescriptions":{"1":"indicates the \"Subtotal Module\" containing total product amount information","2":"indicates the \"Minimum Spend Supplement Module\" containing the amount needed to meet minimum spending requirements","3":"indicates the \"Coupon Module\" containing coupon discount amounts","4":"indicates the \"Delivery Fee Module\" containing delivery fee reductions","5":"indicates the \"Platform Fee Module\" containing platform fee deductions","6":"indicates the \"Tip Module\" containing customer tips for delivery personnel","7":"indicates the \"All Discounts Module\" containing comprehensive coupon discounts (equivalent to type 3)","8":"indicates the \"Payment Discount Module\" containing instant payment discount amounts"},"example":"promotionName"},"originFee":{"allOf":[{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Original product price before any discounts (calculated as: originFee = realPayFee + reduceFee)"},"children":[]}]}]}]},{"$ref":"#/components/schemas/AfterSalePriceCurrency"}]},"realPayFee":{"allOf":[{"description":"Actual amount paid by customer after discounts"},{"$ref":"#/components/schemas/AfterSalePriceCurrency"}]},"reduceFee":{"allOf":[{"description":"Discount amount deducted from original price due to promotions"},{"$ref":"#/components/schemas/AfterSalePriceCurrency"}]}}}},"components/schemas/AfterSaleOrderProductAssociatedGroupPreviewVO":{"id":"components/schemas/AfterSaleOrderProductAssociatedGroupPreviewVO","kind":"json-schema","title":"AfterSaleOrderProductAssociatedGroupPreviewVO","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Unique identifier for the ChoiceGroup, generated by Keeta system","example":123},"name":{"type":"string","description":"Display name of the ChoiceGroup","example":"noodles"},"auditStatus":{"type":"integer","description":"The value of this field represents the approval status of the 'ChoiceGroup'\n","x-enumDescriptions":{"0":"This choiceGroup has violated regulations and has not passed the manual review of the Keeta platform","1":"This choiceGroup has successfully passed the manual review on the Keeta platform"}},"status":{"type":"integer","description":"The value of this field indicates whether the status of the choiceGroup is valid\n","x-enumDescriptions":{"0":"Indicates that this choiceGroup is invalid","1":"Indicates that this choiceGroup is valid"}}}}},"components/schemas/AfterSalePriceCurrency":{"id":"components/schemas/AfterSalePriceCurrency","kind":"json-schema","title":"AfterSalePriceCurrency","data":{"type":"object","properties":{"amount":{"type":"integer","format":"int64","description":"This field value represents the numerical value corresponding to the amount","example":24},"currency":{"type":"string","description":"This field value represents currency information","example":"SAR"},"amountStr":{"type":"string","description":"This field value represents the numerical value corresponding to the amount, and will carry currency information, example: \"SAR 24.00\"","example":"SAR 24.00"}}}},"components/schemas/CourierInfo":{"id":"components/schemas/CourierInfo","kind":"json-schema","title":"CourierInfo","data":{"type":"object","description":"Comprehensive courier information for self-delivery orders, including personal details, contact information, and vehicle specifications.","properties":{"courierId":{"type":"integer","format":"int64","example":123456,"description":"Unique identifier for the courier, generated by the vendor system"},"courierName":{"type":"string","example":"أحمد محمد","description":"Full name of the courier responsible for delivery"},"courierPhone":{"type":"string","example":"501234567","description":"Primary contact phone number of the courier"},"courierVehicle":{"type":"integer","description":"Type of vehicle used by the courier for delivery:\n","x-enumDescriptions":{"1":"Walking - Courier delivers on foot","2":"Bicycle - Courier uses bicycle for delivery","3":"Motorcycle - Courier uses motorcycle for delivery","4":"Private Car - Courier uses private vehicle for delivery"},"enum":[1,2,3,4],"example":3},"courierPhoneInterCode":{"type":"string","example":"966","description":"International dialing code for the courier phone number (e.g., \"966\" for Saudi Arabia)"},"vehiclePlateNumber":{"type":"string","example":"DXB-A-12345","description":"License plate number of the delivery vehicle"},"courierLastName":{"type":"string","example":"محمد","description":"Last name (family name) of the courier"},"courierFirstName":{"type":"string","example":"أحمد","description":"First name (given name) of the courier"}}}},"schema_213":{"kind":"json-schema","data":{"type":"object","required":["orderViewId","shopId"],"properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"}}},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FindMerchantOrderByViewIdResp"}}}]},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"object","required":["orderViewId","shopId","cancelCode"],"properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"cancelCode":{"type":"integer","example":500000,"description":"This field represents the code value for the reason an order was canceled. Please send the corresponding cancellation reason code for the merchant's order cancellation in this field.\n","x-enumDescriptions":{"500000":"indicates other unspecified reasons (requires cancelReason)","500001":"indicates insufficient ingredients","500002":"indicates store temporary closure","500003":"indicates staff shortage"},"enum":[500000,500001,500002,500003]},"cancelReason":{"type":"string","example":"too expensive","description":"This text field provides a detailed explanation for the cancellation when using the generic reason code (500000)."}}},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"object","required":["orderViewId","shopId","rejectCode"],"properties":{"orderViewId":{"type":"integer","format":"int64","description":"Unique identifier for orders on Keeta platform","example":756823555555859},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"rejectCode":{"type":"integer","description":"Reason code for refund rejection:\n\n100000: indicates other unspecified reasons\n\n100001: indicates meal preparation already completed\n\n100002: indicates delivery process already initiated\n","enum":[100000,100001,100002]},"rejectReason":{"type":"string","example":"Your Reason","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rejectReason field contains the merchant's textual explanation for refusing a refund request. This provides transparency to customers about the rejection decision."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Using Custom Rejection Code (100000), The rejectReason field becomes mandatory."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For rejectCode = 100001 (meal already prepared) or 100002 (delivery already started), The rejectReason field is optional."},"children":[]}]}]}]}}},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"object","required":["orderViewId","shopId"],"properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"products":{"type":"array","description":"A List of products designated for refund: This field should be populated with specific product information for partial refunds. If left empty, the API will return all products eligible for refund, with the refund amount set to zero.","items":{"$ref":"#/components/schemas/AfterSaleProductDTO"}}}},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PartRefundPreviewResp"}}}]},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"type":"object","required":["orderViewId","shopId","products","partRefundType"],"properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"products":{"type":"array","description":"A List of products designated for refund","items":{"$ref":"#/components/schemas/AfterSaleProductDTO"}},"partRefundType":{"type":"integer","description":"This field represents the code value for the reason for initiating a \"partial product refund\" request within an order.\nPlease send the appropriate code value that corresponds to the reason for initiating the \"partial product refund\" request in this field. The specific meanings of the codes are as follows:\n","x-enumDescriptions":{"200000":"indicates other unspecified reasons (requires partRefundReason)","200001":"indicates slow meal preparation","200002":"indicates insufficient ingredients","200003":"indicates missing or incomplete delivery","200004":"indicates wrong item prepared"},"enum":[200000,200001,200002,200003,200004]},"partRefundReason":{"type":"string","example":"Do not like","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is intended to provide a detailed textual explanation for initiating a partial refund request on specific items within an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For partRefundType = 200000 (Other Reasons), the partRefundReason field is mandatory and must be filled in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For partRefundType = 200001, 200002, 200003, or 200004 (Standard Reasons), the partRefundReason field is optional and may be omitted or left empty."},"children":[]}]}]}]}}},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"type":"object","properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"status":{"type":"integer","description":"Order status code, always 30 for this event","example":30},"opTime":{"type":"integer","format":"int64","example":1751448108144,"description":"Time when the event occurred, specified as milliseconds since Jan 1, 1970 (Unix epoch)"}}},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"object","properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"status":{"type":"integer","description":"Order status code, always 40 for this event","example":40},"opTime":{"type":"integer","format":"int64","example":1751448108144,"description":"Time when the event occurred, specified as milliseconds since Jan 1, 1970 (Unix epoch)"}}},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"type":"object","properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"status":{"type":"integer","description":"Order status code, always 50 for this event","example":50},"opTime":{"type":"integer","format":"int64","example":1751448108144,"description":"Time when the event occurred, specified as milliseconds since Jan 1, 1970 (Unix epoch)"},"cancelReason":{"type":"string","example":"Customer cancel the order","description":"Text description of cancellation reason"},"opType":{"type":"integer","example":10,"description":"Code representing who initiated the cancellation:\n","x-enumDescriptions":{"0":"System-automated cancellation","10":"Customer-initiated cancellation","20":"Merchant-initiated cancellation","30":"Customer service-initiated cancellation"},"enum":[0,10,20,30]}}},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"type":"object","properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"status":{"type":"integer","example":2001,"description":"Refund status code"},"afterSaleOrderId":{"type":"integer","format":"int64","example":833443425408767,"description":"Unique identifier for the after-sales application"},"isAppeal":{"type":"integer","example":0,"description":"Indicates if this is an appealed refund request\n","x-enumDescriptions":{"0":"indicates a standard refund request","1":"indicates a customer appeal case (requires platform intervention)"}},"pictures":{"type":"string","example":"https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b395e330cf94b0e5068b0111111.jpg","description":"The pictures field contains a JSON-formatted array string that stores URLs of images uploaded by customers as evidence for their refund requests. This field supports a maximum of 9 image URLs, with each URL separated by commas and properly escaped within the JSON array structure."},"money":{"type":"integer","format":"int64","example":2800,"description":"Refund amount"},"currency":{"type":"string","example":"HKD","description":"Currency code for the refund amount"},"applyOpType":{"type":"integer","example":10,"description":"Code representing who initiated the refund request:\n","x-enumDescriptions":{"0":"System-automated refund","10":"Customer-initiated refund","20":"Merchant-initiated refund","30":"Customer service-initiated refund"}},"applyReason":{"type":"string","example":"xxx","description":"Original reason for refund request"},"handleOpType":{"type":"integer","example":20,"description":"This field represents the code value corresponding to the type of personnel handling this after-sales application:\n","x-enumDescriptions":{"0":"indicates system-automated processing","10":"indicates customer-initiated refund","20":"indicates merchant-initiated refund","30":"indicates Keeta customer service representative intervention"}},"handleReason":{"type":"string","example":"Merchant agree refund","description":"This field indicates the reason why the after-sales application has been changed to its current status."},"opTime":{"type":"integer","format":"int64","example":1751448108144,"description":"Time when the event occurred, specified as milliseconds since Jan 1, 1970 (Unix epoch)"}}},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"type":"object","properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"logisticsStatus":{"type":"integer","example":10,"description":"The current operational state of the delivery order in the fulfillment workflow, with the following possible values\n","x-enumDescriptions":{"0":"(Order Created) - The delivery request has been successfully registered in Keeta's system but rider assignment has not yet begun.","10":"(Dispatching) - The system is actively searching for and assigning an available rider to fulfill the order.","20":"(Rider Assigned) - A rider has accepted the delivery task and is preparing to travel to the merchant location.","25":"(Rider Arrived at Store) - The assigned rider has reached the merchant's physical location and is waiting to collect the order.","30":"(Order Collected) - The rider has physically received the order package and begun the delivery journey to the customer.","50":"(Delivery Completed) - The order has been successfully delivered to and acknowledged by the customer.","99":"(Order Cancelled) - The delivery process was terminated."}},"opTime":{"type":"integer","format":"int64","example":1751448108144,"description":"Time when the event occurred, specified as milliseconds since Jan 1, 1970 (Unix epoch)"},"courierName":{"type":"string","example":"Pony Ma","description":"Name of the courier responsible for delivery"},"courierPhone":{"type":"string","example":"+96342425335","description":"Phone number of the courier responsible for delivery"},"bigOrderTag":{"type":"boolean","example":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies large orders requiring split delivery:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When bigOrderTag = True, the order is a \"Large Order\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When bigOrderTag = False, the order is a standard single-delivery order"},"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":"Large Order Definition"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Orders exceeding logistical capacity thresholds, necessitating division into sub-orders."},"children":[]}]}]}]},"merchantSubOrderId":{"type":"integer","format":"int64","description":"Unique identifier for the suborder"}}},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"type":"object","properties":{"orderViewId":{"type":"integer","format":"int64","example":756823555555859,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":466663,"description":"Unique identifier of the Keeta store"},"status":{"type":"integer","example":5001,"description":"Refund status code"},"afterSaleOrderId":{"type":"integer","format":"int64","example":833441825390895,"description":"Unique identifier for the after-sales application"},"isAppeal":{"type":"integer","example":0,"description":"Indicates if this is an appealed refund request\n","x-enumDescriptions":{"0":"Not an appeal","1":"Customer appeal case"}},"pictures":{"type":"string","example":"https://img-ap-hongkong.mykeeta.net/sailorproduct/9c760595674b344560cf94b0e5068b19511.jpg","description":"JSON-formatted array string of image URLs uploaded by customers"},"money":{"type":"integer","format":"int64","example":3620,"description":"Refund amount"},"currency":{"type":"string","example":"HKD","description":"Currency code for the refund amount"},"applyOpType":{"type":"integer","example":10,"description":"Code representing who initiated the refund request"},"applyReason":{"type":"string","example":"The quantity of delivered goods has decreased; Additional information: No egg tarts available","description":"Original reason for refund request"},"handleOpType":{"type":"integer","example":20,"description":"Code representing who handled the refund request"},"handleReason":{"type":"string","example":"Merchant agree refund","description":"Reason for status change"},"opTime":{"type":"integer","format":"int64","example":1751448108144,"description":"Time when the event occurred, specified as milliseconds since Jan 1, 1970 (Unix epoch)"},"refundProducts":{"type":"array","description":"This field contains detailed information about all the products that are going to be refunded","items":{"$ref":"#/components/schemas/ProductDTO"}}}},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"object","required":["orderViewId","shopId"],"properties":{"orderViewId":{"type":"integer","format":"int64","example":123456789,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":987654321,"description":"Unique identifier of the Keeta store"},"courierInfo":{"$ref":"#/components/schemas/CourierInfo"}}},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"code":{"type":"integer","description":[{"$$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":"Response Codes for Order Dispatched:"},"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":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success - Courier diapatched notification successful"},"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":"109000000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Request parameter error (specific details in message field)"},"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":"\"merchantOrderViewId is null\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"shopId is null\""},"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":"209000101"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order does not exist"},"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":"2090006003"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This order is not a merchant self-delivery order"},"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":"309000000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": System error"},"children":[]}]}]}]}],"example":0}}}]},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"code":{"type":"integer","description":[{"$$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":"Response Codes for Order Delivered:"},"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":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success - Order delivery delivered successful"},"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":"109000000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Request parameter error (specific details in message field)"},"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":"\"orderViewId is null\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"shopId is null\""},"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":"209000101"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order does not exist"},"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":"2090006003"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This order is not a merchant self-delivery order"},"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":"309000000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": System error"},"children":[]}]}]}]}],"example":0}}}]},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"type":"object","required":["orderViewId","shopId","courierInfo"],"properties":{"orderViewId":{"type":"integer","format":"int64","example":123456789,"description":"Unique identifier for orders on Keeta platform"},"shopId":{"type":"integer","format":"int64","example":987654321,"description":"Unique identifier of the Keeta store"},"courierInfo":{"$ref":"#/components/schemas/CourierInfo"}}},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"code":{"type":"integer","description":[{"$$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":"Response Codes for Update Courier Info:"},"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":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success - Courier information update successful"},"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":"109000000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Request parameter error (specific details in message field)"},"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":"\"orderVieId is null\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"shopId is null\""},"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":"209000101"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order does not exist"},"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":"2090006003"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This order is not a self-delivery order"},"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":"2090006004"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order status does not support synchronizing delivery information"},"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":"309000000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": System error"},"children":[]}]}]}]}],"example":0}}}]},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"type":"object","required":["orderViewId"],"properties":{"orderViewId":{"type":"integer","format":"int64","example":1186341416633223,"description":"Unique identifier for orders on Keeta platform"},"estimatedTimeStampLeft":{"type":"integer","format":"int64","example":1754432190391,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Left boundary of estimated delivery time range in Unix timestamp milliseconds. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be provided together with estimatedTimeStampRight or both omitted."},"children":[]}]}]}]}]},"estimatedTimeStampRight":{"type":"integer","format":"int64","example":1754432190391,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Right boundary of estimated delivery time range in Unix timestamp milliseconds. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be provided together with estimatedTimeStampLeft or both omitted."},"children":[]}]}]}]}]},"estimatedTimeStamp":{"type":"integer","format":"int64","example":1754432190391,"description":"Estimated delivery time in Unix timestamp milliseconds"},"courierCoordinateLng":{"type":"number","format":"double","example":103.819998,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Courier longitude coordinate (GPS), precision recommended to 6 decimal places. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be provided together with courierCoordinateLat or both omitted."},"children":[]}]}]}]}]},"courierCoordinateLat":{"type":"number","format":"double","example":51.296999,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Courier latitude coordinate (GPS), precision recommended to 6 decimal places. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be provided together with courierCoordinateLat or both omitted."},"children":[]}]}]}]}]}}},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/CommonResponse"},{"type":"object","properties":{"code":{"type":"integer","description":[{"$$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":"Response Codes for Update Delivery Tracking:"},"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":"0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success - Delivery tracking information update successful"},"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":"111120000"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Internal error, please try again later"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order ID cannot be empty / Order ID must be numeric"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": At least one valid field must be provided besides order ID and region"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Estimated delivery time boundaries must both exist or both be absent"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Left boundary of estimated delivery time cannot be greater than right boundary"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Longitude and latitude coordinates must both exist or both be absent"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Invalid longitude or latitude coordinates"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order does not exist"},"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":"111120001"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Order status cannot be updated with delivery information / Order is not merchant self delivery"},"children":[]}]}]}]}],"example":0}}}]},"id":"schema_232"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://open.mykeeta.com/api/open"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/@standard/order.json?download"},{"url":"/_bundle/apis/@standard/order.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Keeta Order Management API","description":"This API provides comprehensive order management capabilities for Keeta platform integration, including order operations, refund management, and real-time notifications.\n"}},"baseSlug":"/apis/standard/order","routesMapping":{}}