{"items":[{"type":"link","label":"Keeta Open Delivery API","link":"/en/apis/opendelivery","routeSlug":"/en/apis/opendelivery","content":{"contentType":"overview","meta":{"name":"Keeta Open Delivery API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"opendelivery.json","url":"/_bundle/@l10n/en/apis/@opendelivery/opendelivery.json?download"},{"kind":"download","label":"opendelivery.yaml","url":"/_bundle/@l10n/en/apis/@opendelivery/opendelivery.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/opendelivery"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Keeta Open Delivery API (v.1.0.7)","showPageActions":true}],"sectionId":"/"}]}]}},{"type":"group","label":"Authentication","link":"/en/apis/opendelivery/authentication","routeSlug":"/en/apis/opendelivery/authentication","items":[{"label":"Get Access Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/authentication/gettoken","routeSlug":"/en/apis/opendelivery/authentication/gettoken","metadata":{"seo":{"title":"Get Access Token","description":"Requests new access token for accessing Keeta API resources. If you have completed the development in full compliance with the Open Delivery native protocol's grant_type=client_credentials, please contact Keeta.If you have already completed development using grant_type=client_credentials and have passed SIT certification or are already in production, you can continue to use grant_type=client_credentials without any impact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getToken","name":"Get Access Token","isWebhook":false,"pointer":"/paths/~1oauth~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Access Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Requests new access token for accessing Keeta API resources. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If you have completed the development in full compliance with the Open Delivery native protocol's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", please contact Keeta."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If you have already completed development using "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and have passed SIT certification or are already in production, you can continue to use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" without any impact."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IMPORTANT:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"  The Software Service must obtain the merchant’s authorization before accessing their data."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":5,"id":"authentication/gettoken/request/app-level-token-mode","deepLinkHash":"/authentication/gettoken#authentication/gettoken/request/app-level-token-mode"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"APP Level Token mode"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Application-level access_token"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The access_token can be used to access all stores authorized"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = app_level_token"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Generate and refresh access_token"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{"level":5,"id":"authentication/gettoken/request/shop-level-authorization-code-mode","deepLinkHash":"/authentication/gettoken#authentication/gettoken/request/shop-level-authorization-code-mode"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shop Level Authorization Code mode"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Store-level access_token"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The access_token can be used to access one store authorized"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = shop_level_authorization_code"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Use "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"authorization_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to generate access_token, and return "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refresh_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for subsequent refresh"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = refresh_toke"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"n: Use this parameter to refresh a new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"access_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refresh_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", before the old "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"access_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" expires."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0"}},"schemaId":"schema_0","pointer":"/paths/~1oauth~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth/token","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_0"}},"responseCodes":["200","401","503"],"pointer":"/oauth/token","href":"authentication/gettoken","openApiOperationId":"getToken","summary":"Get Access Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"schema_0","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0"}},"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 token request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}},"schemaId":"schema_1"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1oauth~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/gettoken"}],"panels":[]}]},"httpPath":"/oauth/token"},{"label":"Get Authorization URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/authentication/getauthorizationurl","routeSlug":"/en/apis/opendelivery/authentication/getauthorizationurl","metadata":{"seo":{"title":"Get Authorization URL","description":"Get Keeta merchant authorization link for merchant authorization process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuthorizationUrl","name":"Get Authorization URL","isWebhook":false,"pointer":"/paths/~1oauth~1authorization~1url/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Authorization URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Get Keeta merchant authorization link for merchant authorization process."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"NOTE:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Merchants can click this link to complete the authorization process."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The returned URL can be used to redirect merchants to Keeta's authorization page."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL Example: \"https://merchant.mykeeta.com/m/web/openapi/authorize?locale=en&region=BR&cityId=110200008&risk_cost_id=&responseType=client_credentials&appId=2123830428&redirectUri=&state=&scope=all/#/app-activation\""},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization Flow:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If Software Services wants merchants to be redirected to your own page after authorization, you can set the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"redirectUri"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" parameter accordingly."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When the merchant completes authorization, they will be redirected to your specified "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"redirectUri"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with the following parameters appended:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"redirectUri?authId=authId&state=%s&appId=%s&timestamp=%s&keetaMerchantId=%s&code=%s\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"redirectUri?authId=authId&state=%s&appId=%s&timestamp=%s&keetaMerchantId=%s&code=%s\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Parameter definitions:"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"authId"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Unique authorization identifier for this specific authorization session. Use this ID for subsequent API calls."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"state"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": State parameter for request/response correlation (matches your original request)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"appId"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Your application identifier"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"timestamp"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Authorization completion timestamp"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"keetaMerchantId"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The merchant ID generated by Keeta, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"only returned when the application is in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shop_level_authorization_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" mode"},"children":[],"type":"text"}],"type":"strong"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"code"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The authorization code generated by Keeta, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"only returned when the application is in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shop_level_authorization_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" mode"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For detailed workflow, please refer to: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/en/apis/opendelivery/merchant-self-serve-authorization"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Self-serve Authorization"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionGETSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clientId","in":"query","schemaId":"schema_2","description":"Client ID","required":true},{"name":"redirectUri","in":"query","schemaId":"schema_2","description":"redirectUri"}],"pointer":"/paths/~1oauth~1authorization~1url/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/oauth/authorization/url","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[{"name":"clientId","in":"query","required":true,"schemaId":"schema_2"},{"name":"redirectUri","in":"query","schemaId":"schema_2"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","503"],"pointer":"/oauth/authorization/url","href":"authentication/getauthorizationurl","openApiOperationId":"getAuthorizationUrl","summary":"Get Authorization URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved authorization URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}},"schemaId":"schema_3"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1oauth~1authorization~1url/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/getauthorizationurl"}],"panels":[]}]},"httpPath":"/oauth/authorization/url"},{"label":"Get Authorized Merchant Store List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/authentication/getmerchantinfo","routeSlug":"/en/apis/opendelivery/authentication/getmerchantinfo","metadata":{"seo":{"title":"Get Authorized Merchant Store List","description":"Retrieves authorized merchant store list with basic store information and pagination data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMerchantInfo","name":"Get Authorized Merchant Store List","isWebhook":false,"pointer":"/paths/~1oauth~1authorized~1{authId}~1merchantInfo/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Authorized Merchant Store List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Retrieves authorized merchant store list with basic store information and pagination data."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IMPORTANT:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Valid access token required to access this endpoint."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Returns all authorized store information for the specified authorization ID with pagination support."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"USE CASE:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This endpoint is commonly used for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"store binding"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" functionality, allowing service providers to retrieve authorized store details and bind them to their own systems for shop onboarding."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionGETSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authId","in":"path","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization ID that uniquely identifies a specific authorization session. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Each authorization generates a unique authId. There are two ways to obtain the authId: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" 1. Merchant authorization redirect - the authId is included in the redirect URL        "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" 2. Keeta Authorization Webhook - the authId is provided in the webhook payload "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Please refer to the following for the specific workflow:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/en/apis/opendelivery/merchant-self-serve-authorization"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Self-serve Authorization"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"required":true}],"pointer":"/paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNum","in":"query","schemaId":"schema_4","description":"Page number starting from 1"},{"name":"pageSize","in":"query","schemaId":"schema_5","description":"Number of items per page"}],"pointer":"/paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/oauth/authorized/{authId}/merchantInfo","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"authId","in":"path","required":true,"schemaId":"schema_2"}],"query":[{"name":"pageNum","in":"query","required":false,"schemaId":"schema_4"},{"name":"pageSize","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"responseCodes":["200","401","404","503"],"pointer":"/oauth/authorized/{authId}/merchantInfo","href":"authentication/getmerchantinfo","openApiOperationId":"getMerchantInfo","summary":"Get Authorized Merchant Store List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved merchant store information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantData","exampleIds":["paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/responses/200/content/application~1json/examples/success"]}},"schemaId":"components/schemas/MerchantData","exampleIds":["paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/responses/200/content/application~1json/examples/success"]},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchantData","exampleIds":["paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantData","exampleIds":["paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/responses/200/content/application~1json/examples/success"]}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/getmerchantinfo"}],"panels":[]}]},"httpPath":"/oauth/authorized/{authId}/merchantInfo"},{"label":"Receive Authorization Status Change Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/authentication/receiveauthorizationwebhook","routeSlug":"/en/apis/opendelivery/authentication/receiveauthorizationwebhook","metadata":{"seo":{"title":"Receive Authorization Status Change Notification","description":"Webhook Endpoint for Software Services"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"receiveAuthorizationWebhook","name":"Receive Authorization Status Change Notification","isWebhook":false,"pointer":"/paths/~1webhook~1authorization/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receive Authorization Status Change Notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhook Endpoint for Software Services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This endpoint should be implemented by Software Services to receive authorization status change notifications from Keeta system."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IMPORTANT:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This is an endpoint you need to implement on your server."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"How to configure webhooks"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"  You can log in to the Developer Portal, where there is a webhook configuration section. You can configure webhooks there."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please focus only on the webhook configuration for Formal Store. 1301 represents the webhook for new authorization notifications, and 1302 represents the webhook for authorization cancellation notifications."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"p","attrs":{}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"/assets/webhook_for_authorization.df2cc0e378c27099dcd52634426743765260c78aa609ade1b4caf1ac2d8b7c31.68d109a5.jpg"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Notification Triggers:"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant adds new store authorization"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant cancels store authorization"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Technical Requirements:"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Method:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" HTTP POST"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Content-Type:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" application/json"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response Time:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Recommended within 5 seconds"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HTTP Status:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Must return 200 for success"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Response Format:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" JSON with code and message fields"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Best Practices:"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Idempotency:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Use authId and opType to ensure operation idempotency"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Async Processing:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Respond quickly, process business logic asynchronously"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logging:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Log all received notifications for troubleshooting"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Monitoring:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Set up monitoring and alerting for webhook reception"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Service Provider"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTOA_SS.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-App-Signature","in":"header","schemaId":"schema_6","required":true}],"pointer":"/paths/~1webhook~1authorization/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookNotification","exampleIds":["paths/~1webhook~1authorization/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookNotification","exampleIds":["paths/~1webhook~1authorization/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1webhook~1authorization/post/requestBody","description":"Authorization status change notification data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhook/authorization","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-App-Signature","in":"header","required":true,"schemaId":"schema_6"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookNotification","exampleIds":["paths/~1webhook~1authorization/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/webhook/authorization","href":"authentication/receiveauthorizationwebhook","openApiOperationId":"receiveAuthorizationWebhook","summary":"Receive Authorization Status Change Notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/WebhookNotification","exampleIds":["paths/~1webhook~1authorization/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookNotification","exampleIds":["paths/~1webhook~1authorization/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully processed webhook notification"},{"code":"400","description":"Invalid webhook data format","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal server error processing webhook","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1webhook~1authorization/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse","exampleIds":["paths/~1webhook~1authorization/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/receiveauthorizationwebhook"}],"panels":[]}]},"httpPath":"/webhook/authorization"}],"content":{"contentType":"group","meta":{"name":"authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth/token","summary":"Get Access Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/gettoken","deprecated":false},{"title":"/oauth/authorization/url","summary":"Get Authorization URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication/getauthorizationurl","deprecated":false},{"title":"/oauth/authorized/{authId}/merchantInfo","summary":"Get Authorized Merchant Store List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authentication/getmerchantinfo","deprecated":false},{"title":"/webhook/authorization","summary":"Receive Authorization Status Change Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/receiveauthorizationwebhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Merchant","link":"/en/apis/opendelivery/merchantendpoints","routeSlug":"/en/apis/opendelivery/merchantendpoints","items":[{"label":"Register / Update Merchant endpoint info.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantendpoints/putmerchantonboarding","routeSlug":"/en/apis/opendelivery/merchantendpoints/putmerchantonboarding","metadata":{"seo":{"title":"Register / Update Merchant endpoint info.","description":"Register and update the Merchant endpoint GET /v1/merchant information in  Keeta. For the Software Service, all authorized merchant will use the same token.To enable Keeta to identify which merchant needs to be registered,the Software Service  must include the Keeta merchant ID in its requests.The Software Service should also save the mapping relationship between the Keeta merchant ID and its own merchant ID in the system.Merchants can obtain this merchantId from the Keeta merchant portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putMerchantOnboarding","name":"Register / Update Merchant endpoint info.","isWebhook":false,"pointer":"/paths/~1v1~1merchantOnboarding/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register / Update Merchant endpoint info.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Register and update the Merchant endpoint "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getMerchant"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" information in  Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the Software Service, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"all authorized merchant will use the same token"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enable Keeta to identify which merchant needs to be registered,"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"the Software Service  must include the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta merchant ID"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" in its requests."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The Software Service should also save the mapping relationship between the Keeta merchant ID and its own merchant ID in the system."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchants can obtain this merchantId from the Keeta merchant portal."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IMPORTANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":":"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is necessary to provide the Keeta merchant ID to ensure that the mapping between the merchant ID of Software Service and the merchantId of Keeta is accurate."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If an existing "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta MerchantId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"External MerchantId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" under the App has been previously registered, any subsequent onboarding request containing these identifiers will result in the deletion of historical data and the creation of a new mapping configuration."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Store registration via onboarding endpoint must be completed prior to order flow integration."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This enables Keeta to properly identify the merchantId in your system. Otherwise, no order events will be received via polling or webhook."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPUTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"merchantId","in":"query","schemaId":"schema_7","required":true}],"pointer":"/paths/~1v1~1merchantOnboarding/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchantAPIInfo"}},"schemaId":"components/schemas/MerchantAPIInfo","pointer":"/paths/~1v1~1merchantOnboarding/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/merchantOnboarding","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[{"name":"merchantId","in":"query","required":true,"schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchantAPIInfo"}},"responseCodes":["201","400","401","403","404","503"],"pointer":"/v1/merchantOnboarding","href":"merchantendpoints/putmerchantonboarding","openApiOperationId":"putMerchantOnboarding","summary":"Register / Update Merchant endpoint info."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/MerchantAPIInfo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchantAPIInfo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Resource has been created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAPIInfo"}},"schemaId":"components/schemas/MerchantAPIInfo"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1merchantOnboarding/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/MerchantAPIInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAPIInfo"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantendpoints/putmerchantonboarding"}],"panels":[]}]},"httpPath":"/v1/merchantOnboarding"},{"label":"Get information of a Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantendpoints/getmerchant","routeSlug":"/en/apis/opendelivery/merchantendpoints/getmerchant","metadata":{"seo":{"title":"Get information of a Merchant","description":"Endpoint to get data of a specific merchant, such as basic info, menus, and services."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMerchant","name":"Get information of a Merchant","isWebhook":false,"pointer":"/paths/~1v1~1merchant/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get information of a Merchant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint to get data of a specific merchant, such as basic info, menus, and services."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"this endpoint can "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionally"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" require an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"apiKey"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for authentication, and the Software Service that hosts the endpoint can decide whether it is needed."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The Software Service can pass the data through the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/putMerchantOnboarding"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PUT /v1/merchantOnboarding"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The endpoint is designed so that "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"each merchant has its own URL"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The specification recommends that the endpoint ends with the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/merchant"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" route, but this is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"not mandatory"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can implement the URL in any way it sees fit, as long as it contains information from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"only one"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" merchant."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An item must have either a delivery price or a pickup price. Currently, item with only "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"indoor"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" price is not permitted."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SOFTWARE SERVICE"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionGETOA_SS.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The apiKey is a key that should be generated by the endpoint's host and passed to its clients. Each client of the endpoint can have its own key. The creation and content of the key is of responsibility of the endpoint's host."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release, only the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getMerchant"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint can require authentication via apiKey."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/merchant","servers":[{"url":"https://{domain_of_the_software_service}","variables":{"domain_of_the_software_service":{"default":"api.example.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200","403","404","503"],"pointer":"/v1/merchant","href":"merchantendpoints/getmerchant","openApiOperationId":"getMerchant","summary":"Get information of a Merchant","securityGroups":[{},{"apiKey":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{domain_of_the_software_service}","variables":{"domain_of_the_software_service":{"default":"api.example.com"}}}],"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 Merchant information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchant","exampleIds":["paths/~1v1~1merchant/get/responses/200/content/application~1json/examples/menuExample"]}},"schemaId":"components/schemas/Merchant","exampleIds":["paths/~1v1~1merchant/get/responses/200/content/application~1json/examples/menuExample"]},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1merchant/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Merchant","exampleIds":["paths/~1v1~1merchant/get/responses/200/content/application~1json/examples/menuExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Merchant","exampleIds":["paths/~1v1~1merchant/get/responses/200/content/application~1json/examples/menuExample"]}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantendpoints/getmerchant"}],"panels":[]}]},"httpPath":"/v1/merchant"},{"label":"New Merchant Update Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantendpoints/merchantupdate","routeSlug":"/en/apis/opendelivery/merchantendpoints/merchantupdate","metadata":{"seo":{"title":"New Merchant Update Notification","description":"POST /v1/merchantUpdate/{merchantId}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"merchantUpdate","name":"New Merchant Update Notification","isWebhook":false,"pointer":"/paths/~1v1~1merchantUpdate~1{merchantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Merchant Update Notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/merchantUpdate/{merchantId}"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information about a update in the systems."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This endpoint can be used in the following ways:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"1 - Sent with an empty body:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This will force Keeta to make a new request to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getMerchant"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint to update all the merchant information."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"2 - Sent with only the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"merchantStatus"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This will force the opening or closing of the merchant within Keeta, without forcing a new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getMerchant"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" call."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"3 - Sent with only the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"entityType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"updatedObjects"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" fields:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This will force  Keeta to update only the sent objects, without forcing a new "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getMerchant"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" call."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IMPORTANT:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"1- Please do not pass "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"merchantStatus"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"entityType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"&"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"updatedObjects"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" at the same time. When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"merchantStatus"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" has a value, the request will be regarded as updating only merchant status, and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"entityType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"&"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"updatedObjects"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be ignored.Please update merchant status and other entity separately."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"2- When the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"entityType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field is populated, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"updatedObjects"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field cannot be empty."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"3- It is recommended not to pass an empty body, but to pass a specific entity to be updated to avoid invalid update operations."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"4- An item must have either a delivery price or a pickup price. Currently, item with only "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"indoor"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" price is not permitted."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"5- The business status of a store is determined by many factors (business hours, number of items available for sale, merchant status, etc.)."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"6- Please do note that the number of available Options under the Option Group must meet the Option Group's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"minPermitted"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" requirement. If not, the Option Group will become unfufillable, causing all items using this Option Group to be hidden on the APP."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchantId","in":"path","schemaId":"schema_8","required":true}],"pointer":"/paths/~1v1~1merchantUpdate~1{merchantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchantUpdate"}},"schemaId":"components/schemas/MerchantUpdate","pointer":"/paths/~1v1~1merchantUpdate~1{merchantId}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/merchantUpdate/{merchantId}","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"merchantId","in":"path","required":true,"schemaId":"schema_8"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchantUpdate"}},"responseCodes":["204","400","401","503"],"pointer":"/v1/merchantUpdate/{merchantId}","href":"merchantendpoints/merchantupdate","openApiOperationId":"merchantUpdate","summary":"New Merchant Update Notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/MerchantUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchantUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The change was successfully notified to Keeta."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1merchantUpdate~1{merchantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantendpoints/merchantupdate"}],"panels":[]}]},"httpPath":"/v1/merchantUpdate/{merchantId}"},{"label":"Get Merchant Status and Service Hours","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantendpoints/merchantstatus","routeSlug":"/en/apis/opendelivery/merchantendpoints/merchantstatus","metadata":{"seo":{"title":"Get Merchant Status and Service Hours","description":"Get /v1/merchant/{id}/status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"merchantStatus","name":"Get Merchant Status and Service Hours","isWebhook":false,"pointer":"/paths/~1v1~1merchant~1{id}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Merchant Status and Service Hours","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Get /v1/merchant/{id}/status"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Return the merchant status, service hours(serviceHours), and sourceAppId."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionGETSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_2","description":"The unique identifier of the merchant. The id is generated by the Software Service.","required":true}],"pointer":"/paths/~1v1~1merchant~1{id}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/merchant/{id}/status","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"responseCodes":["200","400","401","403","404","503"],"pointer":"/v1/merchant/{id}/status","href":"merchantendpoints/merchantstatus","openApiOperationId":"merchantStatus","summary":"Get Merchant Status and Service Hours"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"After the interface request is successful, it will return the business status, business hours, and source of the store. Based on this interface, you can check whether the update of store-related information through merchantUpdate is successful.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantStatus","exampleIds":["paths/~1v1~1merchant~1{id}~1status/get/responses/200/content/application~1json/examples/menuExample"]}},"schemaId":"components/schemas/MerchantStatus","exampleIds":["paths/~1v1~1merchant~1{id}~1status/get/responses/200/content/application~1json/examples/menuExample"]},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1merchant~1{id}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchantStatus","exampleIds":["paths/~1v1~1merchant~1{id}~1status/get/responses/200/content/application~1json/examples/menuExample"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantStatus","exampleIds":["paths/~1v1~1merchant~1{id}~1status/get/responses/200/content/application~1json/examples/menuExample"]}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantendpoints/merchantstatus"}],"panels":[]}]},"httpPath":"/v1/merchant/{id}/status"},{"label":"Image Upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantendpoints/imageupload","routeSlug":"/en/apis/opendelivery/merchantendpoints/imageupload","metadata":{"seo":{"title":"Image Upload","description":"This endpoint allows merchants to upload images to the Keeta platform. The returned image URL can be used during menu synchronization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ImageUpload","name":"Image Upload","isWebhook":false,"pointer":"/paths/~1v1~1merchant~1image~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Image Upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This endpoint allows merchants to upload images to the Keeta platform. The returned image URL can be used during menu synchronization."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"merchantId","in":"query","schemaId":"schema_7","required":true}],"pointer":"/paths/~1v1~1merchant~1image~1upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"}},"schemaId":"schema_9","pointer":"/paths/~1v1~1merchant~1image~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/merchant/image/upload","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[{"name":"merchantId","in":"query","required":true,"schemaId":"schema_7"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"schema_9"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/v1/merchant/image/upload","href":"merchantendpoints/imageupload","openApiOperationId":"ImageUpload","summary":"Image Upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"upload result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1merchant~1image~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantendpoints/imageupload"}],"panels":[]}]},"httpPath":"/v1/merchant/image/upload"}],"content":{"contentType":"group","meta":{"name":"merchantEndpoints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/merchantOnboarding","summary":"Register / Update Merchant endpoint info.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/merchantendpoints/putmerchantonboarding","deprecated":false},{"title":"/v1/merchant","summary":"Get information of a Merchant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchantendpoints/getmerchant","deprecated":false},{"title":"/v1/merchantUpdate/{merchantId}","summary":"New Merchant Update Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchantendpoints/merchantupdate","deprecated":false},{"title":"/v1/merchant/{id}/status","summary":"Get Merchant Status and Service Hours","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchantendpoints/merchantstatus","deprecated":false},{"title":"/v1/merchant/image/upload","summary":"Image Upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchantendpoints/imageupload","deprecated":false}]}]}]}]}},{"type":"group","label":"Order-Polling","link":"/en/apis/opendelivery/orderspolling","routeSlug":"/en/apis/opendelivery/orderspolling","items":[{"label":"Get New Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderspolling/pollingevents","routeSlug":"/en/apis/opendelivery/orderspolling/pollingevents","metadata":{"seo":{"title":"Get New Events","description":"Polls events for any orders from merchants associated with the authenticated user.Each event received from this endpoint must be properly acknowledged, otherwise it will continue to be returned on further requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pollingEvents","name":"Get New Events","isWebhook":false,"pointer":"/paths/~1v1~1events:polling/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get New Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Polls events for any orders from merchants associated with the authenticated user."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Each event received from this endpoint must be properly acknowledged, otherwise it will continue to be returned on further requests."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Important: The software service "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"must first call the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/putMerchantOnboarding"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Onboarding"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to register the store before calling this endpoint, otherwise the polling endpoint will not be able to obtain the events."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionGETSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"eventType","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1events:polling/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-polling-merchants","in":"header","schemaId":"schema_12"}],"pointer":"/paths/~1v1~1events:polling/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/events:polling","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[{"name":"eventType","in":"query","schemaId":"schema_11"}],"querystring":[],"header":[{"name":"x-polling-merchants","in":"header","required":false,"schemaId":"schema_12"}],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"responseCodes":["200","204","400","401","403","503"],"pointer":"/v1/events:polling","href":"orderspolling/pollingevents","openApiOperationId":"pollingEvents","summary":"Get New Events"},"definitionSamples":[{"lang":"curl","label":"cURL","source":"curl -i -X GET \\\n'https://open.mykeeta.com/api/open/opendelivery/v1/events:polling?eventType=CREATED,CANCELLED,CONCLUDED' \\\n-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \\\n-H 'X-App-Signature: YOUR_API_KEY_HERE' \\\n-H 'x-polling-merchants: 22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"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 list of polled events .","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderEventPollingResponse"}},"schemaId":"components/schemas/OrderEventPollingResponse"},{"code":"204","description":"No content."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1events:polling/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderEventPollingResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderEventPollingResponse"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderspolling/pollingevents"}],"panels":[]}]},"httpPath":"/v1/events:polling"},{"label":"Acknowledge Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderspolling/pollingacknowledgment","routeSlug":"/en/apis/opendelivery/orderspolling/pollingacknowledgment","metadata":{"seo":{"title":"Acknowledge Events","description":"Acknowledge a set of events, dismissing them from future polling calls.HOST: Keeta"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pollingAcknowledgment","name":"Acknowledge Events","isWebhook":false,"pointer":"/paths/~1v1~1events~1acknowledgment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Acknowledge a set of events, dismissing them from future polling calls."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13","pointer":"/paths/~1v1~1events~1acknowledgment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/events/acknowledgment","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"schema_13"}},"responseCodes":["202","400","401","403","404","503"],"pointer":"/v1/events/acknowledgment","href":"orderspolling/pollingacknowledgment","openApiOperationId":"pollingAcknowledgment","summary":"Acknowledge Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request has been accepted for processing."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1events~1acknowledgment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderspolling/pollingacknowledgment"}],"panels":[]}]},"httpPath":"/v1/events/acknowledgment"}],"content":{"contentType":"group","meta":{"name":"ordersPolling"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order-Polling","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/events:polling","summary":"Get New Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orderspolling/pollingevents","deprecated":false},{"title":"/v1/events/acknowledgment","summary":"Acknowledge Events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderspolling/pollingacknowledgment","deprecated":false}]}]}]}]}},{"type":"group","label":"Order-Webhook","link":"/en/apis/opendelivery/orderswebhook","routeSlug":"/en/apis/opendelivery/orderswebhook","items":[{"label":"New Order Event Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderswebhook/newevent","routeSlug":"/en/apis/opendelivery/orderswebhook/newevent","metadata":{"seo":{"title":"New Order Event Notification","description":"POST /v1/newEvent"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"newEvent","name":"New Order Event Notification","isWebhook":false,"pointer":"/paths/~1v1~1newEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Order Event Notification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/newEvent"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information about a new event in the systems"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SOFTWARE SERVICE"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTOA_SS.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-App-Id","in":"header","schemaId":"schema_14","required":true},{"name":"X-App-MerchantId","in":"header","schemaId":"schema_15","required":true},{"name":"X-App-Signature","in":"header","schemaId":"schema_16","required":true}],"pointer":"/paths/~1v1~1newEvent/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Event"}},"schemaId":"components/schemas/Event","pointer":"/paths/~1v1~1newEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/newEvent","servers":[{"url":"https://{domain_of_the_software_service}/api/open/opendelivery","variables":{"domain_of_the_software_service":{"default":"api.example.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-App-Id","in":"header","required":true,"schemaId":"schema_14"},{"name":"X-App-MerchantId","in":"header","required":true,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824","schemaId":"schema_17"},{"name":"X-App-Signature","in":"header","required":true,"schemaId":"schema_16"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Event"}},"responseCodes":["200","204","400","403","404","503"],"pointer":"/v1/newEvent","href":"orderswebhook/newevent","openApiOperationId":"newEvent","summary":"New Order Event Notification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{domain_of_the_software_service}/api/open/opendelivery","variables":{"domain_of_the_software_service":{"default":"api.example.com"}}}],"schemaId":"components/schemas/Event","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Event"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Status 200 available for compatibility reasons. Please use status 204 instead."},{"code":"204","description":"Data was received successfully. No response content."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1newEvent/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderswebhook/newevent"}],"panels":[]}]},"httpPath":"/v1/newEvent"}],"content":{"contentType":"group","meta":{"name":"ordersWebhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order-Webhook","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/newEvent","summary":"New Order Event Notification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderswebhook/newevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Order-Order API","link":"/en/apis/opendelivery/orderapi","routeSlug":"/en/apis/opendelivery/orderapi","items":[{"label":"Get Order Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderapi/orderdetails","routeSlug":"/en/apis/opendelivery/orderapi/orderdetails","metadata":{"seo":{"title":"Get Order Details","description":"Endpoint to consult the details of an order.HOST: Keeta"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderDetails","name":"Get Order Details","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Endpoint to consult the details of an order."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionGETSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/orders/{orderId}","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"responseCodes":["200","400","401","403","404","503"],"pointer":"/v1/orders/{orderId}","href":"orderapi/orderdetails","openApiOperationId":"orderDetails","summary":"Get Order Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Order returning success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}},"schemaId":"components/schemas/Order"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Order","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Order"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderapi/orderdetails"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}"},{"label":"Confirm","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderapi/confirmorder","routeSlug":"/en/apis/opendelivery/orderapi/confirmorder","metadata":{"seo":{"title":"Confirm","description":"Informs  Keeta that the order has been accepted and preparation will start soon."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirmOrder","name":"Confirm","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1confirm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that the order has been accepted and preparation will start soon."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected to receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CONFIRMED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event after this action."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1confirm/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConfirmed"}},"schemaId":"components/schemas/OrderConfirmed","pointer":"/paths/~1v1~1orders~1{orderId}~1confirm/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/confirm","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderConfirmed"}},"responseCodes":["202","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/confirm","href":"orderapi/confirmorder","openApiOperationId":"confirmOrder","summary":"Confirm"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/OrderConfirmed","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConfirmed"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request has been accepted for processing."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderapi/confirmorder"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/confirm"},{"label":"Ready For Pickup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderapi/orderready","routeSlug":"/en/apis/opendelivery/orderapi/orderready","metadata":{"seo":{"title":"Ready For Pickup","description":"Informs  Keeta that the order is ready for pickup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderReady","name":"Ready For Pickup","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1readyForPickup/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ready For Pickup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that the order is ready for pickup."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected to receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"READY_FOR_PICKUP"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event after this action."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1readyForPickup/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/readyForPickup","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"responseCodes":["202","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/readyForPickup","href":"orderapi/orderready","openApiOperationId":"orderReady","summary":"Ready For Pickup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request has been accepted for processing."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1readyForPickup/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderapi/orderready"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/readyForPickup"},{"label":"Request order cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderapi/requestcancellation","routeSlug":"/en/apis/opendelivery/orderapi/requestcancellation","metadata":{"seo":{"title":"Request order cancellation","description":"Request order cancellation to Keeta."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"requestCancellation","name":"Request order cancellation","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1requestCancellation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request 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","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Request order cancellation to Keeta."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected to receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLATION_REQUESTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event after this action."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1requestCancellation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCancelled"}},"schemaId":"components/schemas/RequestCancelled","pointer":"/paths/~1v1~1orders~1{orderId}~1requestCancellation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/requestCancellation","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestCancelled"}},"responseCodes":["202","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/requestCancellation","href":"orderapi/requestcancellation","openApiOperationId":"requestCancellation","summary":"Request order cancellation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/RequestCancelled","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestCancelled"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request has been accepted for processing."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/CancellationError"}},"schemaId":"components/schemas/CancellationError"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1requestCancellation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/CancellationError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/CancellationError"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderapi/requestcancellation"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/requestCancellation"},{"label":"Accept order refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderapi/acceptrefund","routeSlug":"/en/apis/opendelivery/orderapi/acceptrefund","metadata":{"seo":{"title":"Accept order refund","description":"Informs Keeta that the refund request has been accepted and the order can be refunded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acceptRefund","name":"Accept order refund","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1acceptRefund/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept order refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs Keeta that the refund request has been accepted and the order can be refunded."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected to receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REFUNDED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event after this action."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1acceptRefund/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/acceptRefund","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/acceptRefund","href":"orderapi/acceptrefund","openApiOperationId":"acceptRefund","summary":"Accept order refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order refund has been confirmed. No response content."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1acceptRefund/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderapi/acceptrefund"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/acceptRefund"},{"label":"Deny order refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderapi/rejectrefund","routeSlug":"/en/apis/opendelivery/orderapi/rejectrefund","metadata":{"seo":{"title":"Deny order refund","description":"Informs Keeta that the refund request has been denied and the order cannot be refunded."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rejectRefund","name":"Deny order refund","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1rejectRefund/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deny order refund","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs Keeta that the refund request has been denied and the order cannot be refunded."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected to receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REFUND_FAILED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event after this action."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1rejectRefund/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDenied"}},"schemaId":"components/schemas/RequestDenied","pointer":"/paths/~1v1~1orders~1{orderId}~1rejectRefund/post/requestBody","description":"Request for order cancellation has been denied."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/rejectRefund","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RequestDenied"}},"responseCodes":["204","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/rejectRefund","href":"orderapi/rejectrefund","openApiOperationId":"rejectRefund","summary":"Deny order refund"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/RequestDenied","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RequestDenied"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Order refund has been denied. No response content."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1rejectRefund/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderapi/rejectrefund"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/rejectRefund"},{"label":"BatchDecrypt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/orderapi/batchdecrypt","routeSlug":"/en/apis/opendelivery/orderapi/batchdecrypt","metadata":{"seo":{"title":"BatchDecrypt","description":"Call this endpoint to decrypt the encrypted data returned by the API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"batchDecrypt","name":"BatchDecrypt","isWebhook":false,"pointer":"/paths/~1v1~1batchDecrypt/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BatchDecrypt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Call this endpoint to decrypt the encrypted data returned by the API."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"merchant self-delivery or third-party logistics (3PL)"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" orders, this endpoint can be called to decrypt the user's phone number and address."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A maximum of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"50"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" data items can be decrypted at once."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The encrypted data generally uses "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ENC_"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" as a prefix."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The following data returned by the order details endpoints will be encrypted data (ciphertext data prefixed with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ENC_"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"):"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"customer.​phone.​number"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"delivery.​deliveryAddress.​district"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"delivery.​deliveryAddress.​number"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"delivery.​deliveryAddress.complement"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"delivery.​deliveryAddress.​formattedAddress"},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"type":"blockquote"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchDecryptRequest"}},"schemaId":"components/schemas/BatchDecryptRequest","pointer":"/paths/~1v1~1batchDecrypt/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/batchDecrypt","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchDecryptRequest"}},"responseCodes":["200","400","401","403","404","422","503"],"pointer":"/v1/batchDecrypt","href":"orderapi/batchdecrypt","openApiOperationId":"batchDecrypt","summary":"BatchDecrypt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/BatchDecryptRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchDecryptRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Message batch decrypt success.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchDecryptResponse"}},"schemaId":"components/schemas/BatchDecryptResponse"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1batchDecrypt/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchDecryptResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchDecryptResponse"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orderapi/batchdecrypt"}],"panels":[]}]},"httpPath":"/v1/batchDecrypt"}],"content":{"contentType":"group","meta":{"name":"orderAPI"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order-Order API","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orders/{orderId}","summary":"Get Order Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orderapi/orderdetails","deprecated":false},{"title":"/v1/orders/{orderId}/confirm","summary":"Confirm","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderapi/confirmorder","deprecated":false},{"title":"/v1/orders/{orderId}/readyForPickup","summary":"Ready For Pickup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderapi/orderready","deprecated":false},{"title":"/v1/orders/{orderId}/requestCancellation","summary":"Request order cancellation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderapi/requestcancellation","deprecated":false},{"title":"/v1/orders/{orderId}/acceptRefund","summary":"Accept order refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderapi/acceptrefund","deprecated":false},{"title":"/v1/orders/{orderId}/rejectRefund","summary":"Deny order refund","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderapi/rejectrefund","deprecated":false},{"title":"/v1/batchDecrypt","summary":"BatchDecrypt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orderapi/batchdecrypt","deprecated":false}]}]}]}]}},{"type":"group","label":"Order-Merchant Fulfill API","link":"/en/apis/opendelivery/merchantfulfillapi","routeSlug":"/en/apis/opendelivery/merchantfulfillapi","items":[{"label":"Dispatch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantfulfillapi/dispatchorder","routeSlug":"/en/apis/opendelivery/merchantfulfillapi/dispatchorder","metadata":{"seo":{"title":"Dispatch","description":"Informs  Keeta that the order has been dispatched."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"dispatchOrder","name":"Dispatch","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1dispatch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dispatch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that the order has been dispatched."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected to receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DISPATCHED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event after this action."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Important:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This endpoint should be sent "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"only in cases where the order logistics service is provided by the Merchant and not the Marketplace"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1dispatch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderDispatched"}},"schemaId":"components/schemas/OrderDispatched","pointer":"/paths/~1v1~1orders~1{orderId}~1dispatch/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/dispatch","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderDispatched"}},"responseCodes":["202","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/dispatch","href":"merchantfulfillapi/dispatchorder","openApiOperationId":"dispatchOrder","summary":"Dispatch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/OrderDispatched","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderDispatched"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request has been accepted for processing."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1dispatch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantfulfillapi/dispatchorder"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/dispatch"},{"label":"Delivered","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantfulfillapi/orderdelivered","routeSlug":"/en/apis/opendelivery/merchantfulfillapi/orderdelivered","metadata":{"seo":{"title":"Delivered","description":"Informs  Keeta that the order has been delivered."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"orderDelivered","name":"Delivered","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1delivered/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delivered","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that the order has been delivered."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected to receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event after this action."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Important:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This endpoint is not mandatory and should be sent "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"only if the Ordering Application is able to receive this request and only in cases where the order logistics service is provided by the Merchant and not the Marketplace"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1delivered/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/delivered","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"responseCodes":["202","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/delivered","href":"merchantfulfillapi/orderdelivered","openApiOperationId":"orderDelivered","summary":"Delivered"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request has been accepted for processing."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1delivered/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantfulfillapi/orderdelivered"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/delivered"},{"label":"Send Delivery Updates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/apis/opendelivery/merchantfulfillapi/senddeliveryupdates","routeSlug":"/en/apis/opendelivery/merchantfulfillapi/senddeliveryupdates","metadata":{"seo":{"title":"Send Delivery Updates","description":"Sends information about the delivery in progress."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendDeliveryUpdates","name":"Send Delivery Updates","isWebhook":false,"pointer":"/paths/~1v1~1orders~1{orderId}~1tracking/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send Delivery Updates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sends information about the delivery in progress."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This endpoint should be used when the delivery is the responsibility of the Merchant, so the Software Service should send the delivery updates to the Ordering Application."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"HOST:"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"span","attrs":{"style":{"textDecoration":"underline","color":"#26323880","fontSize":"13.006px"}}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DIRECTION:"},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"name":"div","attrs":{"align":"center"}},"children":[{"$$mdtype":"Node","attributes":{"name":"img","attrs":{"src":"https://abrasel-nacional.github.io/opendelivery/images/directionPOSTSS_OA.png"}},"children":[],"type":"tag","tag":"html"}],"type":"tag","tag":"html"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":["od.all"],"type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"name":"Sig","scopes":[],"type":"apiKey","in":"header","paramName":"X-App-Signature","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderId","in":"path","schemaId":"schema_18","required":true}],"pointer":"/paths/~1v1~1orders~1{orderId}~1tracking/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderTracking"}},"schemaId":"components/schemas/OrderTracking","pointer":"/paths/~1v1~1orders~1{orderId}~1tracking/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/orders/{orderId}/tracking","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"parameters":{"path":[{"name":"orderId","in":"path","required":true,"schemaId":"schema_18"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},{"id":"Sig","type":"apiKey","name":"X-App-Signature","in":"header"}],"scopes":["od.all"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderTracking"}},"responseCodes":["202","400","401","403","404","422","503"],"pointer":"/v1/orders/{orderId}/tracking","href":"merchantfulfillapi/senddeliveryupdates","openApiOperationId":"sendDeliveryUpdates","summary":"Send Delivery Updates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"schemaId":"components/schemas/OrderTracking","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderTracking"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Request has been accepted for processing."},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Request lacks valid authentication credentials for the target resource","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Authenticated participant request that violates some authorization rule.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"The requested resource was not found.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. (Check if the instruction has not been sent before.)","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"503","description":"Service is not currently available. Requested service may be under maintenance or outside the operating window.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1v1~1orders~1{orderId}~1tracking/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}},{"code":"503","schemaId":"components/schemas/Error","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchantfulfillapi/senddeliveryupdates"}],"panels":[]}]},"httpPath":"/v1/orders/{orderId}/tracking"}],"content":{"contentType":"group","meta":{"name":"merchantFulfillAPI"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order-Merchant Fulfill API","showPageActions":true},{"nodeType":"markdoc","content":" "}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/orders/{orderId}/dispatch","summary":"Dispatch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchantfulfillapi/dispatchorder","deprecated":false},{"title":"/v1/orders/{orderId}/delivered","summary":"Delivered","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchantfulfillapi/orderdelivered","deprecated":false},{"title":"/v1/orders/{orderId}/tracking","summary":"Send Delivery Updates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchantfulfillapi/senddeliveryupdates","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ClientCredentialsRequest":{"id":"components/schemas/ClientCredentialsRequest","kind":"json-schema","title":"ClientCredentialsRequest","data":{"type":"object","required":["client_id","grant_type","client_secret"],"properties":{"client_id":{"type":"string","description":"Client identifier provided by Keeta."},"grant_type":{"type":"string","description":"The OAuth grant type.","enum":["app_level_token"]},"client_secret":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Client Secret provided by Keeta.(When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = app_level_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this field needs to be filled in)"},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/TokenResponseClientCredentials":{"id":"components/schemas/TokenResponseClientCredentials","kind":"json-schema","title":"TokenResponseClientCredentials","data":{"type":"object","properties":{"access_token":{"type":"string","description":"A code representing the access token."},"token_type":{"type":"string","example":"bearer","description":"The token type. Currently, the only supported type is bearer."},"expires_in":{"type":"integer","description":"The token expiration time in seconds"}},"required":["access_token","token_type"]}},"components/schemas/TokenResponseWithRefreshToken":{"id":"components/schemas/TokenResponseWithRefreshToken","kind":"json-schema","title":"TokenResponseWithRefreshToken","data":{"allOf":[{"$ref":"#/components/schemas/TokenResponseClientCredentials"},{"type":"object","required":["refresh_token"],"properties":{"refresh_token":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A code representing the refresh token."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Condition:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This field will be returned when the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"shop_level_authorization_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refresh_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"When the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"app_level_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the response does not contain this field."},"children":[],"type":"text"}],"type":"paragraph"}]}}}]}},"components/schemas/ShopLevelAuthorizationCodeRequest":{"id":"components/schemas/ShopLevelAuthorizationCodeRequest","kind":"json-schema","title":"ShopLevelAuthorizationCodeRequest","data":{"type":"object","required":["client_id","grant_type","authorization_code"],"properties":{"client_id":{"type":"string","description":"Client identifier provided by Keeta."},"grant_type":{"type":"string","description":"The OAuth grant type.","enum":["shop_level_authorization_code"]},"authorization_code":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = shop_level_authorization_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this field needs to be filled in"},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/RefreshTokenRequest":{"id":"components/schemas/RefreshTokenRequest","kind":"json-schema","title":"RefreshTokenRequest","data":{"type":"object","required":["client_id","grant_type","refresh_token"],"properties":{"client_id":{"type":"string","description":"Client identifier provided by Keeta."},"grant_type":{"type":"string","description":"The OAuth grant type.","enum":["refresh_token"]},"refresh_token":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = refresh_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this field needs to be filled in"},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/VersionOrderingApp":{"id":"components/schemas/VersionOrderingApp","kind":"json-schema","title":"VersionOrderingApp","data":{"type":"object","properties":{"merchant":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information regarding the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant's"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" standard endpoints."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"version":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Current version for MERCHANT endpoints."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Existing MERCHANT routes:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/merchantUpdate\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"GET /v1/merchantStatus\""},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"type":"blockquote"}],"enum":["1.0.0","1.0.1","1.1.0","1.1.1","1.2.0","1.2.1","1.3.0","1.3.1","1.4.0","1.5.0"]}}},"order":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information regarding the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Order's"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" standard endpoints."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"version":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Current version for ORDER endpoints."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Existing ORDER routes:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"GET /v1/events:polling\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/events/acknowledgment\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"GET /v1/orders/{orderId}\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/confirm\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/preparing\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/readyForPickup\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/pickedUp\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/dispatch\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/delivered\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/requestCancellation\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/acceptCancellation\""},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"\"POST /v1/orders/{orderId}/denyCancellation\""},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"type":"blockquote"}],"enum":["1.0.0","1.0.1","1.1.0","1.1.1","1.2.0","1.2.1","1.3.0","1.3.1","1.4.0","1.5.0"]},"availableEventsMethods":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lists which methods for obtaining new order events the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can use with this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","enum":["POLLING","WEBHOOK"]}}}}}}},"components/schemas/VersionMerchant":{"id":"components/schemas/VersionMerchant","kind":"json-schema","title":"VersionMerchant","data":{"type":"object","properties":{"merchantEndpoint":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Current version for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["1.0.0","1.0.1","1.1.0","1.1.1","1.2.0","1.2.1"]},"ordersWebhook":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Current version for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"/v1/orderUpdate"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" webhook."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["1.0.0","1.0.1","1.1.0","1.1.1","1.2.0","1.2.1"]}}}},"components/schemas/CommonResponse":{"id":"components/schemas/CommonResponse","kind":"json-schema","title":"CommonResponse","data":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","description":"Response Code"},"title":{"type":"string","description":"Response Message"}}}},"components/schemas/OrderEventPollingResponse":{"id":"components/schemas/OrderEventPollingResponse","kind":"json-schema","title":"OrderEventPollingResponse","data":{"type":"array","items":{"$ref":"#/components/schemas/Event"},"maxItems":1000,"description":"Response Message"}},"components/schemas/TokenRequest":{"id":"components/schemas/TokenRequest","kind":"json-schema","title":"TokenRequest","data":{"type":"object","title":"TokenRequest","required":["client_id","client_secret","grant_type"],"properties":{"client_id":{"type":"string","description":"Client identifier provided by Keeta."},"client_secret":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Client Secret provided by Keeta.(When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = app_level_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this field needs to be filled in)"},"children":[],"type":"text"}],"type":"paragraph"}]},"grant_type":{"type":"string","enum":["app_level_token","shop_level_authorization_code","refresh_token"],"description":"The OAuth grant type."},"authorization_code":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = shop_level_authorization_code"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this field needs to be filled in"},"children":[],"type":"text"}],"type":"paragraph"}]},"refresh_token":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"grant_type = refresh_token"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this field needs to be filled in"},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/TokenResponse":{"id":"components/schemas/TokenResponse","kind":"json-schema","title":"TokenResponse","data":{"type":"object","title":"TokenResponse","required":["access_token","token_type"],"properties":{"access_token":{"type":"string","description":"A code representing the access token."},"token_type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The token type. Currently, the only supported type is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"bearer"},"children":[],"type":"code"}],"type":"paragraph"}],"enum":["bearer"]},"expires_in":{"type":"number","format":"Long","example":21600,"description":"The token expiration time in seconds"},"refresh_token":{"type":"string","description":"A code representing the refresh token."}}}},"components/schemas/Merchant":{"id":"components/schemas/Merchant","kind":"json-schema","title":"MenuEntity","data":{"type":"object","title":"MenuEntity","required":["id","status","basicInfo","services","items","menus","categories","itemOffers"],"properties":{"lastUpdate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The last modified date and time in ISO timestamp format but with type String."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This should be used in conjuction of the TTL field to update the information on the ordering aplication."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info).\""},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"2021-05-27T20:45:10.332Z"},"TTL":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Time to Live (in seconds)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Min: 500"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Max: 86400"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A new request must be done when the TTL expires."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":500},"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"status":{"type":"string","description":"Indicates if the Merchant is Available or Unavailable. Only use this type when you must close (disable) the merchant due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays).","enum":["AVAILABLE","UNAVAILABLE"],"example":"AVAILABLE"},"basicInfo":{"type":"object","description":"A required entity to implement. Describes basic info of a merchant.","allOf":[{"$ref":"#/components/schemas/BasicInfo"}]},"services":{"type":"array","description":"A required entity to implement. Describes food ordering services details for a merchant.","items":{"$ref":"#/components/schemas/Service"}},"menus":{"type":"array","description":"A required entity to implement. Describes an array of menus.","items":{"$ref":"#/components/schemas/Menu"}},"categories":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of sections in the menu where "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffers"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be showed."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","$ref":"#/components/schemas/Category"}},"itemOffers":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of offers for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Items"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","$ref":"#/components/schemas/ItemOffer"}},"items":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of items. To be used with an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"$ref":"#/components/schemas/Item"}},"optionGroups":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An optional entity to implement. Describes additional options of an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"$ref":"#/components/schemas/OptionGroup"}},"availabilities":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An optional entity to implement. Describes the time period during which a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity is served."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Our current menu model supports the following options for configuring product availability:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"     1. Specific date ranges defined by the startDate and endDate fields"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"     2. A weekly schedule defined by the hours array"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Combination of 1 and 2 are not supported."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/Availability"}]}}}}},"components/schemas/MerchantStatus":{"id":"components/schemas/MerchantStatus","kind":"json-schema","title":"MenuEntity","data":{"type":"object","title":"MenuEntity","required":["status","services","merchantSourceAppId","Service","ServiceHour","Week Hour","Time Periods"],"properties":{"status":{"type":"string","description":"Indicates if the Merchant is Avaliable or Unavaliable. Only use this type when you must close (disable) the merchant due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays).","enum":["AVAILABLE","UNAVAILABLE"],"example":"AVAILABLE"},"services":{"type":"array","description":"Stores the business information of the store, used to set the business hours and special business hours for the business days of this store."},"merchantSourceAppId":{"type":"string","description":"Keeta internal store ID, identifying the source of Keetapp.","example":"Keeta"},"Service":{"type":"object","description":"Stores the business information of the store, used to set the business hours and special business hours for the business days of this store.","allOf":[{"$ref":"#/components/schemas/MerchantService"}]},"ServiceHour":{"type":"object","description":"A required entity to implement. Describes an array of menus.","allOf":[{"$ref":"#/components/schemas/ServiceHour"}]},"Week Hour":{"type":"array","description":"A list of the day(s) of the week and time periods for which the service is valid.","items":{"type":"object","$ref":"#/components/schemas/HourObject"}},"Holiday Hours":{"type":"array","description":"Map of holiday dates, each with optional timePeriods. If a date does not have a time period specified, the restaurant will be closed for that date.","items":{"type":"object","$ref":"#/components/schemas/HolidayHoursObject"}},"Time Periods":{"type":"array","description":"hours object.","items":{"type":"object","$ref":"#/components/schemas/TimePeriodsObject"}}}}},"components/schemas/UpdateMerchant":{"id":"components/schemas/UpdateMerchant","kind":"json-schema","title":"UpdateMerchant","data":{"type":"object","required":["id","status","basicInfo","services","items","menus","categories","itemOffers"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100},"status":{"type":"string","description":"Indicates if the Merchant is Available or Unavailable. Only use this type when you must close (disable) the merchant due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays).","enum":["AVAILABLE","UNAVAILABLE"],"example":"AVAILABLE"},"basicInfo":{"type":"object","description":"A required entity to implement. Describes basic info of a merchant.","allOf":[{"$ref":"#/components/schemas/BasicInfo"}]},"services":{"type":"array","description":"A required entity to implement. Describes food ordering services details for a merchant.","items":{"$ref":"#/components/schemas/Service"}},"menus":{"type":"array","description":"A required entity to implement. Describes an array of menus.","items":{"$ref":"#/components/schemas/Menu"}},"categories":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of sections in the menu where "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffers"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be showed."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","$ref":"#/components/schemas/Category"}},"itemOffers":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of offers for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Items"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","$ref":"#/components/schemas/ItemOffer"}},"items":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of items. To be used with an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"$ref":"#/components/schemas/Item"}},"optionGroups":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An optional entity to implement. Describes additional options of an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"$ref":"#/components/schemas/OptionGroup"}},"availabilities":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An optional entity to implement. Describes the time period during which a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity is served."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Our current menu model supports the following options for configuring product availability:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"     1. Specific date ranges defined by the startDate and endDate fields"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"     2. A weekly schedule defined by the hours array"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Combination of 1 and 2 are not supported."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/Availability"}]}}}}},"components/schemas/MerchantDescription":{"id":"components/schemas/MerchantDescription","kind":"json-schema","title":"MenuEntity","data":{"type":"object","title":"MenuEntity","required":["id","status","basicInfo","services","items","menus","categories","itemOffers"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. `"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the company responsible for the merchant's menu and have to be informed in the Order object by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"}],"type":"em"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"status":{"type":"string","description":"Indicates if the entity is Available or Unavailable. Only use this type when you must disable the entity due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays).","enum":["AVAILABLE","UNAVAILABLE"]},"basicInfo":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/BasicInfo"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"BasicInfo"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes basic info of a merchant."},"children":[],"type":"text"}],"type":"paragraph"}]},"services":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/Service"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Service"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes food ordering services details for a merchant."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object"}},"menus":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/Menu"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Menu"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of menus."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object"}},"items":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/Menu/Item"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of items. To be used with an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OptionGroups"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object"}},"categories":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/Menu/Category"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of sections in the menu where "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffers"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be showed."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object"}},"itemOffers":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/Menu/ItemOffer"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffers"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A required entity to implement. Describes an array of offers for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Items"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object"}},"optionGroups":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/Menu/OptionGroup-and-Option"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Options"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An optional entity to implement. Describes additional options of an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object"}},"availabilities":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"See: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/Menu/Availability"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An optional entity to implement. Describes the time period during which a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity is served."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object"}}}}},"components/schemas/MerchantService":{"id":"components/schemas/MerchantService","kind":"json-schema","title":"Service","data":{"type":"object","title":"Service","required":["serviceType","serviceHours"],"properties":{"id":{"type":"string","description":"This id is always null because it is derived from the software service provider."},"serviceType":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The type of service being offered("},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta only supports DELIVERY"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"):"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - for orders that will be delivered to the customer's address."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TAKEOUT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - orders that will be picked up at the establishment by the customer"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"INDOOR"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - orders that will be consumed inside the establishment."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["DELIVERY","TAKEOUT","INDOOR"],"example":"DELIVERY"},"serviceHours":{"type":"object","description":"A required entity to implement. Describes the time window which users can place orders","properties":{"weekHours":{"type":"object","description":"A list of the day(s) of the week and time periods for which the service is valid.","properties":{"dayOfWeek":{"type":"string","description":"Day of the week for which these service hours are valid.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":["MONDAY","TUESDAY"]},"timePeriods":{"type":"string","description":"The time when users can place orders; please refer to the Time Periods Object for details."}}},"holidayHours":{"type":"object","description":"Map of holiday dates, each with optional timePeriods. If a date does not have a time period specified, the restaurant will be closed for that date.","properties":{"date":{"type":"string","description":"date in UTC (RFC3339 format, e.g. 2021-07-04).","example":"2021-12-25"},"timePeriods":{"type":"object","description":"The time when users can place orders; please refer to the Time Periods Object for details.","properties":{"startTime":{"type":"string","description":"Convert the time zone of the secondary city where the Keeta store is located to UTC-0; this value is UTC-0.","example":"09:00:00"},"endTime":{"type":"string","description":"Convert the time zone of the secondary city where the Keeta store is located to UTC-0; this value is UTC-0.","example":"18:00:00"}}}}}}}}}},"components/schemas/ServiceHour":{"id":"components/schemas/ServiceHour","kind":"json-schema","title":"ServiceHour","data":{"type":"object","required":["id","weekHours","holidayHours"],"properties":{"weekHours":{"type":"array","description":"Map of holiday dates, each with optional timePeriods. If a date does not have a time period specified, the restaurant will be closed for that date."},"holidayHours":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For special date time periods, the service will be closed if no specific time period is designated"},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":".Map of holiday dates, each with optional timePeriods. If a date does not have a time period specified, the restaurant will be closed for that date."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/HourObject":{"id":"components/schemas/HourObject","kind":"json-schema","title":"HourObject","data":{"type":"object","required":["dayOfWeek","timePeriods"],"properties":{"dayOfWeek":{"type":"string","description":"Day of the week for which these service hours are valid.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"example":["MONDAY","TUESDAY"]},"timePeriods":{"type":"object","description":"The time when users can place orders; please refer to the Time Periods Object for details."}}}},"components/schemas/HolidayHoursObject":{"id":"components/schemas/HolidayHoursObject","kind":"json-schema","title":"HolidayHoursObject","data":{"type":"object","properties":{"date":{"type":"string","description":"date in UTC (RFC3339 format, e.g. 2021-07-04).","example":"2021-12-25"},"timePeriods":{"type":"object","description":"The time when users can place orders; please refer to the Time Periods Object for details."}}}},"components/schemas/TimePeriodsObject":{"id":"components/schemas/TimePeriodsObject","kind":"json-schema","title":"TimePeriodsObject","data":{"type":"object","required":["startTime","endTime"],"properties":{"startTime":{"type":"string","description":"Convert the time zone of the secondary city where the Keeta store is located to UTC-0; this value is UTC-0.","example":"09:00:00"},"endTime":{"type":"string","description":"Convert the time zone of the secondary city where the Keeta store is located to UTC-0; this value is UTC-0.","example":"18:00:00"}}}},"components/schemas/BasicInfo":{"id":"components/schemas/BasicInfo","kind":"json-schema","title":"BasicInfo","data":{"type":"object","title":"BasicInfo","required":["contactEmails","contactPhones"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Public Name"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"maxLength":500,"example":"Pizza Plaza"},"document":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Document"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"pattern":"^\\d{14}$","example":"22815773000169"},"corporateName":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Corporate Name"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"maxLength":500,"example":"Food Company"},"description":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Description"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"Food company specializing in pizzas."},"averageTicket":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Average Ticket. Can be used to show the price range of items available at the merchant. It is not mandatory, but recommended to be used."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":90},"averagePreparationTime":{"type":"number","format":"double","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Average amount of time preparing an order takes, in minutes."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":20},"minOrderValue":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Minimum order value that the merchant accepts."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"merchantType":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Type.Currently, only "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RESTAURANT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is accepted."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["RESTAURANT"],"example":"RESTAURANT"},"merchantCategories":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Categories"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"string","enum":["BURGERS","PIZZA","FAST_FOOD","HOT_DOG","JAPANESE","DESSERTS","AMERICAN","ICE_CREAM","BBQ","SANDWICH","MEXICAN","BRAZILIAN","PASTRY","ARABIAN","COMFORT_FOOD","VEGETARIAN","VEGAN","BAKERY","HEALTHY","ITALIAN","CHINESE","JUICE_SMOOTHIES","SEAFOOD","CAFE","SALADS","COFFEE_TEA","PASTA","BREAKFAST_BRUNCH","LATIN_AMERICAN","CONVENIENCE","PUB","HAWAIIAN","EUROPEAN","FAMILY_MEALS","FRENCH","INDIAN","PORTUGUESE","SPANISH","GOURMET","KIDS_FRIENDLY","SOUTH_AMERICAN","SPECIALTY_FOODS","ARGENTINIAN","PREMIUM","AFFORDABLE_MEALS"]},"example":["PIZZA","FAMILY_MEALS","PREMIUM"]},"address":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Address"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/Address"}]},"contactEmails":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Contact Emails. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Only supports up to 3"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string"},"example":["food@company.com"]},"contactPhones":{"type":"object","description":"Merchant Contact Phones.","allOf":[{"$ref":"#/components/schemas/ContactPhones"}]},"logoImage":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Image to be used as the merchant logo."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/Image"}]},"bannerImage":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Image to be used as the merchant banner (the banner display depends on the client application interface)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/Image"}]},"createdAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant creation date and time. \\n\\n(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}]},"acceptedCards":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates which card brands are accepted by the merchant."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"string","enum":["VISA","MASTERCARD","DINERS","AMEX","HIPERCARD","ELO","AURA","DISCOVER","VR_BENEFICIOS","SODEXO","TICKET","GOOD_CARD","BANESCARD","SOROCARD","POLICARD","VALECARD","AGICARD","JCB","CREDSYSTEM","CABAL","GREEN_CARD","VEROCHEQUE","AVISTA","OTHER"]}}}}},"components/schemas/Service":{"id":"components/schemas/Service","kind":"json-schema","title":"Service","data":{"type":"object","title":"Service","required":["id","serviceType","menuId","serviceHours"],"properties":{"id":{"type":"string","description":"Unique Identifier","example":"f078e8e2-3044-4eec-b4a8-8359810de123"},"status":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates if the entity is Avaliable or Unavaliable. Only use this type when you must disable the entity due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["AVAILABLE","UNAVAILABLE"],"example":"AVAILABLE"},"serviceType":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The type of service being offered:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - for orders that will be delivered to the customer's address."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TAKEOUT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - orders that will be picked up at the establishment by the customer"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"INDOOR"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - orders that will be consumed inside the establishment."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["DELIVERY","TAKEOUT","INDOOR"],"example":"DELIVERY"},"serviceTiming":{"type":"object","title":"Service Timing","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information regarding the accepted service times."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"properties":{"timing":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the timings that the service accepts:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"INSTANT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": for orders that must be prepared immediately."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SCHEDULED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": for orders scheduled for a specific date and time."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ONDEMAND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": for orders that will only be delivered when the consumer indicates that they are going to pick it up."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please inform all accepted types in the field."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If not informed, defaults to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"INSTANT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" option."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","enum":["INSTANT","SCHEDULED","ONDEMAND"]},"default":["INSTANT"],"example":["INSTANT","SCHEDULED"]},"schedule":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information regarding the time windows for scheduling."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This only applies to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SCHEDULED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" service timing."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["scheduleTimeWindow","scheduleStartWindow","scheduleEndWindow"],"properties":{"scheduleTimeWindow":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Time window where scheduling will be possible."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: If "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"15_MINUTES"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is chosen, then the available scheduling times will be displayed every 15 minutes (e.g. 9:15, 9:30, 9:45, 10:00)."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["15_MINUTES","30_MINUTES","45_MINUTES","60_MINUTES","90_MINUTES","120_MINUTES"]},"scheduleStartWindow":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs how long after the merchant has opened (considering the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"serviceHours"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity) the first schedule time will be displayed."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: Service starts at 9:00 and the option "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"45_MINUTES"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" was entered, then the first available time for scheduling will be 9:45."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["15_MINUTES","30_MINUTES","45_MINUTES","60_MINUTES","90_MINUTES","120_MINUTES"]},"scheduleEndWindow":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs how long before the merchant closes (considering the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"serviceHours"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity) the last schedule time will be displayed."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: Service ends at 23:00 and the option "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"60_MINUTES"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" was entered, then the last available time for scheduling will be 22:00."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["15_MINUTES","30_MINUTES","45_MINUTES","60_MINUTES","90_MINUTES","120_MINUTES"]}}}}},"servicePriority":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates to the Ordering Application whether the merchant works with different order preparation and delivery priorities."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Must enter up to how many priority levels the merchant serves."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If not entered, it means that the merchant does not have any specific configuration for working with priority, and may or may not be able to do so."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"string","enum":["PRIORITY1","PRIORITY2","PRIORITY3","PRIORITY4","PRIORITY5"]},"example":["PRIORITY1","PRIORITY2"]},"menuId":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The id value of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Menu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity correlated to this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"f627ccdc-6789-456f-a782-148538d5035b"},"targetAppId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field is for situations in which the merchant needs to send different menus for the same "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"serviceType"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to different Ordering Applications (this can occur when there is an integration software between the merchant software and the Ordering Application). In this case this field must be filled in with the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"AppId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" of the OrderingApplication which will receive this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" info."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}]},"serviceArea":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A conditional entity to implement (required if the Service entity associated has serviceType set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"). Describes the geographical region in which food can be delivered."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/ServiceArea"}]},"serviceHours":{"type":"object","description":"A required entity to implement. Describes the time window which users can place orders.","allOf":[{"$ref":"#/components/schemas/ServiceHours"}]}}}},"components/schemas/ServiceArea":{"id":"components/schemas/ServiceArea","kind":"json-schema","title":"Service Area","data":{"type":"object","title":"Service Area","required":["id"],"properties":{"id":{"type":"string","description":"A unique identifier of the service area.","example":"01339e6d-520b-429e-bc7c-dcfd2df42278"},"polygon":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"polygon"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is chosen to be used, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"geoRadius"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not required."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A polygon or multipolygon expressed as a series of three or more space delimited points."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"allOf":[{"$ref":"#/components/schemas/Polygon"}]}},"geoRadius":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"geoRadius"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is chosen to be used, "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"polygon"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not required. Indicates the approximate radius (in meters) of the CIRCLE area."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/GeoRadius"}]},"exclusionAreaPolygon":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This object will act as a complement, indicating specific polygons within the previously mapped delivery area, where NO deliveries will be made."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field can be filled in regardless of whether "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"polygon"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"geoRadius"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is used."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"allOf":[{"$ref":"#/components/schemas/ExclusionPolygon"}]}}}}},"components/schemas/Polygon":{"id":"components/schemas/Polygon","kind":"json-schema","title":"Polygon","data":{"type":"object","title":"Polygon","required":["geoCoordinates"],"properties":{"geoCoordinates":{"type":"array","description":"Coordinates of each point of the polygon. It is recommended that the first and last points be the same, but it is not required.\n\n\n\nEach point in a polygon or multipolygon is defined by a latitude point followed by a longitude point. You also must specify the points in a counter-clockwise direction.","items":{"type":"object","title":"geoCoordinate","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the latitude coordinate of the polygon point."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the longitude coordinate of the polygon point."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638}}}},"price":{"type":"object","description":"Price of the fee for this polygon","allOf":[{"$ref":"#/components/schemas/Price"}],"example":{"value":5,"currency":"BRL"}},"estimateDeliveryTime":{"type":"integer","description":"Estimate delivery time for this polygon in minutes"}}}},"components/schemas/GeoRadius":{"id":"components/schemas/GeoRadius","kind":"json-schema","title":"GeoRadius","data":{"type":"object","title":"GeoRadius","required":["geoMidpointLatitude","geoMidpointLongitude","radius"],"properties":{"geoMidpointLatitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the latitude coordinate at the center of the CIRCLE area."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"geoMidpointLongitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the longitude coordinate at the center of the CIRCLE area."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638},"radius":{"type":"array","description":"Informations about each radius of the CIRCLE that the merchant serves.","items":{"type":"object","title":"radius","required":["size"],"properties":{"size":{"type":"integer","description":"The size of the CIRCLE radius in meters."},"price":{"type":"object","description":"Price of the fee for this CIRCLE size.","allOf":[{"$ref":"#/components/schemas/Price"}],"example":{"value":5,"currency":"BRL"}},"estimateDeliveryTime":{"type":"integer","description":"Estimate delivery time for this CIRCLE size in minutes."}}}}}}},"components/schemas/ExclusionPolygon":{"id":"components/schemas/ExclusionPolygon","kind":"json-schema","title":"Polygon","data":{"type":"object","title":"Polygon","required":["geoCoordinates"],"properties":{"geoCoordinates":{"type":"array","description":"Coordinates of each point of the polygon. It is recommended that the first and last points be the same, but it is not required.\n\n\n\nEach point in a polygon or multipolygon is defined by a latitude point followed by a longitude point. You also must specify the points in a counter-clockwise direction.","items":{"type":"object","title":"geoCoordinate","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the latitude coordinate of the polygon point."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the longitude coordinate of the polygon point."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638}}}}}}},"components/schemas/Catalog":{"id":"components/schemas/Catalog","kind":"json-schema","title":"Catalog","data":{"type":"object","title":"Catalog","required":["id"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Menu"},"children":[],"type":"code"}],"type":"paragraph"}],"example":"f078e8e2-3044-4eec-b4a8-8359810de123"}}}},"components/schemas/ItemPrice":{"id":"components/schemas/ItemPrice","kind":"json-schema","title":"Item Price","data":{"type":"object","title":"Item Price","required":["originalValue"],"properties":{"value":{"type":"number","format":"decimal","description":"The actual price value. 4 decimals places are accepted. ","example":50},"originalValue":{"type":"number","format":"decimal","description":"The orginal price value. 4 decimals places are accepted","example":50},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The 3-letter ISO 4217 currency code."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not use this field as the currency unit and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"BRL"}}}},"components/schemas/ServiceHours":{"id":"components/schemas/ServiceHours","kind":"json-schema","title":"Service Hours","data":{"type":"object","title":"Service Hours","required":["id","weekHours"],"properties":{"id":{"type":"string","description":"A unique identifier of the service hours.","example":"fb093d8c-2ca5-40fb-afcf-472fbdae81cc"},"weekHours":{"type":"array","description":"A list of the day(s) of the week and time periods for which the service is valid.","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/Hours"}]}},"holidayHours":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Map of holiday dates, each with optional "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"timePeriods"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". If a date does not have a time period specified, the restaurant will be closed for that date."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","allOf":[{"$ref":"#/components/schemas/HolidayHours"}]}}}}},"components/schemas/Hours":{"id":"components/schemas/Hours","kind":"json-schema","title":"Hours","data":{"type":"object","title":"Hours","required":["dayOfWeek","timePeriods"],"properties":{"dayOfWeek":{"type":"array","description":"Day of the week for which these service hours are valid","items":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"example":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"timePeriods":{"type":"object","description":"Time window from which users' orders can be placed.","allOf":[{"$ref":"#/components/schemas/TimePeriods"}]}}}},"components/schemas/TimePeriods":{"id":"components/schemas/TimePeriods","kind":"json-schema","title":"Time Periods","data":{"type":"object","title":"Time Periods","required":["startTime","endTime"],"properties":{"startTime":{"type":"string","format":"time","description":"Indicates the specific time of day in ISO format starting from which users' orders can be placed.","example":"10:00:00.000Z"},"endTime":{"type":"string","format":"time","description":"Indicates the specific time of day in ISO format beyond which users' orders cannot be placed.","example":"18:00:00.000Z"}}}},"components/schemas/HolidayHours":{"id":"components/schemas/HolidayHours","kind":"json-schema","title":"Holiday Hours","data":{"type":"object","title":"Holiday Hours","required":["date","timePeriods"],"properties":{"date":{"type":"string","format":"date","description":"date","example":"2021-04-07"},"timePeriods":{"type":"object","description":"hours","allOf":[{"$ref":"#/components/schemas/TimePeriods"}]}}}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"type":"object","title":"Item","required":["id","name","externalCode","status"],"properties":{"id":{"type":"string","description":"A unique identifier of the item.","example":"732bd31e-77fc-47ee-88ee-a0437f97b198"},"name":{"type":"string","description":"Item name","maxLength":150,"example":"1/2 Pepperoni"},"description":{"type":"string","description":"Item Description","example":"Pepperoni flavored pizza with LOTS of pepperoni."},"externalCode":{"type":"string","description":"Item External Code. (Tipically the merchant Software Service item code)","example":"233467"},"status":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates if the entity is Available or Unavailable. Only use this type when you must disable the entity due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays). Default is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"AVAILABLE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["AVAILABLE","UNAVAILABLE"],"default":"AVAILABLE","example":"AVAILABLE"},"image":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Image of the item. This field should be used when there is only one image for the item without size variations."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"It must "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"be considered"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" only if the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"images"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" array "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"is empty"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"If "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"images"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"contains any value"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", this field must "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"be ignored"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" even if it is filled."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Image"}]},"images":{"type":"array","maxItems":2,"items":{"allOf":[{"$ref":"#/components/schemas/ImageWithType"}]},"description":"Array of images of the item. This field should be used when you need size variations for the images."},"nutritionalInfo":{"type":"object","description":"Nutrition information for the dish.","allOf":[{"$ref":"#/components/schemas/NutritionalInfo"}]},"serving":{"type":"integer","description":"Field to show the number of people the portion serves.","example":2},"unit":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item's Unit of Measurement."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Possible values:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"UN"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Unit"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"KG"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Kilogram (Keeta is not currently supported)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"L"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Liter (Keeta is not currently supported)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OZ"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Ounce (Keeta is not currently supported)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LB"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Pound (Keeta is not currently supported)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GAL"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Gallon (Keeta is not currently supported)"},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"enum":["UN","KG","L","OZ","LB","GAL"],"example":"KG"},"ean":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"EAN (European Article Number). "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"example":"7896005202074"}}}},"components/schemas/NutritionalInfo":{"id":"components/schemas/NutritionalInfo","kind":"json-schema","title":"Nutritional Info","data":{"type":"object","title":"Nutritional Info","required":["description","calories"],"properties":{"description":{"type":"string","description":"Nutrition information in free text. For example \"Contains preservatives\".","example":"Contains preservatives"},"calories":{"type":"string","description":"The number of calories in Cal, kcal, or kJ, using the following format: value Cal or min-max Cal","pattern":"^[0-9]+(\\.[0-9]+)? ?(- ?[0-9]+(\\.[0-9]+)?)? [a-zA-Z]+$","example":"2000 Cal"},"allergen":{"type":"array","description":"Allergens of this Item","items":{"type":"string","enum":["ALMONDS","ALPHA_ISOMETHYL_IONONE","ALCOHOL","AMYL_CINNAMAL","ANISE_ALCOHOL","BARLEY","BENZYL_ALCOHOL","BENZYL_BENZOATE","BENZYL_CINNAMATE","BENZYL_SALICYLATE","BRAZIL_NUTS","BUTYLPHENYL_METHYLPROPIONATE","CARROTS","CASHEW_NUTS","CELERY","CEREALS_CONTAINING_GLUTEN","CINNAMAL","CINNAMYL_ALCOHOL","CITRAL","CITRONELLOL","COCOA","CORIANDER","CORN","COUMARIN","CRUSTACEANS","EGGS","EUGENOL","EVERNIA_FURFURACEA","EVERNIA_PRUNASTRI","FARNESOL","FISH","GERANIOL","GLUTEN","HAZELNUTS","HEXYL_CINNAMAL","HYDROXYCITRONELLAL","KAMUT","LACTOSE","LUPINE","MACADAMIA_NUTS","METHYL_2_OCTYNOATE","MILK","MOLLUSCS","MUSTARD","NO_DECLARED_ALLERGENS","OAT","PEANUTS","PEAS","PECAN_NUTS","PISTACHIOS","POD_FRUITS","QUEENSLAND_NUTS","RYE","SESAME_SEEDS","SOYBEANS","SPELT","SULPHUR_DIOXIDE","TREE_NUTS","TREE_NUT_TRACES","WALNUTS","WHEAT"],"example":"GLUTEN"}},"additives":{"type":"array","description":"Additives of this Item","items":{"type":"string"}},"suitableDiet":{"type":"array","description":"The dish complies with the described dietary restriction","items":{"type":"string","enum":["DIABETIC","GLUTEN_FREE","HALAL","HINDU","KOSHER","LOW_CALORIE","LOW_FAT","LOW_LACTOSE","LOW_SALT","VEGAN","VEGETARIAN"]}},"isAlcoholic":{"type":"boolean","description":"Indicates if an item is alcoholic.","example":false}}}},"components/schemas/Menu":{"id":"components/schemas/Menu","kind":"json-schema","title":"Menu","data":{"type":"object","title":"Menu","required":["id","name","externalCode","categoryId"],"properties":{"id":{"type":"string","description":"A unique identifier of the menu.","example":"f627ccdc-6789-456f-a782-148538d5035b"},"name":{"type":"string","description":"Menu name","maxLength":500,"example":"Pizzas"},"description":{"type":"string","description":"Menu Description","example":"Pizza menu"},"externalCode":{"type":"string","description":"Menu External Code. (Tipically the merchant Software Service menu code)","example":"123"},"disclaimer":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Disclaimer."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"Lorem Ipsum is simply dummy text of the printing and typesetting industry."},"disclaimerURL":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Disclaimer URL."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"http://example.com"},"categoryId":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A list of the id values of the child "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entities that correspond to this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Menu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity. Default assumes all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entities are available in this menu."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string"},"example":["92fad022-2c28-4239-a026-989f5b555cb7","6bb71850-1d40-49f9-8046-b13e068c0cca"]}}}},"components/schemas/Category":{"id":"components/schemas/Category","kind":"json-schema","title":"Category","data":{"type":"object","title":"Category","required":["id","index","name","externalCode","status","itemOfferId"],"properties":{"id":{"type":"string","description":"A unique identifier of the category.","example":"92fad022-2c28-4239-a026-989f5b555cb7"},"index":{"type":"integer","description":"Category display index.","example":0},"name":{"type":"string","description":"Category name.","maxLength":150,"example":"Salted Pizza"},"description":{"type":"string","description":"Category description.","example":"Salted pizza flavors."},"image":{"type":"object","description":"Image of the category.","allOf":[{"$ref":"#/components/schemas/Image"}]},"externalCode":{"type":"string","description":"Category External Code. (Tipically the merchant Software Service category code)","example":"13"},"status":{"type":"string","description":"This parameter is currently not processed by Keeta.","enum":["AVAILABLE","UNAVAILABLE"],"example":"AVAILABLE"},"availabilityId":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The id values of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entities which provide details on when the category is available."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If not informed, assumes a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is AVAILABLE at all times."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"string","description":"A unique identifier of the availability.","example":"11d063c4-73a7-4f87-a0eb-71636cc02029"},"example":["11d063c4-73a7-4f87-a0eb-71636cc02029"]},"itemOfferId":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A list of the id values of the child "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entities that correspond to this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","description":"A unique identifier of the item offer.","example":"f080cfb3-5c4a-4eb7-907d-2de3bbb5dfb9"},"example":["f080cfb3-5c4a-4eb7-907d-2de3bbb5dfb9"]}}}},"components/schemas/ItemOffer":{"id":"components/schemas/ItemOffer","kind":"json-schema","title":"ItemOffer","data":{"type":"object","title":"ItemOffer","required":["id","itemId","index","status","price"],"properties":{"id":{"type":"string","description":"A unique identifier of the item offer.","example":"f080cfb3-5c4a-4eb7-907d-2de3bbb5dfb9"},"itemId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The id value of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity correlated to this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"732bd31e-77fc-47ee-88ee-a0437f97b198"},"index":{"type":"integer","description":"ItemOffer display index.","example":0},"status":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates if the entity is Available or Unavailable. Only use this type when you must disable the entity due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays). Default is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"AVAILABLE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["AVAILABLE","UNAVAILABLE"],"default":"AVAILABLE","example":"AVAILABLE"},"price":{"type":"object","description":"Price of the menu item offer. Original and actual values can be informed, for showing discounts.","allOf":[{"$ref":"#/components/schemas/ItemPrice"}],"example":{"value":43,"originalValue":43,"currency":"BRL"}},"availabilityId":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The id values of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entities which provide details on when the menu item offer is available."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If not informed, assumes an "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is AVAILABLE at all times."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"string","description":"A unique identifier of the availability.","example":"11d063c4-73a7-4f87-a0eb-71636cc02029"},"example":["11d063c4-73a7-4f87-a0eb-71636cc02029"]},"optionGroupsId":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A list of the id values of the child "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OptionGroup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entities that correspond to this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string","description":"A unique identifier of the option group.","example":"fe67e551-f42f-499a-8afb-0ed893c71fa3"},"example":["fe67e551-f42f-499a-8afb-0ed893c71fa3"]}}}},"components/schemas/OptionGroup":{"id":"components/schemas/OptionGroup","kind":"json-schema","title":"Option Group","data":{"type":"object","title":"Option Group","required":["id","index","name","externalCode","status","minPermitted","maxPermitted"],"properties":{"id":{"type":"string","description":"A unique identifier of the option group.","example":"fe67e551-f42f-499a-8afb-0ed893c71fa3"},"index":{"type":"integer","description":"Option Group display index.","example":0},"name":{"type":"string","description":"Option Group Name.","maxLength":150,"example":"Choose your salted pizza flavor"},"description":{"type":"string","description":"Option Group Description.","example":"Choose your salted pizza flavor."},"externalCode":{"type":"string","description":"Option External Code. (Tipically the merchant Software Service option group code)","example":"12"},"status":{"type":"string","description":"Indicates if the entity is Available or Unavailable. Only use this type when you must disable the entity due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays).","enum":["AVAILABLE","UNAVAILABLE"],"example":"AVAILABLE"},"minPermitted":{"type":"integer","description":"The minimum number of options which should be selected in the option group.","example":2},"maxPermitted":{"type":"integer","description":"The maximum number of options which should be selected in the option group.","example":2},"priceMethod":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instructions on how this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" should be calculated before being applied to the item."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"- SUM"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": It will be added to the other optionGroups without any additional rules. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Default"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" option."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"- MAX"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The highest "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" value between all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroups"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"priceMethod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"MAX"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be applied to the calculation."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"- AVG"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The average between "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"priceMethod"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"AVG"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be applied to the calculation."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"item base price: $25,00"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup1 - priceMethod = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AVG"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 1 = $5,00 (selected)"},"children":[],"type":"text"}],"type":"strong"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 2 = $10,00 (not selected)"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup2 - priceMethod = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AVG"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 1 = $7,00 (not selected)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 2 = $10,00 (selected)"},"children":[],"type":"text"}],"type":"strong"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup3 - priceMethod = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MAX"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 1 = $15,00 (selected)"},"children":[],"type":"text"}],"type":"strong"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 2 = $20,00 (not selected)"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup4 - priceMethod = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MAX"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 1 = $30,00 (not selected)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 2 = $35,00 (selected)"},"children":[],"type":"text"}],"type":"strong"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionGroup5 - priceMethod = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SUM"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 1 = $2,00 (not selected)"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"__"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 2 = $3,00 (selected)"},"children":[],"type":"text"}],"type":"strong"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"option 3 = $5,00 (not selected)"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionsPrice"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" = avg(optionGroup1, optionGroup2) + max(optionGroup3, optionGroup4) + optionGroup5"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionsPrice"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" = 7,50 + 35,00 + 3,00"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"optionPrice"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" = 45,50"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"itemPrice"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" = 25,00 + 45,50 = 70,50"},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["SUM","MAX","AVG"],"default":"SUM"},"options":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A list of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entities that correspond to this option group"},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","description":"options","allOf":[{"$ref":"#/components/schemas/Option"}]}}}}},"components/schemas/Option":{"id":"components/schemas/Option","kind":"json-schema","title":"Option","data":{"type":"object","title":"Option","required":["id","itemId","index","status"],"properties":{"id":{"type":"string","description":"A unique identifier of the option.","example":"e5232f14-430c-4a94-8ff6-289d5a16a87a"},"itemId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The id value of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity correlated to this "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"502ecf11-0509-48ed-b63c-6211c48fd9b9"},"index":{"type":"integer","description":"Option display index.","example":0},"status":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates if the entity is Available or Unavailable. Only use this type when you must disable the entity due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays). Default is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"AVAILABLE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["AVAILABLE","UNAVAILABLE"],"default":"AVAILABLE","example":"AVAILABLE"},"price":{"type":"object","description":"Price of the option. Original and actual values can be informed, for showing discounts.","allOf":[{"$ref":"#/components/schemas/ItemPrice"}]},"maxPermitted":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The maximum quantity of this option which can be selected in the option group. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"example":2}}}},"components/schemas/Availability":{"id":"components/schemas/Availability","kind":"json-schema","title":"Availability","data":{"type":"object","title":"Availability","required":["id","hours"],"properties":{"id":{"type":"string","description":"A unique identifier of the availability.","example":"11d063c4-73a7-4f87-a0eb-71636cc02029"},"startDate":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability start date. If not informed, the availabilty is already available"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"2021-05-01"},"endDate":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability end date. If not informed, the availabilty is always available."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"2021-05-30"},"hours":{"type":"array","description":"Hours","items":{"allOf":[{"$ref":"#/components/schemas/Hours"}]}}}}},"components/schemas/MerchantUpdate":{"id":"components/schemas/MerchantUpdate","kind":"json-schema","title":"MerchantUpdate","data":{"type":"object","discriminator":{"propertyName":"entityType","mapping":{"MERCHANT":"#/components/schemas/FullMerchantUpdate","BASIC_INFO":"#/components/schemas/BasicInfoUpdate","SERVICE":"#/components/schemas/ServiceUpdate","MENU":"#/components/schemas/MenuUpdate","CATEGORY":"#/components/schemas/CategoryUpdate","ITEM":"#/components/schemas/ItemUpdate","ITEM_OFFER":"#/components/schemas/ItemOfferUpdate","OPTION_GROUP":"#/components/schemas/OptionGroupUpdate","OPTION":"#/components/schemas/OptionUpdate","AVAILABILITY":"#/components/schemas/AvailabilityUpdate"}},"properties":{"merchantStatus":{"type":"string","description":"Indicates if the Merchant is Avaliable or Unavaliable. Only use this type when you must close (disable) the merchant due to an unexpected event and you don't know when the service will be re-established (e.g. do not use for holidays).","enum":["AVAILABLE","UNAVAILABLE"],"example":"AVAILABLE"},"entityType":{"type":"string","description":"The entity type of the updated object."}}}},"components/schemas/FullMerchantUpdate":{"id":"components/schemas/FullMerchantUpdate","kind":"json-schema","title":"FullMerchantUpdate","data":{"description":"Updated Merchant Object","allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/UpdateMerchant"}]}}}}]}},"components/schemas/BasicInfoUpdate":{"id":"components/schemas/BasicInfoUpdate","kind":"json-schema","title":"BasicInfoUpdate","data":{"description":"Updated Service Object","allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Only the first one in the array will be used."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BasicInfo"}]}}}}]}},"components/schemas/ServiceUpdate":{"id":"components/schemas/ServiceUpdate","kind":"json-schema","title":"ServiceUpdate","data":{"description":"Updated Service Object","allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When updating merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"serviceHours"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" info, only entities with serviceType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be used."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Service"}]}}}}]}},"components/schemas/MenuUpdate":{"id":"components/schemas/MenuUpdate","kind":"json-schema","title":"MenuUpdate","data":{"description":"Updated Menu Object","allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Menu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, Keeta does not support module-level information updates for merchant menus. Therefore,  Keeta will actively request the GET /merchant endpoint to obtain the full merchant information for update when receiving an update request with entityType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Menu"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":[{"$ref":"#/components/schemas/Menu"}]}}}]}},"components/schemas/CategoryUpdate":{"id":"components/schemas/CategoryUpdate","kind":"json-schema","title":"CategoryUpdate","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Object"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, Keeta does not support module-level information updates for merchant menus. Therefore,  Keeta will actively request the GET /merchant endpoint to obtain the full merchant information for update when receiving an update request with entityType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Category"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Category"}]}}}}]}},"components/schemas/ItemUpdate":{"id":"components/schemas/ItemUpdate","kind":"json-schema","title":"ItemUpdate","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Object"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, Keeta does not support module-level information updates for merchant menus. Therefore,  Keeta will actively request the GET /merchant endpoint to obtain the full merchant information for update when receiving an update request with entityType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Item"}]}}}}]}},"components/schemas/ItemOfferUpdate":{"id":"components/schemas/ItemOfferUpdate","kind":"json-schema","title":"ItemOfferUpdate","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Object"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ItemOffer"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, when receiving an update request with entityType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ITEM_OFFER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", Keeta will only update the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field, other fields are not yet supported for updating."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ItemOffer"}]}}}}]}},"components/schemas/OptionGroupUpdate":{"id":"components/schemas/OptionGroupUpdate","kind":"json-schema","title":"OptionGroupUpdate","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OptionGroup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Object"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OptionGroup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, Keeta does not support module-level information updates for merchant menus. Therefore,  Keeta will actively request the GET /merchant endpoint to obtain the full merchant information for update when receiving an update request with entityType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OptionGroup"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/OptionGroup"}]}}}}]}},"components/schemas/OptionUpdate":{"id":"components/schemas/OptionUpdate","kind":"json-schema","title":"OptionUpdate","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Object"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Option"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, when receiving an update request with entityType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OPTION"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", Keeta will only update the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"status"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field, other fields are not yet supported for updating."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Option"}]}}}}]}},"components/schemas/AvailabilityUpdate":{"id":"components/schemas/AvailabilityUpdate","kind":"json-schema","title":"AvailabilityUpdate","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Object"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MerchantUpdate"},{"type":"object","properties":{"updatedObjects":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Updated "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entity objects."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Our current menu model supports the following options for configuring product availability:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"     1. Specific date ranges defined by the startDate and endDate fields"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"     2. A weekly schedule defined by the hours array"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Combination of 1 and 2 are not supported."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Currently, Keeta does not support module-level information updates for merchant menus. Therefore,  Keeta will actively request the GET /merchant endpoint to obtain the full merchant information for update when receiving an update request with entityType="},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Availability"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Availability"}]}}}}]}},"components/schemas/AckEvents":{"id":"components/schemas/AckEvents","kind":"json-schema","title":"Ack Events","data":{"type":"object","title":"Ack Events","required":["id","orderId","eventType"],"properties":{"id":{"type":"string","description":"A unique identifier of the event."},"orderId":{"type":"string","description":"The unique identifier of the order. The order ID is generated by Keeta."},"eventType":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The event type. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/pollingEvents"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Click here"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for definitions of each type."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["CREATED","CONFIRMED","DISPATCHED","READY_FOR_PICKUP","PICKED_UP","DELIVERED","CONCLUDED","CANCELLATION_REQUESTED","CANCELLED","USER_REFUND_REQUEST","REFUNDED","REFUND_FAILED","RECOMMENDED_PREPARATION_START"]}}}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"type":"object","title":"Order","required":["id","type","displayId","createdAt","orderTiming","preparationStartDateTime","merchant","items","total","payments"],"properties":{"id":{"type":"string","description":"The unique identifier of the order. The order ID is generated by Keeta."},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - for orders that will be delivered to the customer's address."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TAKEOUT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - orders that will be picked up at the establishment by the customer"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"INDOOR"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - orders that will be consumed inside the establishment."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["DELIVERY","TAKEOUT","INDOOR"]},"displayId":{"type":"string","description":"Order Id shown in  Keeta interface for the customer."},"sourceAppId":{"type":"string","description":"This field must be filled in with the AppId of Keeta that originated the order. This field is to help the applications that will work as a Hub, intermediating the requests from Keeta with the Software Service."},"salesChannel":{"type":"string","description":"You can indicate through which sales channel this order originated."},"virtualBrand":{"type":"string","description":"This field can be used as an alternative id for the merchant, in cases where the same merchant has different identifications or brands (such as dark kitchens). It is important to note that Keeta or Software Hub must know this Id beforehand."},"category":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the order category."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If you find that your order category does not fit any of the listed categories, please open an issue so it can be added."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["FOOD","GROCERY","DRUGSTORE","PETSTORE"],"default":"FOOD"},"createdAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Order creation date and time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info.)."},"children":[],"type":"text"}],"type":"paragraph"}]},"lastEvent":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The last valid event polled (whether acknowledged or not) or sent via webhook. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/pollingEvents"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Click here"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for definitions of each type."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["CREATED","CONFIRMED","DISPATCHED","READY_FOR_PICKUP","PICKED_UP","DELIVERED","CONCLUDED","CANCELLATION_REQUESTED","CANCELLED","USER_REFUND_REQUEST","REFUNDED","REFUND_FAILED","RECOMMENDED_PREPARATION_START"]},"orderTiming":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the timing for initiating the order:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"INSTANT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": for orders that must be prepared immediately."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SCHEDULED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": for orders scheduled for a specific date and time. It will always be accompanied by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"schedule"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ONDEMAND"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": for orders that will only be delivered when the consumer indicates that they are going to pick it up. In this case, the Software Service will receive a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PREPARATION_REQUESTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event indicating that the order should be started."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["INSTANT","SCHEDULED","ONDEMAND"]},"preparationStartDateTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Suggestion for the preparation start time after Order creation. This can be used by Keeta to inform the merchant to delay the start of the preparation for any reason. Default is the same time as the order creation time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"merchant":{"type":"object","required":["id","name"],"description":"Merchant information.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"name":{"type":"string","description":"Merchant Public Name","maxLength":500,"example":"Pizza Plaza"}}},"items":{"type":"array","description":"Order items.","items":{"type":"object","required":["id","name","unit","quantity","unitPrice","totalPrice","externalCode"],"properties":{"id":{"type":"string","description":"A unique identifier of the item."},"index":{"type":"integer","description":"Item's position."},"name":{"type":"string","description":"Product name"},"externalCode":{"type":"string","description":"External product code."},"unit":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item's Unit of Measurement."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Possible values:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"UN"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Unit"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"KG"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Kilogram"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"L"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Liter"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OZ"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Ounce"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LB"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Pound"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GAL"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Gallon"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use fractional values for quantities smaller than the unit of measure:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: 500 grams = 0.5 KG"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["UN","KG","L","OZ","LB","GAL"],"example":"KG"},"ean":{"type":"string","description":"EAN is the barcode standard used on items."},"quantity":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amount of items."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use fractional values for quantities smaller than the unit of measure:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: 500 grams = 0.5 KG"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]},"specialInstructions":{"type":"string","description":"Special instructions about the items."},"unitPrice":{"type":"object","allOf":[{"$ref":"#/components/schemas/Price"}],"description":"Price per unit. This is the price the customer is paying and will be considered for order totals calculations."},"originalPrice":{"type":"object","allOf":[{"$ref":"#/components/schemas/Price"}],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Original price of the product."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This price "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"is for information purposes only"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and should be used to inform the price of an item before applying markdowns on the list price."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Discounts applied during the order such as coupons and vouchers should not be considered here. These must be reported in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"discounts"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"THIS PRICE WILL NOT BE CONSIDERED FOR ORDER TOTALS CALCULATIONS."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}]},"scalePriceApplied":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates whether or not the unit price of the item has changed due to a scaled purchase (where the quantity of items purchased changes the value of the item). Default is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"false"},"children":[],"type":"code"}],"type":"paragraph"}],"default":false},"optionsPrice":{"type":"object","allOf":[{"$ref":"#/components/schemas/Price"}],"description":"The sum of the total prices of all options of the item."},"subtotalPrice":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This price "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"is for information purposes only"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and should be used to inform the total price for the quantity of items ordered, excluding additional options. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(quantity * unitPrice)"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"THIS PRICE WILL NOT BE CONSIDERED FOR ORDER TOTALS CALCULATIONS."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"totalPrice":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total Price of the item. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(quantity * (unitPrice + optionsPrice))"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"indoor":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item-related properties for when the order is of type "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"INDOOR"},"children":[],"type":"code"}],"type":"paragraph"}],"properties":{"productionPoint":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Production point for this specific item."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"It should be used when the merchant has more than one production point and it is necessary to carry out production at a specific location."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note: The locations must be previously registered in both  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"options":{"type":"array","description":"The optional extras chosen by the consumer, related to this item.","items":{"type":"object","required":["id","name","externalCode","unit","quantity","unitPrice","totalPrice"],"properties":{"index":{"type":"integer","description":"Option's position."},"id":{"type":"string","description":"A unique identifier of the item."},"name":{"type":"string","description":"Options name"},"externalCode":{"type":"string","description":"External product code."},"unit":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item's Unit of Measurement."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Possible values:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"UN"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Unit"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"KG"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Kilogram"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"L"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Liter"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OZ"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Ounce"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LB"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Pound"},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GAL"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" - Gallon"},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use fractional values for quantities smaller than the unit of measure:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: 500 grams = 0.5 KG"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"enum":["UN","KG","L","OZ","LB","GAL"],"example":"KG"},"ean":{"type":"string","description":"EAN is the barcode standard used on items."},"quantity":{"type":"number","format":"decimal"},"unitPrice":{"type":"object","allOf":[{"$ref":"#/components/schemas/Price"}],"description":"Price per unit. This is the price the customer is paying and will be considered for order totals calculations."},"originalPrice":{"type":"object","allOf":[{"$ref":"#/components/schemas/Price"}],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Original price of the option."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This price "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"is for information purposes only"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and should be used to inform the price of an option before applying markdowns on the list price."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Discounts applied during the order such as coupons and vouchers should not be considered here. These must be reported in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"discounts"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" object."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"THIS PRICE WILL NOT BE CONSIDERED FOR ORDER TOTALS CALCULATIONS."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}]},"subtotalPrice":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This price "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"is for information purposes only"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and should be used to inform the total price for the quantity of items ordered, excluding additional options. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(quantity * unitPrice)"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"THIS PRICE WILL NOT BE CONSIDERED FOR ORDER TOTALS CALCULATIONS."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"totalPrice":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total Price of the option. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(quantity * unitPrice)"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"specialInstructions":{"type":"string","description":"More instructions, if needed."}}}}}}},"otherFees":{"type":"array","description":"Other fees that may apply.","items":{"type":"object","required":["name","type","receivedBy","price"],"properties":{"name":{"type":"string","description":"Name related to the other fees."},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Other fees that may apply:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY_FEE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Fee charged for delivering the order to the customer's address."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"SERVICE_FEE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Fee charged for the service provided by the Keeta platform or merchant."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"TIP"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Gratuity amount given to the delivery person or service staff."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MIN_ORDER_FEE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Additional fee charged when the order value is below the minimum required amount."},"children":[],"type":"text"}],"type":"item"}],"type":"list"}],"enum":["DELIVERY_FEE","SERVICE_FEE","TIP","MIN_ORDER_FEE"]},"receivedBy":{"type":"string","enum":["MARKETPLACE","MERCHANT","LOGISTIC_SERVICES"]},"receiverDocument":{"type":"string","description":"Mandatory for marketplace."},"price":{"type":"object","description":"The fee price","allOf":[{"$ref":"#/components/schemas/Price"}]},"observation":{"type":"string","description":"Any extra comments."}}}},"discounts":{"type":"array","description":"Any discounts that may apply.","items":{"type":"object","required":["amount","target","sponsorshipValues"],"properties":{"amount":{"type":"object","description":"Amount value of the discount.","allOf":[{"$ref":"#/components/schemas/Price"}]},"target":{"type":"string","enum":["CART","DELIVERY_FEE","ITEM"]},"targetId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Only mandatory for "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"target"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ITEM"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"sponsorshipValues":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Values sponsored by either party. The sum of the amounts listed in this atribute must match the value informed in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"amount"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" atribute above."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"type":"object","required":["name","amount"],"properties":{"name":{"type":"string","enum":["MARKETPLACE","MERCHANT","CHAIN"]},"amount":{"type":"object","description":"Discount amount given by the sponsor.","allOf":[{"$ref":"#/components/schemas/Price"}]},"discountCode":{"type":"string","description":"Code related to the discount applied. Here you can enter a coupon used by the user, or an identification code from a marketing campaign, for example."}}}}}}},"total":{"type":"object","required":["itemsPrice","otherFees","orderAmount","discount"],"description":"Set of fields with the sum of the values previously described in the order.","properties":{"itemsPrice":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sum of the total price of the items listed in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"items"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" attribute."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"otherFees":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sum of the total value of other fees listed in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"otherFees"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" attribute. If there isn't one, use 0."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"discount":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sum of any discounts that may be listed in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"discounts"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" attribute. If there isn't one, use 0."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"orderAmount":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The final value of the order (itemsPrice + otherFees - discounts)."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]}}},"payments":{"type":"object","required":["prepaid","pending","methods"],"description":"All the description of the payment, such as methods, pre-payments, change, etc.","properties":{"prepaid":{"type":"number","format":"decimal","description":"Amount paid in advance."},"pending":{"type":"number","format":"decimal","description":"Amount that is still to be paid."},"methods":{"type":"array","description":"The payment method used. Whether it was online, on delivery, credit card, voucher, cash, etc.","items":{"type":"object","required":["value","currency","type","method"],"properties":{"value":{"type":"number","format":"decimal","description":"Price value. 4 decimals places are accepted"},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"The 3-letter ISO 4217 currency code.","example":"BRL"},"type":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PREPAID"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if the payment was made through some platform, or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if it going to be paid on delivery or in cash, for example."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["PREPAID","PENDING"]},"method":{"type":"string","enum":["CREDIT","DEBIT","MEAL_VOUCHER","FOOD_VOUCHER","DIGITAL_WALLET","PIX","CASH","CREDIT_DEBIT","COUPON","REDEEM","PREPAID_REDEEM","OTHER"]},"brand":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the brand of the card selected in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"method"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field must only be filled in if "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"method"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CREDIT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DEBIT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CREDIT_DEBIT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"MEAL_VOUCHER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"FOOD_VOUCHER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OTHER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is chosen, it is recommended that you describe the brand name in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"methodInfo"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["VISA","MASTERCARD","DINERS","AMEX","HIPERCARD","ELO","AURA","DISCOVER","VR_BENEFICIOS","SODEXO","TICKET","GOOD_CARD","BANESCARD","SOROCARD","POLICARD","VALECARD","AGICARD","JCB","CREDSYSTEM","CABAL","GREEN_CARD","VEROCHEQUE","AVISTA","OTHER"]},"methodInfo":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additional information regarding the payment method."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"It can be used to indicate some useful information of the chosen payment method, such as the name of the wallet, or an authorization number."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field can be used for any "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"method"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" entered, but it is highly recommended to fill it in when the chosen "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"method"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OTHER"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"transaction":{"type":"object","description":"Authorization details and intermediary identification for credit card and/or subsidy transactions","properties":{"authorizationCode":{"type":"string","description":"Credit card and/or subsidy transaction authorization number."},"acquirerDocument":{"type":"string","description":"Document of the Transaction Intermediary (agency, delivery platform, marketplace, and similar) of services and businesses."}}},"changeFor":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the total that will be paid in cash by the customer and that should be considered for the calculation of the change"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"(ex. customer will pay a $43 order with a $50 bill. Then 50.00 must be entered.)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Only mandatory when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"method"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CASH"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}}}}},"taxInvoice":{"type":"object","description":"Tax Invoice information.","properties":{"issued":{"type":"boolean","description":"Inform if a tax invoice has already been issued for this order.","default":false},"taxInvoiceURL":{"type":"string","description":"The address to download the tax invoice issued."}}},"customer":{"type":"object","required":["id","phone","name","ordersCountOnMerchant"],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer related information."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if the chosen "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY"},"children":[],"type":"code"}],"type":"paragraph"}],"properties":{"id":{"type":"string","description":"A unique identifier related to the consumer. If Keeta does not have an Id for the customer, this Id can be generated when creating the order. "},"name":{"type":"string","description":"Customer's name."},"documentNumber":{"description":"Customer document. This document may be sent for dealing with tax issues.","type":"string"},"phone":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer's phone. Here you can enter the customer's phone number directly (provided that the customer has given permission for this data to be shared, according to local policies) or another phone number (such as the Keeta's call center phone number) where the merchant can communicate about order issues that affect the customer (such as health issues)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The telephone number is considered an identification field and therefore the customer's advance consent is required."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["number"],"properties":{"number":{"type":"string"},"extension":{"type":"string"}}},"email":{"description":"Customer email. This document may be sent for dealing with tax issues.","type":"string"},"ordersCountOnMerchant":{"description":"Total number of orders that the customer already placed within the merchant.","type":"number","format":"decimal"}}},"schedule":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information for scheduled orders."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"orderTiming"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"SCHEDULED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["scheduledDateTimeStart","scheduledDateTimeEnd"],"properties":{"scheduledDateTimeStart":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time for when the order is ready. It can be calculated by  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" using the average preparation time of the dishes. Default is the same time as order creation time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"scheduledDateTimeEnd":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time for when the order is ready. It can be calculated by  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" using the average preparation time of the dishes. Default is the same time as order creation time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"orderPriority":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Defines the priority of preparation and delivery of this order in relation to other orders from the same "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The lower the priority, the faster this order should be fulfilled."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note:"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" This field depends on both Keeta and the Merchant being able to support this functionality."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["PRIORITY1","PRIORITY2","PRIORITY3","PRIORITY4","PRIORITY5"]},"delivery":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information for DELIVERY orders."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if the chosen "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERY"},"children":[],"type":"code"}],"type":"paragraph"}],"required":["deliveredBy","deliveryAddress","estimatedDeliveryDateTime"],"properties":{"deliveredBy":{"type":"string","enum":["MERCHANT","MARKETPLACE"]},"deliveryAddress":{"type":"object","description":"The address to which the order will be delivered.","required":["country","street","formattedAddress","number","city","postalCode","coordinates","district","state"],"properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Two-letter "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72482.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" country code."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR"},"state":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"State or country subdivision. It is recommended (but not required) that you use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72483.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" representation."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR-SP"},"city":{"type":"string","description":"City name.","example":"São Paulo"},"district":{"type":"string","description":"Neighborhood or District.","example":"Moema"},"street":{"type":"string","description":"Street name.","example":"Plaza Avenue"},"number":{"type":"string","description":"Street number.","example":"100"},"complement":{"type":"string","description":"Address complement.","example":"BL 02 AP 31"},"reference":{"type":"string","description":"Address reference.","example":"Yellow House"},"formattedAddress":{"type":"string","description":"Full Formated Address Text","example":"Plaza Avenue, 100, BL 02 AP 31, Moema - São Paulo, SP - Brazil"},"postalCode":{"type":"string","description":"Postal Code","example":"20111-000"},"coordinates":{"type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54823},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63632}}}}},"estimatedDeliveryDateTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Estimated delivery date and time. The same date showed to the customer, in  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" interface."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryDateTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery date. The date time that the delivery actually took place."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"pickupCode":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It gives the Merchant a code so that the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"delivery man"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can collect the order."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Note: Not to be confused with the customer's delivery code."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"takeout":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information for TAKEOUT orders."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if the chosen "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TAKEOUT"},"children":[],"type":"code"}],"type":"paragraph"}],"required":["mode","takeoutDateTime"],"properties":{"mode":{"type":"string","enum":["DEFAULT","PICKUP_AREA"]},"takeoutDateTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Takeout date and time. It can be calculated by  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" using the average preparation time of the dishes. Default is the same time as order creation time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"indoor":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information for INDOOR orders."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" if the chosen "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"INDOOR"},"children":[],"type":"code"}],"type":"paragraph"}],"required":["mode","indoorDateTime"],"properties":{"mode":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indoor mode identifier:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"DEFAULT"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Used for orders placed in  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to be consumed inside the merchant without a specific location."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PLACE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Used for orders placed in  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to be consumed inside the merchant at a specific location already specified, such as a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"table"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"counter"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"TAB"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Used for establishments that control orders via "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"tabs"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"control cards"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" (can be used in conjunction with the place field)."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"TERMINAL"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Used for orders placed through self-services, such as kiosks, totems or tablets."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"item"}],"type":"list"}],"enum":["DEFAULT","PLACE","TAB","TERMINAL"]},"indoorDateTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time for when the order is ready. It can be calculated by  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" using the average preparation time of the dishes. Default is the same time as order creation time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"place":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The place identifier (Required if mode is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PLACE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"}],"type":"paragraph"}]},"tab":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The tab or control card identifier (Required if mode is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"TAB"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":")"},"children":[],"type":"text"}],"type":"paragraph"}]},"seat":{"type":"string","description":"Optional Identifier of the seat where the customer is located."},"waiterCode":{"type":"string","description":"Optional code to identify the waiter responsible for the order."}}},"sendPreparing":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field indicates whether it is necessary for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to make a request to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/orderPreparing"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/orders/{orderId}/preparing"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint to indicate to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that the order is in production."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Indicates that the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is waiting for a request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"false"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"not informed"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": It is not required to make a request."},"children":[],"type":"text"}],"type":"paragraph"}]},"sendDelivered":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field indicates whether it is necessary for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to make a request to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/orderDelivered"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/orders/{orderId}/delivered"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint to indicate to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that the order has been delivered to the client."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Indicates that the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is waiting for a request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"false"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"not informed"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": It is not required to make a request."},"children":[],"type":"text"}],"type":"paragraph"}]},"sendPickedUp":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field indicates whether it is necessary for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to make a request to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/orderPickedUp"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/orders/{orderId}/pickedUp"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint to indicate to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that the order has been picked up by the client."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Indicates that the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is waiting for a request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"false"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"not informed"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": It is not required to make a request."},"children":[],"type":"text"}],"type":"paragraph"}]},"sendTracking":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field indicates whether it is necessary for the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to make a request to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/orderTracking"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/orders/{orderId}/tracking"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint to inform the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" about delivery updates."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Indicates that the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is waiting for a request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"false"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"not informed"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": It is not required to make a request."},"children":[],"type":"text"}],"type":"paragraph"}]},"extraInfo":{"type":"string","description":"Extra information, if necessary."}}}},"components/schemas/OrderConfirmed":{"id":"components/schemas/OrderConfirmed","kind":"json-schema","title":"Order Confirmed","data":{"type":"object","title":"Order Confirmed","required":["createdAt","orderExternalCode"],"properties":{"reason":{"type":"string","description":"Free field for more information about the order confirmation, such as which employee accepted the order, for example."},"createdAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Order creation date and time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"orderExternalCode":{"type":"string","description":"External order code, which can be used by merchant or marketplace."},"preparationTime":{"type":"integer","description":"Indicates an estimate of the preparation time (in minutes) for the order being confirmed."}}}},"components/schemas/RequestCancelled":{"id":"components/schemas/RequestCancelled","kind":"json-schema","title":"Request Cancelattion","data":{"type":"object","title":"Request Cancelattion","required":["reason","code","mode"],"properties":{"reason":{"type":"string","description":"Open text field indicating the reason for the cancellation."},"code":{"type":"string","enum":["SYSTEMIC_ISSUES","DUPLICATE_APPLICATION","UNAVAILABLE_ITEM","RESTAURANT_WITHOUT_DELIVERY_PERSON","OUTDATED_MENU","ORDER_OUTSIDE_THE_DELIVERY_AREA","BLOCKED_CUSTOMER","OUTSIDE_DELIVERY_HOURS","INTERNAL_DIFFICULTIES_OF_THE_RESTAURANT","RISK_AREA","DELIVERY_PROBLEM"],"description":"Explanation: The enumeration values have been updated. The old values are: INSUFFICIENT-DISHES, SUSPENSION OF OF BUSINESS, INSUFICS-MANPOWER, THE. Although the new enumeration value maintains compatibility with the old enumeration value, we strongly recommend using the new enumeration value. If you are using an old value, please update it as soon as possible. Thank you for your cooperation."},"mode":{"type":"string","description":"Indicates whether the cancellation request was made by an automatic or manual process in the Software Service","enum":["AUTO","MANUAL"]},"outOfStockItems":{"type":"array","description":"Items that are not in the merchant's inventory.","items":{"type":"string"},"maxItems":100},"invalidItems":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Items that do not exist in the merchant's inventory."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"When the code is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OUTDATED_MENU"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the items listed in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"invalidItems"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be deactivated, and the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"item ID"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" should use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta item ID"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"string"},"maxItems":100}}}},"components/schemas/RequestDenied":{"id":"components/schemas/RequestDenied","kind":"json-schema","title":"Request Refund","data":{"type":"object","title":"Request Refund","required":["reason","code"],"properties":{"reason":{"type":"string","description":"Reason for rejecting refund."},"code":{"type":"string","enum":["DISH_ALREADY_DONE","OUT_FOR_DELIVERY","OTHER"]}}}},"components/schemas/Event":{"id":"components/schemas/Event","kind":"json-schema","title":"Event","data":{"type":"object","title":"Event","required":["eventId","eventType","orderId","orderURL","createdAt"],"discriminator":{"propertyName":"eventType","mapping":{"CREATED":"#/components/schemas/EventMetadata","CONFIRMED":"#/components/schemas/EventMetadata","DISPATCHED":"#/components/schemas/EventMetadata","READY_FOR_PICKUP":"#/components/schemas/EventMetadata","PICKUP_ONGOING":"#/components/schemas/EventMetadataPickupOngoing","PICKED_UP":"#/components/schemas/EventMetadata","DELIVERED":"#/components/schemas/EventMetadata","CONCLUDED":"#/components/schemas/EventMetadata","CANCELLATION_REQUESTED":"#/components/schemas/EventMetadata","CANCELLED":"#/components/schemas/EventMetadataCancel","USER_REFUND_REQUEST":"#/components/schemas/SendRefundRequest","REFUNDED":"#/components/schemas/Refunded","REFUND_FAILED":"#/components/schemas/RefundFailed","RIDER_ARRIVED_AT_STORE":"#/components/schemas/EventMetadata","ORDER_COLLECTED":"#/components/schemas/EventMetadata","RECOMMENDED_PREPARATION_START":"#/components/schemas/EventMetadataRecommendedPreparationStart"}},"properties":{"eventId":{"type":"string","description":"A unique identifier of the event."},"eventType":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The event type. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/pollingEvents"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Click here"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for definitions of each type."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["CREATED","CONFIRMED","DISPATCHED","READY_FOR_PICKUP","PICKUP_ONGOING","PICKED_UP","DELIVERED","CONCLUDED","CANCELLATION_REQUESTED","CANCELLED","USER_REFUND_REQUEST","REFUNDED","REFUND_FAILED","RIDER_ARRIVED_AT_STORE","ORDER_COLLECTED","RECOMMENDED_PREPARATION_START"]},"orderId":{"type":"string","description":"The unique identifier of the order. The order ID is generated by Keeta."},"orderURL":{"type":"string","format":"uri","description":"The URL to get the order details"},"createdAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Order creation date and time."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"sourceAppId":{"type":"string","description":"This field must be filled in with the AppId of Keeta that originated the order. This field is to help the applications that will work as a Hub, intermediating the requests from  Keeta with the Software Service."},"virtualBrand":{"type":"string","description":"This field can be used as an alternative id for the merchant, in cases where the same merchant has different identifications or brands (such as dark kitchens). It is important to note that Keeta or Software Hub must know this Id beforehand."}}}},"components/schemas/EventMetadataCancel":{"id":"components/schemas/EventMetadataCancel","kind":"json-schema","title":"EventMetadataCancel","data":{"description":"Metadata","required":["metadata"],"allOf":[{"$ref":"#/components/schemas/Event"},{"type":"string"},{"properties":{"metadata":{"required":["reason","code"],"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information related to the Event Type."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The metadata type is a JSONObject String."},"children":[],"type":"text"}],"type":"tag","tag":"html"}],"type":"paragraph"}],"example":"{\"orderViewId\":2340761421922475,\"opTime\":1764488817847,\"cancelType\":505001,\"opType\":30,\"shopId\":159400835,\"cancelReason\":\"Preparo dos alimentos demorado\",\"status\":50}","properties":{"reason":{"type":"string","description":"Reason for the cancellation"},"code":{"type":"string","description":"Cancelation reason code","enum":["INSUFFICIENT_DISHES","SUSPENSION_OF_BUSINESS","INSUFFICIENT_MANPOWER","OTHERS"]},"clientId":{"type":"string","description":"The ID of the client system that generated the action that resulted in this event (to be used with application with multiple stations)."}}}}}]}},"components/schemas/SendRefundRequest":{"id":"components/schemas/SendRefundRequest","kind":"json-schema","title":"SendRefundRequest","data":{"description":"Metadata","required":["metadata"],"allOf":[{"$ref":"#/components/schemas/Event"},{"type":"string"},{"properties":{"metadata":{"required":["reason","code"],"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information related to the Event Type."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The metadata type is a JSONObject String."},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Within "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refundProducts"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"count"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refundCount"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" both represent the total quantity of SKUs to be refunded for the product item."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"{ \"money\": 8500, \"opTime\": 1751005551823, \"shopId\": \"461827\", \"status\": 5002, \"currency\": \"BRL\", \"isAppeal\": 0, \"partRefund\": 0, \"applyOpType\": 10, \"applyReason\": \"Ordem errada\", \"orderViewId\": 783441058793308, \"handleOpType\": 20, \"handleReason\": \"Mercante concordou em devolver\", \"refundProducts\": [ { \"id\": 12053105, \"name\": \"1️⃣  Noodles com 1 Topping\", \"spec\": \"\", \"tags\": [], \"count\": 1, \"price\": 7500, \"skuId\": 8949938, \"spuId\": 9897081, \"groups\": [ { \"groupId\": 4305174, \"groupName\": \"Escolha Suas Escolhas de Noodles\", \"groupNameI18n\": { \"en\": \"Escolha Suas Escolhas de Noodles\", \"zh-HK\": \"Seleccione a superfície inferior\", \"default\": \"Seleccione a superfície inferior\" }, \"groupOpenItemCode\": \"cgp-7741|1-1\", \"shopProductGroupSkuList\": [ { \"count\": 1, \"price\": 0, \"spuId\": 2069967, \"spuName\": \"Rice Stick Noodle Supremes\", \"currency\": \"BRL\", \"spuPvList\": [], \"groupSkuId\": 23903426, \"refundCount\": 1, \"refundPrice\": 0, \"spuNameI18n\": { \"en\": \"Rice Stick Noodle Supremes\", \"zh-HK\": \"noodles de arroz\", \"default\": \"noodles de arroz\" }, \"groupSkuOpenItemCode\": \"128019\" } ] } ], \"remark\": \"\", \"picList\": [ \"http://img-ap-hongkong.mykeeta.net/sailorproduct/aa2d5209534619f31c2e966080ecac5885942.jpg\" ], \"currency\": \"BRL\", \"nameI18n\": { \"en\": \"1️⃣  Noodles com 1 Topping\", \"zh-HK\": \"1️⃣  Ninho de pedaços noodles de arroz\", \"default\": \"1️⃣  Ninho de pedaços noodles de arroz\" }, \"priceStr\": \"R$75.00\", \"spuPvList\": [], \"promotions\": [], \"refundType\": 1, \"originPrice\": 7500, \"refundCount\": 1, \"refundPrice\": 0, \"orderProductId\": 359379560, \"originPriceStr\": \"R$75.00\", \"priceWithGroup\": { \"amount\": 7500, \"amountStr\": \"R$75.00\", \"originAmount\": 7500, \"originAmountStr\": \"R$75.00\" }, \"skuOpenItemCode\": \"AY290105\", \"spuOpenItemCode\": \"8898\", \"priceWithoutGroup\": { \"amount\": 5900, \"amountStr\": \"R$59.00\", \"originAmount\": 5900, \"originAmountStr\": \"R$59.00\" } } ], \"partRefundCount\": 0, \"afterSaleOrderId\": 783440453161676 }","properties":{"reason":{"type":"string","description":"Reason for the cancellation"},"code":{"type":"string","description":"Cancelation reason code","enum":["INSUFFICIENT_DISHES","SUSPENSION_OF_BUSINESS","INSUFFICIENT_MANPOWER","OTHERS"]},"clientId":{"type":"string","description":"The ID of the client system that generated the action that resulted in this event (to be used with application with multiple stations)."}}}}}]}},"components/schemas/Refunded":{"id":"components/schemas/Refunded","kind":"json-schema","title":"Refunded","data":{"description":"Metadata","required":["metadata"],"allOf":[{"$ref":"#/components/schemas/Event"},{"type":"string"},{"properties":{"metadata":{"required":["reason","code"],"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information related to the Event Type."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The metadata type is a JSONObject String."},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Within "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refundProducts"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"count"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refundCount"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" both represent the total quantity of SKUs to be refunded for the product item."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"{\"money\": 8800, \"opTime\": 1764567420888, \"shopId\": \"159470627\", \"status\": 5002, \"currency\": \"BRL\", \"isAppeal\": 0, \"partRefund\": 0, \"applyOpType\": 0, \"applyReason\": \"No courier\", \"orderViewId\": 2350762747079930, \"handleOpType\": 0, \"handleReason\": \"No courier\", \"refundProducts\": [{\"id\": 250189055, \"name\": \"Chicken Supreme\", \"spec\": \"\", \"tags\": [], \"count\": 1, \"price\": 8500, \"skuId\": 83325441, \"spuId\": 83607187, \"groups\": [{\"groupId\": 19831845, \"groupName\": \"Crust\", \"groupNameI18n\": {\"pt-BR\": \"Crust\", \"default\": \"Crust\"}, \"groupOpenItemCode\": \"3463\", \"shopProductGroupSkuList\": [{\"count\": 1, \"price\": 0, \"spuId\": 83527562, \"spuName\": \"Pan\", \"currency\": \"BRL\", \"spuPvList\": [], \"subGroups\": [], \"groupSkuId\": 117285534, \"refundCount\": 1, \"refundPrice\": 0, \"spuNameI18n\": {\"pt-BR\": \"Pan\", \"default\": \"Pan\"}, \"groupSkuOpenItemCode\": \"2041\"}]}], \"currency\": \"BRL\", \"nameI18n\": {\"pt-BR\": \"Chicken Supreme\", \"default\": \"Chicken Supreme\"}, \"priceStr\": \"R$85.00\", \"specI18n\": {\"pt-BR\": \"\", \"default\": \"\"}, \"spuPvList\": [], \"promotions\": [], \"refundType\": 1, \"originPrice\": 8500, \"refundCount\": 1, \"refundPrice\": 0, \"orderProductId\": 685458900, \"originPriceStr\": \"R$85.00\", \"priceWithGroup\": {\"amount\": 8500, \"amountStr\": \"R$85.00\", \"originAmount\": 8500, \"originAmountStr\": \"R$85.00\"}, \"skuOpenItemCode\": \"sku-2720\", \"spuOpenItemCode\": \"spu-2720\", \"priceWithoutGroup\": {\"amount\": 8500, \"amountStr\": \"R$85.00\", \"originAmount\": 8500, \"originAmountStr\": \"R$85.00\"}}], \"partRefundCount\": 0, \"afterSaleOrderId\": 2350762034940118}","properties":{"reason":{"type":"string","description":"Reason for the cancellation"},"code":{"type":"string","description":"Cancelation reason code","enum":["INSUFFICIENT_DISHES","SUSPENSION_OF_BUSINESS","INSUFFICIENT_MANPOWER","OTHERS"]},"clientId":{"type":"string","description":"The ID of the client system that generated the action that resulted in this event (to be used with application with multiple stations)."}}}}}]}},"components/schemas/RefundFailed":{"id":"components/schemas/RefundFailed","kind":"json-schema","title":"RefundFailed","data":{"description":"Metadata","required":["metadata"],"allOf":[{"$ref":"#/components/schemas/Event"},{"type":"string"},{"properties":{"metadata":{"required":["reason","code"],"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information related to the Event Type."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The metadata type is a JSONObject String."},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Within "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refundProducts"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"count"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"refundCount"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" both represent the total quantity of SKUs to be refunded for the product item."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"{\"money\": 8800, \"opTime\": 1764567420888, \"shopId\": \"159470627\", \"status\": 5003, \"currency\": \"BRL\", \"isAppeal\": 0, \"partRefund\": 0, \"applyOpType\": 0, \"applyReason\": \"No courier\", \"orderViewId\": 2350762747079930, \"handleOpType\": 0, \"handleReason\": \"No courier\", \"refundProducts\": [{\"id\": 250189055, \"name\": \"Chicken Supreme\", \"spec\": \"\", \"tags\": [], \"count\": 1, \"price\": 8500, \"skuId\": 83325441, \"spuId\": 83607187, \"groups\": [{\"groupId\": 19831845, \"groupName\": \"Crust\", \"groupNameI18n\": {\"pt-BR\": \"Crust\", \"default\": \"Crust\"}, \"groupOpenItemCode\": \"3463\", \"shopProductGroupSkuList\": [{\"count\": 1, \"price\": 0, \"spuId\": 83527562, \"spuName\": \"Pan\", \"currency\": \"BRL\", \"spuPvList\": [], \"subGroups\": [], \"groupSkuId\": 117285534, \"refundCount\": 1, \"refundPrice\": 0, \"spuNameI18n\": {\"pt-BR\": \"Pan\", \"default\": \"Pan\"}, \"groupSkuOpenItemCode\": \"2041\"}]}], \"currency\": \"BRL\", \"nameI18n\": {\"pt-BR\": \"Chicken Supreme\", \"default\": \"Chicken Supreme\"}, \"priceStr\": \"R$85.00\", \"specI18n\": {\"pt-BR\": \"\", \"default\": \"\"}, \"spuPvList\": [], \"promotions\": [], \"refundType\": 1, \"originPrice\": 8500, \"refundCount\": 1, \"refundPrice\": 0, \"orderProductId\": 685458900, \"originPriceStr\": \"R$85.00\", \"priceWithGroup\": {\"amount\": 8500, \"amountStr\": \"R$85.00\", \"originAmount\": 8500, \"originAmountStr\": \"R$85.00\"}, \"skuOpenItemCode\": \"sku-2720\", \"spuOpenItemCode\": \"spu-2720\", \"priceWithoutGroup\": {\"amount\": 8500, \"amountStr\": \"R$85.00\", \"originAmount\": 8500, \"originAmountStr\": \"R$85.00\"}}], \"partRefundCount\": 0, \"afterSaleOrderId\": 2350762034940118}","properties":{"reason":{"type":"string","description":"Reason for the cancellation"},"code":{"type":"string","description":"Cancelation reason code","enum":["INSUFFICIENT_DISHES","SUSPENSION_OF_BUSINESS","INSUFFICIENT_MANPOWER","OTHERS"]},"clientId":{"type":"string","description":"The ID of the client system that generated the action that resulted in this event (to be used with application with multiple stations)."}}}}}]}},"components/schemas/EventMetadataPickupOngoing":{"id":"components/schemas/EventMetadataPickupOngoing","kind":"json-schema","title":"EventMetadataPickupOngoing","data":{"description":"Metadata","required":["metadata"],"allOf":[{"$ref":"#/components/schemas/Event"},{"type":"string"},{"properties":{"metadata":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The metadata type is a JSONObject String."},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"pickupEtaDatetime"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Informs the date and time the delivery person is expected to arrive at the merchant for order pickup."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"{\"pickupEtaDatetime\":\"2024-01-01T14:00:00Z\"}"}}}]}},"components/schemas/EventMetadataRecommendedPreparationStart":{"id":"components/schemas/EventMetadataRecommendedPreparationStart","kind":"json-schema","title":"EventMetadataRecommendedPreparationStart","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Metadata for RECOMMENDED_PREPARATION_START event"},"children":[],"type":"text"}],"type":"paragraph"}],"required":["metadata"],"example":{"eventId":"string","eventType":"RECOMMENDED_PREPARATION_START","orderId":"string","orderURL":"http://example.com","createdAt":"2019-08-24T14:15:22Z","sourceAppId":"string","virtualBrand":"string","metadata":"{\"pickupEtaDateTime\":\"2019-08-24T14:15:22Z\"}"},"allOf":[{"$ref":"#/components/schemas/Event"},{"type":"string"},{"properties":{"metadata":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The metadata type is a JSONObject String."},"children":[],"type":"text"}],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"pickupEtaDateTime"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Informs the date and time the delivery person is expected to arrive at the merchant for order pickup."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"{\"pickupEtaDateTime\":\"2019-08-24T14:15:22Z\"}"}}}]}},"components/schemas/EventMetadata":{"id":"components/schemas/EventMetadata","kind":"json-schema","title":"EventMetadata","data":{"description":"Metadata","allOf":[{"$ref":"#/components/schemas/Event"}]}},"components/schemas/OrderDispatched":{"id":"components/schemas/OrderDispatched","kind":"json-schema","title":"Order Dispatched","data":{"type":"object","title":"Order Dispatched","properties":{"deliveryTrackingInfo":{"type":"object","description":"Information about the person that was assigned to deliver the order.","allOf":[{"$ref":"#/components/schemas/DeliveryTrackingInfoDisptach"}]}}}},"components/schemas/BatchDecryptRequest":{"id":"components/schemas/BatchDecryptRequest","kind":"json-schema","title":"BatchDecryptRequest","data":{"type":"object","required":["cipherInfos"],"properties":{"cipherInfos":{"type":"array","description":"List of encrypted data to be decrypted","items":{"type":"object","required":["cipherText"],"properties":{"cipherText":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Encrypt text in the format of an encrypted string starting with "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ENC_"},"children":[],"type":"code"}],"type":"paragraph"}],"example":"ENC_#MQesaE=#1#"}}}}}}},"components/schemas/BatchDecryptResponse":{"id":"components/schemas/BatchDecryptResponse","kind":"json-schema","title":"BatchDecryptResponse","data":{"type":"object","required":["plainInfos"],"properties":{"plainInfos":{"type":"array","description":"List of decrypted data with processing results","items":{"type":"object","required":["errorMsg","plainText","errorCode","cipherText"],"properties":{"errorMsg":{"type":"string","description":"Error message for this decryption item","example":"success"},"plainText":{"type":"string","description":"Decrypted plain text result","example":"Bob"},"errorCode":{"type":"integer","description":"Error code for this decryption item","example":0},"cipherText":{"type":"string","description":"Original encrypted text that was processed","example":"ENC_#MQesaE=#1#"}}}}}}},"components/schemas/OrderTracking":{"id":"components/schemas/OrderTracking","kind":"json-schema","title":"Order Tracking","data":{"type":"object","title":"Order Tracking","required":["deliveryTrackingInfo"],"properties":{"deliveryTrackingInfo":{"type":"object","description":"Information about the person that was assigned to deliver the order.","allOf":[{"$ref":"#/components/schemas/DeliveryTrackingInfo"}]}}}},"components/schemas/DeliveryTrackingInfoDisptach":{"id":"components/schemas/DeliveryTrackingInfoDisptach","kind":"json-schema","title":"DeliveryTrackingInfoDisptach","data":{"description":"Delivery Tracking Info","type":"object","properties":{"event":{"description":"The delivery last known event.","type":"object","required":["type","datetime"],"properties":{"type":{"type":"string","description":"The current delivery event.","enum":["DELIVERY_ONGOING","ARRIVED_AT_CUSTOMER","ORDER_DELIVERED","CANCELLED"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."},"datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the event ocurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"problem":{"description":"In the event of a delivery problem, it states the last known reason.","type":"object","required":["reason","datetime"],"properties":{"reason":{"type":"string","description":"Problem reason.","enum":["DELIVERYPERSON_OCCURRENCE","PAYMENT_PROBLEMS","WRONG_PRODUCT_OR_ITEM","ORDER_DELAYED","ORDER_DAMAGED_OR_VIOLATED","CUSTOMER_DID_NOT_PLACE_ORDER","CUSTOMER_ADDRESS_UNKNOWN","ORDER_MISSING_ITEMS","NOBODY_TO_RECEIVE","DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER","ORDER_DELIVERED_WITHOUT_PAYMENT","FRAUD_OR_THEFT"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."},"datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the problem ocurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"vehicle":{"description":"The vehicle that will be used for this delivery.","type":"object","required":["type"],"properties":{"type":{"type":"array","description":"Vehicle Type","items":{"type":"string","enum":["MOTORBIKE_BAG","MOTORBIKE_BOX","CAR","BICYCLE","SCOOTER","VUC"]},"maxItems":10},"licencePlate":{"type":"string","description":"Licence plate of the vehicle user for the delivery."}}},"eta":{"type":"object","description":"Estimate Times of Pickup and Delivery.","properties":{"deliveryEtaInMinutes":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Eta in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Informs how many minutes it will take the delivery person to arrive at the consumer's address for order delivery."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryEtaDatetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Eta Datetime. Informs the date and time the delivery person is expected to arrive at the consumer's address for order delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"maxDeliveryTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum Date and Time for delivery. This time should not exceed the delivery time limit given in the order request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"deliveryPerson":{"type":"object","description":"Information about the person taht was assigned to deliver the order.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Person Id given by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"name":{"type":"string","description":"Delivery Person Name."},"pictureURL":{"type":"string","format":"URI","description":"URL to access the photo of the delivery person. Before entering this field, check that the parties allow data to be shared according to data disclosure laws and rules."},"areaCode":{"type":"string","description":"Delivery Person telephone area code.","example":"+55"},"phone":{"type":"string","description":"Delivery Person phone number.","example":"1234567"}}},"geoLocalization":{"description":"Geo Localization Info.","type":"object","properties":{"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the latitude coordinate of the actual position of the delivery person."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the longitude coordinate of the actual position of the delivery person."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638},"lastAddress":{"description":"The last known address that the delivery person was when the event was sent.","type":"object","required":["distanceToPickup","distanceToDelivery","timestamp"],"properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Two-letter "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72482.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" country code."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR"},"state":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"State or country subdivision. It is recommended (but not required) that you use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72483.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" representation."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR-SP"},"city":{"type":"string","description":"City name.","example":"São Paulo"},"district":{"type":"string","description":"District or Neighborhood name.","example":"Moema"},"street":{"type":"string","description":"Street Name.","example":"Plaza Avenue"},"postalCode":{"type":"string","description":"Postal Code.","example":"20111-000"},"distanceToPickup":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Distance To Pickup in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"meters"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"distanceToDelivery":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Distance To Delivery in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"meters"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"timestamp":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when this information is valid."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}}}},"externalTrackingURL":{"type":"string","format":"URI","description":"External URL, provided by the logistics service to track the delivery on a specific page. Example: Real-time map view, or delivery timeline."}}}},"components/schemas/DeliveryTrackingInfo":{"id":"components/schemas/DeliveryTrackingInfo","kind":"json-schema","title":"DeliveryTrackingInfo","data":{"description":"Delivery Tracking Info Updates","type":"object","properties":{"event":{"description":"The delivery last known event.","type":"object","required":["type","datetime"],"properties":{"type":{"type":"string","description":"The current delivery event.","enum":["PICKUP_ONGOING","ARRIVED_AT_MERCHANT","ORDER_PICKED","DELIVERY_ONGOING","ARRIVED_AT_CUSTOMER","ORDER_DELIVERED","CANCELLED"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."},"datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the event ocurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"problem":{"description":"In the event of a delivery problem, it states the last known reason.","type":"object","required":["reason","datetime"],"properties":{"reason":{"type":"string","description":"Problem reason.","enum":["DELIVERYPERSON_OCCURRENCE","PAYMENT_PROBLEMS","WRONG_PRODUCT_OR_ITEM","ORDER_DELAYED","ORDER_DAMAGED_OR_VIOLATED","CUSTOMER_DID_NOT_PLACE_ORDER","CUSTOMER_ADDRESS_UNKNOWN","ORDER_MISSING_ITEMS","NOBODY_TO_RECEIVE","DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER","ORDER_DELIVERED_WITHOUT_PAYMENT","FRAUD_OR_THEFT"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."},"datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the problem ocurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"vehicle":{"description":"The vehicle that will be used for this delivery.","type":"object","required":["type"],"properties":{"type":{"type":"array","description":"Vehicle Type","items":{"type":"string","enum":["MOTORBIKE_BAG","MOTORBIKE_BOX","CAR","BICYCLE","SCOOTER","VUC"]},"maxItems":10},"licencePlate":{"type":"string","description":"Licence plate of the vehicle user for the delivery."}}},"eta":{"type":"object","description":"Estimate Times of Pickup and Delivery.","properties":{"pickupEtaInMinutes":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pickup Eta in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Informs how many minutes it will take the delivery person to arrive at the merchant for order pickup."},"children":[],"type":"text"}],"type":"paragraph"}]},"pickupEtaDatetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pickup Eta Datetime. Informs the date and time the delivery person is expected to arrive at the merchant for order pickup."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryEtaInMinutes":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Eta in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Informs how many minutes it will take the delivery person to arrive at the consumer's address for order delivery."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryEtaDatetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Eta Datetime. Informs the date and time the delivery person is expected to arrive at the consumer's address for order delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"maxDeliveryTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum Date and Time for delivery. This time should not exceed the delivery time limit given in the order request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"deliveryPerson":{"type":"object","description":"Information about the person taht was assigned to deliver the order.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Person Id given by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"name":{"type":"string","description":"Delivery Person Name."},"pictureURL":{"type":"string","format":"URI","description":"URL to access the photo of the delivery person. Before entering this field, check that the parties allow data to be shared according to data disclosure laws and rules."}}},"geoLocalization":{"description":"Geo Localization Info.","type":"object","properties":{"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the latitude coordinate of the actual position of the delivery person."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the longitude coordinate of the actual position of the delivery person."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638},"lastAddress":{"description":"The last known address that the delivery person was when the event was sent.","type":"object","required":["distanceToPickup","distanceToDelivery","timestamp"],"properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Two-letter "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72482.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" country code."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR"},"state":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"State or country subdivision. It is recommended (but not required) that you use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72483.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" representation."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR-SP"},"city":{"type":"string","description":"City name.","example":"São Paulo"},"district":{"type":"string","description":"District or Neighborhood name.","example":"Moema"},"street":{"type":"string","description":"Street Name.","example":"Plaza Avenue"},"postalCode":{"type":"string","description":"Postal Code.","example":"20111-000"},"distanceToPickup":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Distance To Pickup in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"meters"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"distanceToDelivery":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Distance To Delivery in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"meters"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"timestamp":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when this information is valid."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}}}},"externalTrackingURL":{"type":"string","format":"URI","description":"External URL, provided by the logistics service to track the delivery on a specific page. Example: Real-time map view, or delivery timeline."}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","title":"Address","required":["country","state","city","district","street","number","postalCode","complement","latitude","longitude"],"properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Two-letter "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72482.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" country code."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR"},"state":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"State or country subdivision. It is recommended (but not required) that you use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72483.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" representation."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR-SP"},"city":{"type":"string","description":"City name.","example":"São Paulo"},"district":{"type":"string","description":"District or Neighborhood name.","example":"Moema"},"street":{"type":"string","description":"Street Name.","example":"Plaza Avenue"},"number":{"type":"string","description":"Street Number.","example":"100"},"postalCode":{"type":"string","description":"Postal Code","example":"20111-000"},"complement":{"type":"string","description":"Address complement.","example":"BL 02 AP 31"},"reference":{"type":"string","description":"Address reference.","example":"Yellow House"},"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638}}}},"components/schemas/AddressLogistics":{"id":"components/schemas/AddressLogistics","kind":"json-schema","title":"Address","data":{"type":"object","title":"Address","required":["country","state","city","district","street","number","postalCode","complement"],"properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Two-letter "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72482.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" country code."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR"},"state":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"State or country subdivision. It is recommended (but not required) that you use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72483.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" representation."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR-SP"},"city":{"type":"string","description":"City name.","example":"São Paulo"},"district":{"type":"string","description":"District or Neighborhood name.","example":"Moema"},"street":{"type":"string","description":"Street Name.","example":"Plaza Avenue"},"number":{"type":"string","description":"Street Number.","example":"100"},"postalCode":{"type":"string","description":"Postal Code","example":"20111-000"},"complement":{"type":"string","description":"Address complement.","example":"BL 02 AP 31"},"reference":{"type":"string","description":"Address reference.","example":"Yellow House"},"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638}}}},"components/schemas/ContactPhones":{"id":"components/schemas/ContactPhones","kind":"json-schema","title":"Contact Phones","data":{"type":"object","title":"Contact Phones","required":["commercialNumber"],"properties":{"commercialNumber":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Telephone number of the merchant. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note that the area code is required."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"example":"55-11999999999"},"whatsappNumber":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Whatsapp number of the merchant, Keeta will temporarily ignore this information."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta does not support this field and will be ignored."},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}],"type":"blockquote"}],"example":"11998888888"}}}},"components/schemas/Price":{"id":"components/schemas/Price","kind":"json-schema","title":"Price","data":{"type":"object","title":"Price","required":["value","currency"],"properties":{"value":{"type":"number","format":"decimal","description":"Price value. 4 decimals places are accepted","example":40},"currency":{"type":"string","pattern":"^[A-Z]{3}$","description":"The 3-letter ISO 4217 currency code.","example":"BRL"}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","required":["title","status"],"properties":{"title":{"type":"string","description":"Short description of the problem.","example":"Unexpected error"},"status":{"type":"integer","description":"HTTP code of the returned status.","example":500}}}},"components/schemas/CancellationError":{"id":"components/schemas/CancellationError","kind":"json-schema","title":"CancellationError","data":{"type":"object","required":["title","status"],"properties":{"title":{"type":"string","description":"Short description of the problem.","example":"Unexpected error"},"status":{"type":"integer","description":"HTTP code of the returned status.","example":500},"cancellationStatus":{"type":"string","description":"Indicates the result of the cancellation request.","enum":["CANCELLED"]}}}},"components/schemas/Image":{"id":"components/schemas/Image","kind":"json-schema","title":"Image","data":{"type":"object","required":["URL"],"properties":{"URL":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL pointing to an image of the merchant logo."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Image requirements:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Supports standard HTTP/HTTPS external image URLs."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"File size must be less than 5MB, it is recommended to be less than 2MB."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Support JPG, PNG, JPEG format."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The width of the image cannot be less than 600px, and the height cannot be less than 450px. The recommended aspect ratio is 4:3, but this is not a constraint."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected that the images referenced in the URL are downloaded from the server that is making the request, because the URL may no longer be valid after a period of time."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"example":"https://food-company.com/image.jpg"},"CRC-32":{"type":"string","format":"CRC32","description":"CRC-32 of the image file. This field can be used to check for changes in the image file.","example":"96b41025"}}}},"components/schemas/ImageWithType":{"id":"components/schemas/ImageWithType","kind":"json-schema","title":"ImageWithType","data":{"description":"Image Object","type":"object","required":["URL","type"],"properties":{"URL":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL pointing to an image of the merchant logo."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Image requirements:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Supports standard HTTP/HTTPS external image URLs."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"File size must be less than 5MB, it is recommended to be less than 2MB."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Support JPG, PNG, JPEG format."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The width of the image cannot be less than 600px, and the height cannot be less than 450px. The recommended aspect ratio is 4:3, but this is not a constraint."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is expected that the images referenced in the URL are downloaded from the server that is making the request, because the URL may no longer be valid after a period of time."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"example":"https://food-company.com/image.jpg"},"CRC-32":{"type":"string","format":"CRC32","description":"CRC-32 of the image file. This field can be used to check for changes in the image file.","example":"96b41025"},"type":{"type":"string","enum":["main","thumb"],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The type of the image. The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"main"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" type is generally used for larger images, such as in the item detail, while the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"thumb"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" type is for smaller images, typically used in the menu listing."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/MerchantAPIInfo":{"id":"components/schemas/MerchantAPIInfo","kind":"json-schema","title":"MerchantAPIInfo","data":{"type":"object","required":["keetaMerchantId"],"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information about the endpoints that are hosted at the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"getMerchantURL":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information about the merchant's Software Service's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getMerchant"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" access. This endpoint has the necessary information for Keeta to be able to make the merchant's available on their plataform."},"children":[],"type":"text"}],"type":"paragraph"}],"required":["baseURL"],"properties":{"baseURL":{"type":"string","format":"uri","description":"The URL for accessing the endpoint."},"apiKey":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The API_KEY for accessing the endpoint (see "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#tag/authentication"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"AUTHENTICATION"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" section form more information)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"ordersWebhookURL":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Information about the merchant's Software Service's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/newEvent"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /v1/newEvent"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" webhook access. This is where Keeta will sent the order's events to the Software Service as they happen."},"children":[],"type":"text"}],"type":"paragraph"}]},"keetaMerchantId":{"type":"number","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The Keeta merchant ID is generated by Keeta. Merchants can obtain this merchantId from the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta merchant portal"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/DeliveryOrder":{"id":"components/schemas/DeliveryOrder","kind":"json-schema","title":"DeliveryOrder","data":{"description":"Delivery Order Object.","type":"object","required":["orderId","orderDisplayId","merchant","pickupAddress","returnToMerchant","canCombine","deliveryAddress","customerName","vehicle","limitTimes","totalOrderPrice","totalWeight","payments"],"properties":{"orderId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The orderId generated by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"52122852-6626-11ed-9022-0242ac120002"},"orderDisplayId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Order Id shown in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" interface for the customer."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"96b41025"},"merchant":{"type":"object","required":["id","name"],"description":"Merchant information.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"name":{"type":"string","description":"Merchant Public Name","maxLength":500,"example":"Pizza Plaza"}}},"pickupAddress":{"description":"Pickup Address.","allOf":[{"$ref":"#/components/schemas/AddressLogistics"},{"type":"object","properties":{"pickupLocation":{"type":"string","description":"Pickup Location"},"parkingSpace":{"type":"boolean","description":"Parking Space"},"instructions":{"type":"string","description":"Any instructions that may help the delivery."}}}]},"pickupCode":{"type":"string","description":"Pickup code to be provided to the delivery person for order collection at the merchant. This code may have been generated by Keeta or by the Software Service."},"notifyReadyForPickup":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Inform whether the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to wait for a notification that the order was ready for been picked up. This notification happens via the endpoint: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/logisticsReadyForPicked"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /logistics/orderPicked/{orderId}"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}]},"notifyPickup":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Inform whether the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to wait for a notification that the order has actually been picked. This notification happens via the endpoint: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/logisticsPicked"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /logistics/orderPicked/{orderId}"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}]},"notifyConclusion":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Inform whether the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to wait for a delivery finish notification from the requester, before actually finalizing the delivery in its system. This notification is made via the endpoint: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/logisticsFinish"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"POST /logistics/finishDelivery/{orderId}"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}]},"returnToMerchant":{"type":"boolean","description":"Inform whether the delivery person should return to the pickup address after the delivery has been made."},"canCombine":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Inform whether the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can combine this order with other orders in the same delivery."},"children":[],"type":"text"}],"type":"paragraph"}]},"confirmationCodeRequired":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Inform whether the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" needs to validate a Delivery Confirmation Code passed by the customer to complete the delivery."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryAddress":{"description":"Delivery Address","allOf":[{"$ref":"#/components/schemas/AddressLogistics"},{"type":"object","properties":{"instructions":{"type":"string","description":"Instructions"}}}]},"customerName":{"type":"string","description":"Customer Name."},"customerPhone":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer's phone. Here you can enter the customer's phone number directly (provided that the customer has given permission for this data to be shared, according to local policies) or another phone number (such as the Keeta's call center phone number)."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The telephone number is considered an identification field and therefore the customer's advance consent is required."},"children":[],"type":"text"}],"type":"paragraph"}]},"customerPhoneLocalizer":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie should be used as a complementary field to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"customerPhone"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field in cases where a generic phone number is provided, such as a call center, and it is necessary to provide some order or customer identification."},"children":[],"type":"text"}],"type":"paragraph"}]},"vehicle":{"description":"Vehicle Info. informs which vehicle options are to be used for delivery. More than one can be informed, but the logistics service must choose only one of the types of vehicles informed.","allOf":[{"$ref":"#/components/schemas/Vehicle"}]},"limitTimes":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Limit Times. Informs the maximum pickup and delivery times that must be met by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"pickupLimit":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pickup Limit in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". It should be used to inform the maximum amount of minutes from the time the request was made to which the order should be collected at the merchant."},"children":[],"type":"text"}],"type":"paragraph"}],"example":23},"deliveryLimit":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Limit in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". It should be used to inform the maximum amount of minutes from the time the request was made to which the order should be delivered at the consumer's address."},"children":[],"type":"text"}],"type":"paragraph"}],"example":48},"orderCreatedAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The date and time that the Order was created at "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"preparationStartDateTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Estimated time when the order will start being prepared."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"totalOrderPrice":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total order price that was calculated and displayed for the final consumer in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". This value may already contain taxes and shipping in addition to the value of the items purchased."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"orderDeliveryFee":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field informs the delivery fee paid by the consumer in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"totalWeight":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total packaging weight in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"grams"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}]},"packageVolume":{"type":"number","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The cubage of the packaging in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"cubic meters (m³)"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"packageQuantity":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of packages that will be transported in this order. For example, 2 packages, or 3 boxes."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The unit of measure will not be considered, only the quantity."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]},"items":{"type":"array","description":"List of items that are part of the delivery.","items":{"type":"object","properties":{"name":{"type":"string","description":"Product name"},"quantity":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Amount of items."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Use fractional values for quantities smaller than the unit of measure:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: 500 grams = 0.5 KG"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]}}}},"specialInstructions":{"type":"string","description":"Free text to describe special instructions that may apply. These instructions can be used to give some special guidance to the delivery person at the time of the pickup or delivery."},"additionalPricePercentual":{"type":"number","format":"double","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" an additional percentage to the list price that the requester agrees to pay for the delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The delivery request will be refused if the delivery price exceeds this value."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: List Price = $10"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Actual calculated price = $15"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additonal price percentage = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"50"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"In this case, any value informed below 50, would result in the order being rejected."},"children":[],"type":"text"}],"type":"paragraph"}]},"payments":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Payments Info. It informs the payment methods chosen by the consumer in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". This section should be used by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to check how much the delivery person should receive from the consumer when delivering the order."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"method":{"type":"string","description":"OFFLINE - The order will be paid by the consumer at the time the order is received.  \nONLINE - The order has already been paid through the order application.","enum":["OFFLINE","ONLINE"]},"wirelessPos":{"type":"boolean","description":"Indicates whether the delivery person should take the wireless payment device with him."},"offlineMethod":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If the method is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"OFFLINE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", the payment information should be provided."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"object","description":"","properties":{"type":{"type":"string","enum":["CREDIT","DEBIT","MEAL_VOUCHER","FOOD_VOUCHER","PIX","CASH","CREDIT_DEBIT","OTHER"]},"amount":{"allOf":[{"$ref":"#/components/schemas/Price"}]}}},"maxItems":100},"change":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If type is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CASH"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", tells how much change will be needed."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]}}},"combinedOrdersIds":{"type":"array","description":"Combined Orders Ids. Informs the logistics service of the Id of other orders already in progress so that the operator can combine these orders. This combination may or may not be accepted by the logistic service, respecting the contracted policies.","items":{"type":"string"},"maxItems":10},"sourceAppId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field must be filled in with the AppId of "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that originated the order. This field is to help the applications that will work as a Hub, intermediating the requests from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" with the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"sourceOrderId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field must be filled in with the original OrderId generated by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". In most cases this property will have the same value as the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"orderId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" property, since it is already recommended that the order id created by "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" be sent in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"orderId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" property. But if the order id created by  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is not sent in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"orderId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" property then it must be entered in this field."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/Vehicle":{"id":"components/schemas/Vehicle","kind":"json-schema","title":"Vehicle","data":{"description":"Vehicle Object.","type":"object","required":["type","container"],"properties":{"type":{"type":"array","description":"Vehicle Type","items":{"type":"string","enum":["MOTORBIKE_BAG","MOTORBIKE_BOX","CAR","BICYCLE","SCOOTER","VUC"]},"maxItems":10},"container":{"type":"string","description":"Vehicle container (bag) type.","enum":["NORMAL","THERMIC"]},"containerSize":{"type":"string","description":"Vehicle container (bag) size.","enum":["SMALL","MEDIUM","LARGE","EXTRA_LARGE"]},"instruction":{"type":"string","description":"Free text to describe special instructions that may apply. These instructions can be used to give some special guidance to the delivery person at the time of the pickup or delivery."}}}},"components/schemas/DeliveryOrderResponse":{"id":"components/schemas/DeliveryOrderResponse","kind":"json-schema","title":"DeliveryOrderResponse","data":{"description":"Delivery Order Response Object.","type":"object","required":["deliveryId","event","completion"],"properties":{"deliveryId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The delivery Id generated by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"48ae4d68-6626-11ed-9022-0242ac120002"},"event":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Current event of the order. It is expected to be sent with the value "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" at this moment, since the acceptance or rejection of the request will be processed asynchronously."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["PENDING","ACCEPTED","REJECTED","PICKUP_ONGOING","ARRIVED_AT_MERCHANT","ORDER_PICKED","DELIVERY_ONGOING","ARRIVED_AT_CUSTOMER","ORDER_DELIVERED","RETURNING_TO_MERCHANT","RETURNED_TO_MERCHANT","DELIVERY_FINISHED","CANCELLED"]},"completion":{"type":"object","description":"Informs the expected date and time for sending the acceptance or refusal of the delivery order.","properties":{"estimate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Expected date and time for completion."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"rejectAfter":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum date and time to wait for the acceptance or refusal of the order. After this time the delivery request should be disregarded and a new request should be made."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"deliveryDetailsURL":{"type":"string","format":"URI","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"It is the URL where the delivery information can be found."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"It should return the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/logisticDetails"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /logistics/delivery/{orderId}"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" route for this order.\""},"children":[],"type":"text"}],"type":"paragraph"}],"example":"http://yourApiBaseUrl.com/v1/logistics/delivery/52122852-6626-11ed-9022-0242ac120002"}}}},"components/schemas/DeliveryOrderEvent":{"id":"components/schemas/DeliveryOrderEvent","kind":"json-schema","title":"DeliveryOrderEvent","data":{"description":"Delivery Order Event Object.","type":"object","required":["deliveryId","orderId","orderDisplayId","merchant","event","customerName"],"properties":{"deliveryId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The delivery ID generated by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"48ae4d68-6626-11ed-9022-0242ac120002"},"orderId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The orderId generated by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"52122852-6626-11ed-9022-0242ac120002"},"orderDisplayId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Order Id shown in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" interface for the customer."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"96b41025"},"merchant":{"type":"object","required":["id","name"],"description":"Merchant information.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"name":{"type":"string","description":"Merchant Public Name","maxLength":500,"example":"Pizza Plaza"}}},"event":{"description":"Current Event Info.","allOf":[{"$ref":"#/components/schemas/DeliveryEvent"}]},"problem":{"type":"array","description":"List of problems that may occur.","items":{"allOf":[{"$ref":"#/components/schemas/DeliveryProblem"}]}},"customerName":{"type":"string","description":"Customer Name."},"vehicle":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Chosen Vehicle Info."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"event > type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is different from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/ChosenVehicle"}]},"deliveryPrice":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Pricing Info."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"event > type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is different from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/DeliveryPrice"}]},"eta":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Estimate Times of Pickup and Delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"event > type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is different from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/ETA"}]},"deliveryPerson":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Person Info."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"event > type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is different from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/DeliveryMan"}]},"geoLocalization":{"description":"Geo Localization Info.","allOf":[{"$ref":"#/components/schemas/GeoLocalization"}]},"externalTrackingURL":{"type":"string","format":"URI","description":"External URL, provided by the logistics service to track the delivery on a specific page. Example: Real-time map view, or delivery timeline."},"combinedOrdersIds":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Combined Orders Ids. Informs which other orders from the same merchant are being carried by the same delivery person, with the same "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"deliveryId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string"}}}}},"components/schemas/DeliveryEvent":{"id":"components/schemas/DeliveryEvent","kind":"json-schema","title":"DeliveryEvent","data":{"description":"Delivery Event Object.","type":"object","required":["type","datetime"],"properties":{"type":{"type":"string","description":"The current delivery event.","enum":["PENDING","ACCEPTED","REJECTED","PICKUP_ONGOING","ARRIVED_AT_MERCHANT","ORDER_PICKED","DELIVERY_ONGOING","ARRIVED_AT_CUSTOMER","ORDER_DELIVERED","RETURNING_TO_MERCHANT","RETURNED_TO_MERCHANT","DELIVERY_FINISHED","CANCELLED"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."},"datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the event ocurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"rejectionInfo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Rejection Info. It should be informed to provide more information when the event type is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/DeliveryEventDenied"}]}}}},"components/schemas/DeliveryEventDenied":{"id":"components/schemas/DeliveryEventDenied","kind":"json-schema","title":"DeliveryEventDenied","data":{"description":"Delivery Event Denied Object.","type":"object","required":["reason"],"discriminator":{"propertyName":"reason","mapping":{"PRICE_EXCEEDED":"#/components/schemas/DeliveryEventDeniedPrice","VEHICLE_NOT_AVAILABLE":"#/components/schemas/DeliveryEventDeniedVehicle","NO_DELIVERYPERSON_AVAILABLE":"#/components/schemas/DeliveryEventDeniedNoDeliveryMan","DOES_NOT_MEET_REQUESTED_TIMES":"#/components/schemas/DeliveryEventDeniedEta","REGION_NOT_SERVED":"#/components/schemas/DeliveryEventDenied","INVALID_ADDRESS":"#/components/schemas/DeliveryEventDenied","OTHER":"#/components/schemas/DeliveryEventDenied"}},"properties":{"reason":{"type":"string","description":"Rejection reason.","enum":["PRICE_EXCEEDED","VEHICLE_NOT_AVAILABLE","NO_DELIVERYPERSON_AVAILABLE","DOES_NOT_MEET_REQUESTED_TIMES","REGION_NOT_SERVED","OTHER"]}}}},"components/schemas/DeliveryEventDeniedVehicle":{"id":"components/schemas/DeliveryEventDeniedVehicle","kind":"json-schema","title":"DeliveryEventDeniedVehicle","data":{"description":"Metadata","allOf":[{"$ref":"#/components/schemas/DeliveryEventDenied"},{"type":"object"},{"properties":{"metadata":{"type":"object","description":"Information about vehicles availability at the moment.","properties":{"availableVehicles":{"type":"integer","description":"Informs how many vehicles are available at the moment."},"vehiclesAvailable":{"description":"List of currently available vehicles.","allOf":[{"$ref":"#/components/schemas/Vehicle"}]},"nextAvailableVehicle":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs how soon the next vehicle will be available in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}}}}]}},"components/schemas/DeliveryEventDeniedPrice":{"id":"components/schemas/DeliveryEventDeniedPrice","kind":"json-schema","title":"DeliveryEventDeniedPrice","data":{"description":"Metadata","allOf":[{"$ref":"#/components/schemas/DeliveryEventDenied"},{"type":"object"},{"properties":{"metadata":{"type":"object","description":"The actual delivery price calculated according to the data given in the request.","allOf":[{"$ref":"#/components/schemas/DeliveryPrice"}]}}}]}},"components/schemas/DeliveryEventDeniedNoDeliveryMan":{"id":"components/schemas/DeliveryEventDeniedNoDeliveryMan","kind":"json-schema","title":"DeliveryEventDeniedNoDeliveryMan","data":{"description":"Metadata","allOf":[{"$ref":"#/components/schemas/DeliveryEventDenied"},{"type":"object"},{"properties":{"metadata":{"type":"object","description":"Information about delivery person availability.","properties":{"nextAvailableVehicle":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs how soon the next delivery person will be available in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}}}}]}},"components/schemas/DeliveryEventDeniedEta":{"id":"components/schemas/DeliveryEventDeniedEta","kind":"json-schema","title":"DeliveryEventDeniedEta","data":{"description":"Metadata","allOf":[{"$ref":"#/components/schemas/DeliveryEventDenied"},{"type":"object"},{"properties":{"metadata":{"type":"object","description":"The actual ETAs calculated according to the data given in the request.","allOf":[{"$ref":"#/components/schemas/ETA"}]}}}]}},"components/schemas/DeliveryProblem":{"id":"components/schemas/DeliveryProblem","kind":"json-schema","title":"DeliveryProblem","data":{"description":"Delivery Problem Object.","type":"object","required":["reason","datetime","canFinishDeliver","needMerchantAction"],"properties":{"reason":{"type":"string","description":"Problem reason.","enum":["DELIVERYPERSON_OCCURRENCE","PAYMENT_PROBLEMS","WRONG_PRODUCT_OR_ITEM","ORDER_DELAYED","ORDER_DAMAGED_OR_VIOLATED","CUSTOMER_DID_NOT_PLACE_ORDER","CUSTOMER_ADDRESS_UNKNOWN","ORDER_MISSING_ITEMS","NOBODY_TO_RECEIVE","DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER","ORDER_DELIVERED_WITHOUT_PAYMENT","FRAUD_OR_THEFT","OTHER"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."},"datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the problem ocurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"canFinishDeliver":{"type":"boolean","description":"Informs whether or not it is still possible to finish the delivery."},"needMerchantAction":{"type":"boolean","description":"Informs whether or not the merchant needs to perform some action in order for delivery to continue."}}}},"components/schemas/DeliveryProblemHistory":{"id":"components/schemas/DeliveryProblemHistory","kind":"json-schema","title":"DeliveryProblemHistory","data":{"description":"Delivery Event.","type":"object","required":["reason","datetime","resolved"],"properties":{"reason":{"type":"string","description":"Problem reason.","enum":["DELIVERYPERSON_OCCURRENCE","PAYMENT_PROBLEMS","WRONG_PRODUCT_OR_ITEM","ORDER_DELAYED","ORDER_DAMAGED_OR_VIOLATED","CUSTOMER_DID_NOT_PLACE_ORDER","CUSTOMER_ADDRESS_UNKNOWN","ORDER_MISSING_ITEMS","NOBODY_TO_RECEIVE","DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER","ORDER_DELIVERED_WITHOUT_PAYMENT","FRAUD_OR_THEFT","OTHER"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."},"datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the problem ocurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"resolved":{"type":"boolean","description":"Informs if the problem was resolved or not."},"actionTaken":{"type":"string","description":"Action taken by the requester.","enum":["RETURN_TO_STORE","DELIVER_PRODUCT","CANCEL_DELIVERY"]},"resolutionDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the problem was resolved."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/ChosenVehicle":{"id":"components/schemas/ChosenVehicle","kind":"json-schema","title":"ChosenVehicle","data":{"description":"Delivery Order Response Object","type":"object","required":["type","container"],"properties":{"type":{"type":"string","description":"Vehicle Type.","enum":["MOTORBIKE_BAG","MOTORBIKE_BOX","CAR","BICYCLE","SCOOTER","VUC"]},"container":{"type":"string","description":"The veichle container (bag) type.","enum":["NORMAL","THERMIC"]},"containerSize":{"type":"string","description":"Vehicle container (bag) size.","enum":["SMALL","MEDIUM","LARGE","EXTRA_LARGE"]},"instruction":{"type":"string","description":"Special Instructions."}}}},"components/schemas/DeliveryPrice":{"id":"components/schemas/DeliveryPrice","kind":"json-schema","title":"DeliveryPrice","data":{"description":"Delivery Pricing","type":"object","required":["price","pricingList","additionalPricePercentual"],"properties":{"price":{"description":"The calculated price of the delivery. It may be 0. The price shall be calculated according to the Price List being used, as well as previously established commercial agreements.","allOf":[{"$ref":"#/components/schemas/Price"}]},"pricingList":{"type":"string","description":"Indicates what list was used to calculate the delivery price.","enum":["NORMAL","DYNAMIC"]},"additionalPricePercentual":{"type":"number","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the additional percentage to the list price that was calculated for this delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: List Price = $10"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Actual calculated price = $15"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additonal price percentage = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"50"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}]}}}},"components/schemas/DeliveryAvailabilityPrice":{"id":"components/schemas/DeliveryAvailabilityPrice","kind":"json-schema","title":"DeliveryAvailabilityPrice","data":{"description":"Delivery Order Object","type":"object","required":["pickupAddress","returnToMerchant","canCombine","deliveryAddress","vehicle","limitTimes","totalOrderPrice","totalWeight"],"properties":{"merchant":{"type":"object","required":["id","name"],"description":"Merchant information.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"name":{"type":"string","description":"Merchant Public Name","maxLength":500,"example":"Pizza Plaza"}}},"pickupAddress":{"description":"Pickup Address.","allOf":[{"$ref":"#/components/schemas/AddressLogistics"},{"type":"object","properties":{"pickupLocation":{"type":"string","description":"Pickup Location"},"parkingSpace":{"type":"boolean","description":"Parking Space"},"instructions":{"type":"string","description":"Instructions"}}}]},"returnToMerchant":{"type":"boolean","description":"Inform whether the delivery person should return to the pickup address after the delivery has been made."},"canCombine":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Inform whether the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" can combine this order with other orders in the same delivery."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryAddress":{"description":"Delivery Address","allOf":[{"$ref":"#/components/schemas/AddressLogistics"},{"type":"object","properties":{"instructions":{"type":"string","description":"Instructions"}}}]},"vehicle":{"description":"Vehicle Info. informs which vehicle options are to be used for delivery. More than one can be informed, but the logistics service must choose only one of the types of vehicles informed.","allOf":[{"$ref":"#/components/schemas/Vehicle"}]},"limitTimes":{"type":"object","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Limit Times. Informs the maximum pickup and delivery times that must be met by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"properties":{"pickupLimit":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pickup Limit in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". It should be used to inform the maximum amount of minutes from the time the request was made to which the order should be collected at the merchant."},"children":[],"type":"text"}],"type":"paragraph"}],"example":23},"deliveryLimit":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Limit in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". It should be used to inform the maximum amount of minutes from the time the request was made to which the order should be delivered at the consumer's address."},"children":[],"type":"text"}],"type":"paragraph"}],"example":48},"orderCreatedAt":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The date and time that the Order was created at  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"totalOrderPrice":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total order price that was calculated and displayed for the final consumer in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". This value may already contain taxes and shipping in addition to the value of the items purchased."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"orderDeliveryFee":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This field informs the delivery fee paid by the consumer in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/Price"}]},"totalWeight":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total Weight in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"grams"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"}]},"packageVolume":{"type":"number","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The cubage of the packaging in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"cubic meters (m³)"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"packageQuantity":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Number of packages that will be transported in this order. For example, 2 packages, or 3 boxes."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The unit of measure will not be considered, only the quantity."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}]},"specialInstructions":{"type":"string","description":"Free text to describe special instructions that may apply."},"additionalPricePercentual":{"type":"number","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates to the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistic Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" an additional percentage to the list price that the requester agrees to pay for the delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The delivery request will be refused if the delivery price exceeds this value."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Example: List Price = $10"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Actual calculated price = $15"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Additonal price percentage = "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"50"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"In this case, any value informed below 50, would result in the order being rejected."},"children":[],"type":"text"}],"type":"paragraph"}]},"onlinePayment":{"type":"boolean","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs whether or not the payment has already been made in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"}],"type":"paragraph"}]}}}},"components/schemas/DeliveryAvailabilityPriceResponse":{"id":"components/schemas/DeliveryAvailabilityPriceResponse","kind":"json-schema","title":"DeliveryAvailabilityPriceResponse","data":{"description":"Delivery Order Response Object","type":"object","properties":{"deliveryPrice":{"description":"Delivery Pricing Info.","allOf":[{"$ref":"#/components/schemas/DeliveryPrice"}]},"vehicles":{"type":"object","description":"Chosen Vehicle Info.","properties":{"availableVehicles":{"type":"integer","description":"Informs how many vehicles are available at the moment."},"vehiclesAvailable":{"description":"List of currently available vehicles.","allOf":[{"$ref":"#/components/schemas/Vehicle"}]},"nextAvailableVehicle":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Informs how soon the next vehicle will be available in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]}}},"ETAs":{"description":"ETAs","allOf":[{"$ref":"#/components/schemas/ETA"}]}}}},"components/schemas/ETA":{"id":"components/schemas/ETA","kind":"json-schema","title":"ETA","data":{"description":"ETA","type":"object","required":["updateMethod","pickupEtaInMinutes","pickupEtaDatetime","deliveryEtaInMinutes","deliveryEtaDatetime","maxDeliveryTime"],"properties":{"updateMethod":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Update Method: Indicates how the times will be updated in the events."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OFFLINE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The time will be calculated in the event "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"ACCEPTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and will no longer be updated in the following events."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ONLINE"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The time will be updated in all events. In this case, when the collection has already occurred, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"pickupEtaInMinutes"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" property will be set to "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"0"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"pickupEtaDatetime"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" property will be the time when the collection occurred."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["OFFLINE","ONLINE"]},"pickupEtaInMinutes":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pickup Eta in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Informs how many minutes it will take the delivery person to arrive at the merchant for order pickup."},"children":[],"type":"text"}],"type":"paragraph"}]},"pickupEtaDatetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pickup Eta Datetime. Informs the date and time the delivery person is expected to arrive at the merchant for order pickup."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryEtaInMinutes":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Eta in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Informs how many minutes it will take the delivery person to arrive at the consumer's address for order delivery."},"children":[],"type":"text"}],"type":"paragraph"}]},"deliveryEtaDatetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Eta Datetime. Informs the date and time the delivery person is expected to arrive at the consumer's address for order delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"returnToMerchantEtaInMinutes":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Person return to merchant Eta in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"minutes"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Informs how many minutes it will take the delivery person to return to the merchant. Only valid when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"returnToMerchant"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"returnToMerchantEtaDatetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Person return to merchant Eta Datetime. Informs the date and time the delivery person will arrive at the returning merchant. Only valid when "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"returnToMerchant"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"true"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"maxDeliveryTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum Date and Time for delivery. This time should not exceed the delivery time limit given in the order request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/DeliveryMan":{"id":"components/schemas/DeliveryMan","kind":"json-schema","title":"DeliveryMan","data":{"description":"Delivery Person","type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Person Id generated at the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"name":{"type":"string","description":"Delivery Person Name."},"pictureURL":{"type":"string","format":"URI","description":"URL to access the photo of the delivery person. Before entering this field, check that the parties allow data to be shared according to data disclosure laws and rules."},"phone":{"type":"string","description":"Delivery Person Phone. Before entering this field, check that the parties allow data to be shared according to data disclosure laws and rules."}}}},"components/schemas/GeoLocalization":{"id":"components/schemas/GeoLocalization","kind":"json-schema","title":"GeoLocalization","data":{"description":"Delivery Event","type":"object","required":["latitude","longitude"],"properties":{"latitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the latitude coordinate of the actual position of the delivery person."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Latitude in degrees. Values are restricted to the range [[-90, 90]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-23.54809},"longitude":{"type":"number","format":"float","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indicates the longitude coordinate of the actual position of the delivery person."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Longitude in degrees. Values are restricted to the range [[-180, 180]]."},"children":[],"type":"text"}],"type":"paragraph"}],"example":-46.63638},"lastAddress":{"description":"The last known address that the delivery person was when the event was sent.","type":"object","required":["distanceToPickup","distanceToDelivery","timestamp"],"properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Two-letter "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72482.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" country code."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR"},"state":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"State or country subdivision. It is recommended (but not required) that you use the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://www.iso.org/standard/72483.html"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ISO 3166-2"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" representation."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"BR-SP"},"city":{"type":"string","description":"City name.","example":"São Paulo"},"district":{"type":"string","description":"District or Neighborhood name.","example":"Moema"},"street":{"type":"string","description":"Street Name.","example":"Plaza Avenue"},"postalCode":{"type":"string","description":"Postal Code.","example":"20111-000"},"distanceToPickup":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Distance To Pickup in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"meters"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"distanceToDelivery":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Distance To Delivery in "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"meters"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"timestamp":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when this information is valid."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}}}}},"components/schemas/DeliveryCancel":{"id":"components/schemas/DeliveryCancel","kind":"json-schema","title":"DeliveryCancel","data":{"description":"Delivery Cancel","type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"Cancel Reason.","enum":["CONSUMER_CANCELLATION_REQUESTED","NO_SHOW","PROBLEM_AT_MERCHANT","HIGH_ACCEPTANCE_TIME","INCORRECT_ORDER_OR_PRODUCT_PICKUP","PROBLEM_RESOLUTION","DISCOMBINE_ORDER","OTHER"]},"action":{"type":"string","description":"Action to be taken by the delivery person, after the cancellation.","enum":["RETURN_TO_STORE","CANCEL_DELIVERY"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."}}}},"components/schemas/DeliveryCancelResponse":{"id":"components/schemas/DeliveryCancelResponse","kind":"json-schema","title":"DeliveryCancelResponse","data":{"type":"object","required":["additionalCharges"],"properties":{"additionalCharges":{"type":"boolean","description":"Informs whether or not the cancellation will cause an additional charge to the delivery."}}}},"components/schemas/DeliveryHandleProblem":{"id":"components/schemas/DeliveryHandleProblem","kind":"json-schema","title":"DeliveryHandleProblem","data":{"description":"Delivery Cancel","type":"object","required":["reason","action"],"properties":{"reason":{"type":"string","description":"Problem Reason.","enum":["DELIVERYPERSON_OCCURRENCE","PAYMENT_PROBLEMS","WRONG_PRODUCT_OR_ITEM","ORDER_DELAYED","ORDER_DAMAGED_OR_VIOLATED","CUSTOMER_DID_NOT_PLACE_ORDER","CUSTOMER_ADDRESS_UNKNOWN","ORDER_MISSING_ITEMS","NOBODY_TO_RECEIVE","DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER","ORDER_DELIVERED_WITHOUT_PAYMENT","FRAUD_OR_THEFT","OTHER"]},"action":{"type":"string","description":"The action that the delivery person should take to solve this problem.","enum":["RETURN_TO_STORE","DELIVER_PRODUCT","CANCEL_DELIVERY"]},"message":{"type":"string","description":"Free message. It should be used to provide more detailed information."}}}},"components/schemas/DeliveryOrderPicked":{"id":"components/schemas/DeliveryOrderPicked","kind":"json-schema","title":"Order Picked","data":{"type":"object","title":"Order Picked","properties":{"pickupDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the order pickup occurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"volumePicked":{"type":"integer","description":"Number of volumes picked up."},"observation":{"type":"string","description":"Free text. It should be used to provide more detailed information."}}}},"components/schemas/DeliveryOrderFinish":{"id":"components/schemas/DeliveryOrderFinish","kind":"json-schema","title":"Order Picked","data":{"type":"object","title":"Order Picked","required":["finishDate"],"properties":{"finishDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when delivery completion occurred."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"observation":{"type":"string","description":"Free text. It should be used to provide more detailed information."}}}},"components/schemas/DeliveryOrderDetails":{"id":"components/schemas/DeliveryOrderDetails","kind":"json-schema","title":"DeliveryOrderDetails","data":{"description":"Delivery Order Details Object","type":"object","required":["deliveryId","orderId","orderDisplayId","merchant","customerName","events"],"properties":{"deliveryId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The delivery ID generated by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"orderId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The orderId generated by the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}]},"orderDisplayId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Order Id shown in the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" interface for the customer."},"children":[],"type":"text"}],"type":"paragraph"}],"example":"96b41025"},"merchant":{"type":"object","required":["id","name"],"description":"Merchant information.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"name":{"type":"string","description":"Merchant Public Name","maxLength":500,"example":"Pizza Plaza"}}},"customerName":{"type":"string","description":"Customer Name."},"customerPhone":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Customer's telephone number."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Please note"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": The telephone number is considered an identification field and therefore the customer's advance consent is required."},"children":[],"type":"text"}],"type":"paragraph"}]},"events":{"type":"array","description":"Events History.","items":{"allOf":[{"$ref":"#/components/schemas/DeliveryEvent"}]}},"problem":{"type":"array","description":"History of problems that occuried during delivery.","items":{"allOf":[{"$ref":"#/components/schemas/DeliveryProblemHistory"}]}},"vehicle":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Chosen Vehicle Info."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when current "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"event > type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is different from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/ChosenVehicle"}]},"deliveryPrice":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Pricing Info."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when current "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"event > type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is different from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/DeliveryPrice"}]},"times":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Estimate Times of Pickup and Delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"This propertie is "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"REQUIRED"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" when current "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"event > type"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is different from "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PENDING"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REJECTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"}],"type":"paragraph"}],"type":"blockquote"}],"allOf":[{"$ref":"#/components/schemas/DeliveryTimes"}]},"deliveryPerson":{"description":"Delivery person Info.","allOf":[{"$ref":"#/components/schemas/DeliveryMan"}]},"combinedOrdersIds":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Combined Orders Ids. Informs which other orders from the same merchant are being carried by the same delivery person, with the same "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"deliveryId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"}],"items":{"type":"string"}},"externalTrackingURL":{"type":"string","format":"URI","description":"External URL, provided by the logistics service to track the delivery on a specific page. Example: Real-time map view, or delivery timeline."}}}},"components/schemas/DeliveryTimes":{"id":"components/schemas/DeliveryTimes","kind":"json-schema","title":"DeliveryTimes","data":{"description":"ETA","type":"object","required":["deliveryEtaDate","maxDeliveryTime","isDeliveryFinished"],"properties":{"deliveryEtaDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Delivery Eta Datetime. Informs the date and time the delivery person is expected to arrive at the consumer's address for order delivery."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"maxDeliveryTime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Maximum Date and Time for delivery. This time should not exceed the delivery time limit given in the order request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]},"isDeliveryFinished":{"type":"boolean","description":"Informs whether or not the delivery is finished."},"deliveryFinishDate":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Date and time when the delivery finished."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"(UTC date-time in ISO timestamp format. See "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#section/General-Guidelines"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Guidelines"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for more info)."},"children":[],"type":"text"}],"type":"paragraph"}]}}}},"components/schemas/DeliveryConfirmationCode":{"id":"components/schemas/DeliveryConfirmationCode","kind":"json-schema","title":"DeliveryConfirmationCode","data":{"description":"Delivery Confirmation Object.","type":"object","required":["orderId","deliveryCode"],"properties":{"orderId":{"type":"string","description":"The orderId informed in the Delivery Request.","example":"52122852-6626-11ed-9022-0242ac120002"},"deliveryCode":{"type":"string","description":"Delivery confirmation code provided by the customer."}}}},"components/schemas/MerchantData":{"id":"components/schemas/MerchantData","kind":"json-schema","title":"MerchantData","data":{"description":"Delivery Confirmation Object.","type":"object","required":["userId","brandId","brandName","authorizedShops","page"],"properties":{"userId":{"type":"integer","format":"int64","description":"Keeta brand account ID","example":12345678},"brandId":{"type":"integer","description":"Keeta brand ID","example":1001},"brandName":{"type":"string","description":"Keeta brand name","example":"Sample Brand"},"authorizedShops":{"type":"array","description":"List of authorized stores","items":{"$ref":"#/components/schemas/AuthorizedShop"}},"page":{"$ref":"#/components/schemas/PageInfo"}}}},"components/schemas/AuthorizedShop":{"id":"components/schemas/AuthorizedShop","kind":"json-schema","title":"AuthorizedShop","data":{"type":"object","required":["id","name","address","longitude","latitude","timeZone"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique store identifier","example":159416882},"name":{"type":"string","description":"Store name","example":"stbaxi3 - API Test store"},"address":{"type":"string","description":"Store address","example":"Rua Augusta, 500, São Paulo, SP, Brasil"},"longitude":{"type":"number","format":"double","description":"Longitude coordinate","example":46.049568},"latitude":{"type":"number","format":"double","description":"Latitude coordinate","example":-18.770281},"timeZone":{"type":"string","description":"Time zone information","example":"America/Sao_Paulo"}}}},"components/schemas/PageInfo":{"id":"components/schemas/PageInfo","kind":"json-schema","title":"PageInfo","data":{"type":"object","required":["pageNum","pageSize","totalPage","totalCount"],"properties":{"pageNum":{"type":"integer","description":"Current page number starting from 1","example":1},"pageSize":{"type":"integer","description":"Number of items per page","example":10},"totalPage":{"type":"integer","description":"Total number of pages","example":1},"totalCount":{"type":"integer","description":"Total number of records","example":3}}}},"components/schemas/WebhookNotification":{"id":"components/schemas/WebhookNotification","kind":"json-schema","title":"WebhookNotification","data":{"type":"object","required":["clientId","authId","opType","shopId","shopName","createTime"],"properties":{"clientId":{"type":"integer","format":"int64","description":"Application ID identifying the Software Services application","example":2666245991},"authId":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Authorization ID that uniquely identifies a specific authorization session. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Each authorization generates a unique authId. There are two ways to obtain the authId: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" 1. Merchant authorization redirect - the authId is included in the redirect URL        "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" 2. Keeta Authorization Webhook - the authId is provided in the webhook payload "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" Please refer to the following for the specific workflow:"},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"/en/apis/opendelivery/merchant-self-serve-authorization"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Merchant Self-serve Authorization"},"children":[],"type":"text"}],"type":"link"}],"type":"paragraph"}],"example":"41008"},"opType":{"type":"integer","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Operation type: 1 = Add authorization, 2 = Cancel authorization"},"children":[],"type":"text"}],"type":"paragraph"}],"enum":[1,2],"example":1},"shopId":{"type":"integer","format":"int64","description":"Store ID","example":478268},"shopName":{"type":"string","description":"Store name","example":"10 Shanghai"},"createTime":{"type":"integer","format":"int64","description":"Event timestamp in milliseconds","example":1753151456973}}}},"components/schemas/WebhookResponse":{"id":"components/schemas/WebhookResponse","kind":"json-schema","title":"WebhookResponse","data":{"type":"object","required":["status","title"],"properties":{"status":{"type":"integer","description":"Response code, 0 indicates success","example":0},"title":{"type":"string","description":"Response message","example":"success"}}}},"schema_0":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ClientCredentialsRequest"},{"$ref":"#/components/schemas/ShopLevelAuthorizationCodeRequest"},{"$ref":"#/components/schemas/RefreshTokenRequest"}],"discriminator":{"propertyName":"grant_type","mapping":{"app_level_token":"#/components/schemas/ClientCredentialsRequest","shop_level_authorization_code":"#/components/schemas/ShopLevelAuthorizationCodeRequest","refresh_token":"#/components/schemas/RefreshTokenRequest"}}},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/TokenResponseClientCredentials"},{"$ref":"#/components/schemas/TokenResponseWithRefreshToken"},{"$ref":"#/components/schemas/TokenResponseWithRefreshToken"}],"discriminator":{"propertyName":"grant_type","mapping":{"refresh_token":"#/components/schemas/TokenResponseWithRefreshToken","shop_level_authorization_code":"#/components/schemas/TokenResponseWithRefreshToken","app_level_token":"#/components/schemas/TokenResponseClientCredentials"}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"merchantAuthorizationUrl":{"type":"string","description":"Authorization URL for merchant","example":"https://merchant.mykeeta.com/m/web/openapi/authorize?locale=en&region=BR&cityId=110200008&risk_cost_id=&responseType=client_credentials&appId=2123830428&redirectUri=&state=&scope=all/#/app-activation"}},"required":["merchantAuthorizationUrl"]},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer","default":1,"minimum":1},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"integer","default":10,"minimum":1,"maximum":100},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","format":"SHA256","description":"SHA256 hash of the request body, using the client secret as the key"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","description":"The ID of the Merchant for whom you want to complete or change registration info."},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","description":"The unique identifier of the merchant. The merchantId is generated by the Software Service."},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"required":["imageData","imageName"],"type":"object","properties":{"imageData":{"type":"string","format":"binary","description":"The byte array of the image."},"imageName":{"type":"string","description":"The name of the image."}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"string","description":"image URL","example":"https://abrasel-nacional.github.io/opendelivery/images/wertwr34ebh67thook.png"}}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"array","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Desired event types. All other events not selected by group will be automatically acknowledged and omitted from the response."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"Must either be omitted or non-empty."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Event Types definitions:"},"children":[],"type":"text"}],"type":"strong"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CREATED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Order created."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CONFIRMED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Order confirmed."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"READY_FOR_PICKUP"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":": Order ready for pickup by the customer or delivery person."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DISPATCHED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Order went out for delivery."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"PICKED_UP"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Order has been picked up by customer. Since there is currently no self-pickup scenario, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PICKED_UP"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" event will not be received."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"DELIVERED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Order has been delivered to customer."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CONCLUDED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Order completed."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLATION_REQUESTED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Sent by the Software Service to Keeta."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"CANCELLED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : When the order is actually cancelled."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"USER_REFUND_REQUEST"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Sent by Keeta to the Software Service."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REFUNDED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Sent by Keeta to the Software Service."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"REFUND_FAILED"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Sent by Keeta to the Software Service."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"RECOMMENDED_PREPARATION_START"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" : Sent by Keeta to notify the merchant to begin kitchen preparation immediately."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"items":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The event type. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/pollingEvents"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Click here"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" for definitions of each type."},"children":[],"type":"text"}],"type":"paragraph"}],"enum":["CREATED","CONFIRMED","DISPATCHED","READY_FOR_PICKUP","PICKED_UP","DELIVERED","CONCLUDED","CANCELLATION_REQUESTED","CANCELLED","USER_REFUND_REQUEST","REFUNDED","REFUND_FAILED","RECOMMENDED_PREPARATION_START"]},"maxItems":13},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","description":"Subset of merchants to fetch events from. Must either be omitted or non-empty.","items":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's Software Service."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"maxItems":100},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AckEvents"},"maxItems":100},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"An unique Identificator of the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"**Keetas**"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". The same ID must be sent to all "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"**Software Service**s"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" that implements this webhook."},"children":[],"type":"text"}],"type":"paragraph"}]},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Merchant/properties/id","description":"An unique Identificator of the Merchant "},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","format":"SHA256","description":"SHA256 hash of the request body, using the client secret as the key, and finally encoded into Base64 format."},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Unique Identifier. Identifies the merchant in the different systems that the merchant will communicate."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"hardbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"This id must be generated by the merchant's "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"code"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The software service should ensure that merchantId is unique."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"If this is not possible, it is recommended to at least use a UUID."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"minLength":36,"maxLength":100,"example":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","description":"The unique identifier of the order. The order ID is generated by  Keeta."},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"string","description":"The unique identifier of the order. The order ID is generated by Keeta."},"id":"schema_19"}},"exampleStore":{"components/examples/tokenExample":{"id":"components/examples/tokenExample","value":{"client_id":"user1234","client_secret":"ty23yhmas4ldfias9834023jsdf032j023f02","grant_type":"app_level_token"},"summary":"New Token"},"components/examples/merchantStatusExample":{"id":"components/examples/merchantStatusExample","value":{"status":"AVAILABLE","services":[{"id":"string","serviceType":"DELIVERY","serviceHours":{"weekHours":[{"dayOfWeek":["WEDNESDAY","MONDAY","THURSDAY","SUNDAY","FRIDAY","TUESDAY","SATURDAY"],"timePeriods":{"startTime":"00:00:00.000Z","endTime":"03:00:00.000Z"}},{"dayOfWeek":["WEDNESDAY","MONDAY","THURSDAY","SUNDAY","TUESDAY","FRIDAY","SATURDAY"],"timePeriods":{"startTime":"03:00:00.000Z","endTime":"23:59:59.999Z"}}],"holidayHours":[{"date":"2025-10-04","timePeriods":{"startTime":"00:00:00.000Z","endTime":"01:05:00.000Z"}},{"date":"2025-10-03","timePeriods":{"startTime":"00:00:00.000Z","endTime":"01:05:00.000Z"}},{"date":"2025-10-02","timePeriods":{"startTime":"00:00:00.000Z","endTime":"01:05:00.000Z"}},{"date":"2025-10-03","timePeriods":{"startTime":"20:00:00.000Z","endTime":"23:59:59.999Z"}},{"date":"2025-10-01","timePeriods":{"startTime":"20:00:00.000Z","endTime":"23:59:59.999Z"}},{"date":"2025-10-02","timePeriods":{"startTime":"20:00:00.000Z","endTime":"23:59:59.999Z"}}]}}],"merchantSourceAppId":"Keeta"},"summary":"MerchantStatus Example"},"components/examples/merchantExample":{"id":"components/examples/merchantExample","value":{"lastUpdate":"2021-05-27T20:45:10.332Z","TTL":500,"id":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824","status":"AVAILABLE","basicInfo":{"name":"Pizza Plaza","document":"22815773000169","corporateName":"Food Company","description":"Food company specializing in pizzas.","averageTicket":90,"averagePreparationTime":20,"minOrderValue":{"value":20,"currency":"BRL"},"merchantType":"RESTAURANT","merchantCategories":["PIZZA","FAMILY_MEALS","PREMIUM"],"address":{"country":"BR","state":"SP","city":"São Paulo","district":"Moema","street":"Plaza Avenue","number":"100","postalCode":"20111-000","complement":"2001","reference":"Yellow house","latitude":-23.54804,"longitude":-46.6363},"contactEmails":["food@company.com"],"contactPhones":{"commercialNumber":"11999999999","whatsappNumber":"11998888888"},"logoImage":{"URL":"https://food-company.com/logo.png","CRC-32":"432098ASDSR"},"bannerImage":{"URL":"https://food-company.com/banner.png","CRC-32":"09345UIHF98"},"createdAt":"2021-05-10T20:45:10.332Z"},"services":[{"id":"f078e8e2-3044-4eec-b4a8-8359810de123","status":"AVAILABLE","serviceType":"DELIVERY","menuId":"f627ccdc-6789-456f-a782-148538d5035b","serviceArea":{"id":"f078e8e2-3044-4eec-b4a8-8359810de124","polygon":[{"geoCoordinates":[{"latitude":-20.2333,"longitude":-20.8383},{"latitude":-20.85008,"longitude":-21.00007},{"latitude":-21.15002,"longitude":-21.95483}],"price":{"value":5,"currency":"BRL"},"estimateDeliveryTime":25}],"geoRadius":{"geoMidpointLatitude":-20.2333,"geoMidpointLongitude":-20.8383,"radius":[{"size":10,"price":{"value":5.5,"currency":"BRL"},"estimateDeliveryTime":10}]}},"serviceHours":{"id":"fb093d8c-2ca5-40fb-afcf-472fbdae81cc","weekHours":[{"dayOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"],"timePeriods":{"startTime":"10:00:00.000Z","endTime":"18:00:00.000Z"}},{"dayOfWeek":["SATURDAY","SUNDAY"],"timePeriods":{"startTime":"14:00:00.000Z","endTime":"18:00:00.000Z"}}],"holidayHours":[{"date":"2021-05-27","timePeriods":{"startTime":"12:00:00.000Z","endTime":"17:00:00.000Z"}}]}}],"items":[{"id":"732bd31e-77fc-47ee-88ee-a0437f97b198","status":"AVAILABLE","name":"Medium - 2 flavors","description":"Medium two-flavored pizza.","externalCode":"23","image":{"URL":"https://www.food-place.com/images/medium-pizza.png","CRC-32":"09345UIHF98"},"serving":8,"unit":"UN"},{"id":"b728fd88-4af0-43f7-956f-95c251f01ddd","status":"AVAILABLE","name":"Small - 1 flavor","description":"Small one-flavored pizza.","externalCode":"23","image":{"URL":"https://www.food-place.com/images/small-pizza.png","CRC-32":"09345UIHF98"},"serving":4,"unit":"UN"},{"id":"502ecf11-0509-48ed-b63c-6211c48fd9b9","status":"AVAILABLE","name":"1/2 Pepperoni","description":"Pepperoni flavored pizza with LOTS of pepperoni.","externalCode":"23","image":{"URL":"https://www.food-place.com/images/pepperoni.png","CRC-32":"09345UIHF98"},"nutritionalInfo":{"description":"Contains preservatives","calories":"2000 Cal","allergen":["GLUTEN"]},"unit":"UN"},{"id":"7e507cab-7235-4f75-a0c2-e955fb2f2048","status":"AVAILABLE","name":"1/2 Mozzarella","description":"Delicious mozzarella pizza.","externalCode":"24","image":{"URL":"https://www.food-place.com/images/mozzarella.png","CRC-32":"09345UIHF98"},"nutritionalInfo":{"description":"Contains preservatives","calories":"2500 Cal","allergen":["GLUTEN","LACTOSE"]},"unit":"UN"},{"id":"2c0f3447-5309-49cc-a167-4eac5c664470","status":"AVAILABLE","name":"Banana","description":"Banana Pizza with cream.","externalCode":"25","image":{"URL":"https://www.food-place.com/images/banana.png","CRC-32":"09345UIHF98"},"nutritionalInfo":{"description":"Contains preservatives","calories":"2500 Cal","allergen":["GLUTEN"]},"unit":"UN"}],"menus":[{"id":"f627ccdc-6789-456f-a782-148538d5035b","name":"Pizzas","description":"Pizza menu","externalCode":"123","disclaimer":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","categoryId":["92fad022-2c28-4239-a026-989f5b555cb7","6bb71850-1d40-49f9-8046-b13e068c0cca"]}],"categories":[{"id":"92fad022-2c28-4239-a026-989f5b555cb7","index":0,"name":"Salted Pizza","description":"Salted pizza flavors.","image":{"URL":"https://food-company.com/category1.png","CRC-32":"09345UIHF98"},"externalCode":"13","status":"AVAILABLE","availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"itemOfferId":["f080cfb3-5c4a-4eb7-907d-2de3bbb5dfb9"]},{"id":"6bb71850-1d40-49f9-8046-b13e068c0cca","index":1,"name":"Sweeted Pizza","description":"Sweeted pizza flavors.","image":{"URL":"https://food-company.com/category2.png","CRC-32":"09345UIHF98"},"externalCode":"13","status":"AVAILABLE","availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"itemOfferId":["377b99ba-5413-43d1-b875-7cdcaa72860e"]}],"itemOffers":[{"id":"f080cfb3-5c4a-4eb7-907d-2de3bbb5dfb9","status":"AVAILABLE","itemId":"732bd31e-77fc-47ee-88ee-a0437f97b198","index":0,"price":{"value":43,"originalValue":43,"currency":"BRL"},"availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"optionGroupsId":["fe67e551-f42f-499a-8afb-0ed893c71fa3"]},{"id":"377b99ba-5413-43d1-b875-7cdcaa72860e","status":"AVAILABLE","itemId":"7e507cab-7235-4f75-a0c2-e955fb2f2048","index":1,"price":{"value":30,"originalValue":30,"currency":"BRL"},"availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"optionGroupsId":["c524c066-96fa-458d-b78c-3712661529b3"]}],"optionGroups":[{"id":"fe67e551-f42f-499a-8afb-0ed893c71fa3","index":0,"name":"Choose your salted pizza flavor","description":"Choose your salted pizza flavor.","externalCode":"12","status":"AVAILABLE","minPermitted":2,"maxPermitted":2,"options":[{"id":"e5232f14-430c-4a94-8ff6-289d5a16a87a","status":"AVAILABLE","itemId":"502ecf11-0509-48ed-b63c-6211c48fd9b9","index":0,"price":{"value":50,"originalValue":50,"currency":"BRL"},"maxPermitted":1},{"id":"e5232f14-430c-4a94-8ff6-289d5a16a87b","status":"AVAILABLE","itemId":"7e507cab-7235-4f75-a0c2-e955fb2f2048","index":1,"price":{"value":43,"originalValue":43,"currency":"BRL"},"maxPermitted":1}]},{"id":"c524c066-96fa-458d-b78c-3712661529b3","index":0,"name":"Choose your sweeted pizza flavor","description":"Choose your sweeted pizza flavor.","externalCode":"12","status":"AVAILABLE","minPermitted":1,"maxPermitted":1,"options":[{"id":"2419d582-357f-4149-9089-12321537f147","status":"AVAILABLE","itemId":"2c0f3447-5309-49cc-a167-4eac5c664470","index":0,"price":{"value":30,"originalValue":30,"currency":"BRL"},"maxPermitted":1}]}],"availabilities":[{"id":"11d063c4-73a7-4f87-a0eb-71636cc02029","startDate":"2021-05-01","endDate":"2021-05-30","hours":[{"dayOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"],"timePeriods":{"startTime":"10:00:00.000Z","endTime":"18:00:00.000Z"}},{"dayOfWeek":["SATURDAY","SUNDAY"],"timePeriods":{"startTime":"14:00:00.000Z","endTime":"18:00:00.000Z"}}]}]},"summary":"Merchant Example"},"paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/responses/200/content/application~1json/examples/success":{"value":{"userId":12345678,"brandId":1001,"brandName":"Sample Brand","authorizedShops":[{"id":159416882,"name":"stbaxi3 - API Test store","address":"Rua Augusta, 500, São Paulo, SP, Brasil","longitude":46.049568,"latitude":-18.770281,"timeZone":"America/Sao_Paulo"}],"page":{"pageNum":1,"pageSize":10,"totalPage":1,"totalCount":3}},"key":"success","summary":"Successful response example","id":"paths/~1oauth~1authorized~1{authId}~1merchantInfo/get/responses/200/content/application~1json/examples/success"},"paths/~1webhook~1authorization/post/requestBody/content/application~1json/example":{"value":{"clientId":2666245991,"authId":"41008","opType":1,"shopId":478268,"shopName":"10 Shanghai","createTime":1753151456973},"id":"paths/~1webhook~1authorization/post/requestBody/content/application~1json/example"},"paths/~1webhook~1authorization/post/responses/400/content/application~1json/example":{"value":{"status":400,"title":"Invalid data format"},"id":"paths/~1webhook~1authorization/post/responses/400/content/application~1json/example"},"paths/~1webhook~1authorization/post/responses/500/content/application~1json/example":{"value":{"status":500,"title":"Internal server error"},"id":"paths/~1webhook~1authorization/post/responses/500/content/application~1json/example"},"paths/~1v1~1merchant/get/responses/200/content/application~1json/examples/menuExample":{"value":{"lastUpdate":"2021-05-27T20:45:10.332Z","TTL":500,"id":"22815773000169-dbc7e35a-c936-4665-9e13-eb55eb8b6824","status":"AVAILABLE","basicInfo":{"name":"Pizza Plaza","document":"22815773000169","corporateName":"Food Company","description":"Food company specializing in pizzas.","averageTicket":90,"averagePreparationTime":20,"minOrderValue":{"value":20,"currency":"BRL"},"merchantType":"RESTAURANT","merchantCategories":["PIZZA","FAMILY_MEALS","PREMIUM"],"address":{"country":"BR","state":"SP","city":"São Paulo","district":"Moema","street":"Plaza Avenue","number":"100","postalCode":"20111-000","complement":"2001","reference":"Yellow house","latitude":-23.54804,"longitude":-46.6363},"contactEmails":["food@company.com"],"contactPhones":{"commercialNumber":"11999999999","whatsappNumber":"11998888888"},"logoImage":{"URL":"https://food-company.com/logo.png","CRC-32":"432098ASDSR"},"bannerImage":{"URL":"https://food-company.com/banner.png","CRC-32":"09345UIHF98"},"createdAt":"2021-05-10T20:45:10.332Z"},"services":[{"id":"f078e8e2-3044-4eec-b4a8-8359810de123","status":"AVAILABLE","serviceType":"DELIVERY","menuId":"f627ccdc-6789-456f-a782-148538d5035b","serviceArea":{"id":"f078e8e2-3044-4eec-b4a8-8359810de124","polygon":[{"geoCoordinates":[{"latitude":-20.2333,"longitude":-20.8383},{"latitude":-20.85008,"longitude":-21.00007},{"latitude":-21.15002,"longitude":-21.95483}],"price":{"value":5,"currency":"BRL"},"estimateDeliveryTime":25}],"geoRadius":{"geoMidpointLatitude":-20.2333,"geoMidpointLongitude":-20.8383,"radius":[{"size":10,"price":{"value":5.5,"currency":"BRL"},"estimateDeliveryTime":10}]}},"serviceHours":{"id":"fb093d8c-2ca5-40fb-afcf-472fbdae81cc","weekHours":[{"dayOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"],"timePeriods":{"startTime":"10:00:00.000Z","endTime":"18:00:00.000Z"}},{"dayOfWeek":["SATURDAY","SUNDAY"],"timePeriods":{"startTime":"14:00:00.000Z","endTime":"18:00:00.000Z"}}],"holidayHours":[{"date":"2021-05-27","timePeriods":{"startTime":"12:00:00.000Z","endTime":"17:00:00.000Z"}}]}}],"items":[{"id":"732bd31e-77fc-47ee-88ee-a0437f97b198","status":"AVAILABLE","name":"Medium - 2 flavors","description":"Medium two-flavored pizza.","externalCode":"23","image":{"URL":"https://www.food-place.com/images/medium-pizza.png","CRC-32":"09345UIHF98"},"serving":8,"unit":"UN"},{"id":"b728fd88-4af0-43f7-956f-95c251f01ddd","status":"AVAILABLE","name":"Small - 1 flavor","description":"Small one-flavored pizza.","externalCode":"23","image":{"URL":"https://www.food-place.com/images/small-pizza.png","CRC-32":"09345UIHF98"},"serving":4,"unit":"UN"},{"id":"502ecf11-0509-48ed-b63c-6211c48fd9b9","status":"AVAILABLE","name":"1/2 Pepperoni","description":"Pepperoni flavored pizza with LOTS of pepperoni.","externalCode":"23","image":{"URL":"https://www.food-place.com/images/pepperoni.png","CRC-32":"09345UIHF98"},"nutritionalInfo":{"description":"Contains preservatives","calories":"2000 Cal","allergen":["GLUTEN"]},"unit":"UN"},{"id":"7e507cab-7235-4f75-a0c2-e955fb2f2048","status":"AVAILABLE","name":"1/2 Mozzarella","description":"Delicious mozzarella pizza.","externalCode":"24","image":{"URL":"https://www.food-place.com/images/mozzarella.png","CRC-32":"09345UIHF98"},"nutritionalInfo":{"description":"Contains preservatives","calories":"2500 Cal","allergen":["GLUTEN","LACTOSE"]},"unit":"UN"},{"id":"2c0f3447-5309-49cc-a167-4eac5c664470","status":"AVAILABLE","name":"Banana","description":"Banana Pizza with cream.","externalCode":"25","image":{"URL":"https://www.food-place.com/images/banana.png","CRC-32":"09345UIHF98"},"nutritionalInfo":{"description":"Contains preservatives","calories":"2500 Cal","allergen":["GLUTEN"]},"unit":"UN"}],"menus":[{"id":"f627ccdc-6789-456f-a782-148538d5035b","name":"Pizzas","description":"Pizza menu","externalCode":"123","disclaimer":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","categoryId":["92fad022-2c28-4239-a026-989f5b555cb7","6bb71850-1d40-49f9-8046-b13e068c0cca"]}],"categories":[{"id":"92fad022-2c28-4239-a026-989f5b555cb7","index":0,"name":"Salted Pizza","description":"Salted pizza flavors.","image":{"URL":"https://food-company.com/category1.png","CRC-32":"09345UIHF98"},"externalCode":"13","status":"AVAILABLE","availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"itemOfferId":["f080cfb3-5c4a-4eb7-907d-2de3bbb5dfb9"]},{"id":"6bb71850-1d40-49f9-8046-b13e068c0cca","index":1,"name":"Sweeted Pizza","description":"Sweeted pizza flavors.","image":{"URL":"https://food-company.com/category2.png","CRC-32":"09345UIHF98"},"externalCode":"13","status":"AVAILABLE","availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"itemOfferId":["377b99ba-5413-43d1-b875-7cdcaa72860e"]}],"itemOffers":[{"id":"f080cfb3-5c4a-4eb7-907d-2de3bbb5dfb9","status":"AVAILABLE","itemId":"732bd31e-77fc-47ee-88ee-a0437f97b198","index":0,"price":{"value":43,"originalValue":43,"currency":"BRL"},"availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"optionGroupsId":["fe67e551-f42f-499a-8afb-0ed893c71fa3"]},{"id":"377b99ba-5413-43d1-b875-7cdcaa72860e","status":"AVAILABLE","itemId":"7e507cab-7235-4f75-a0c2-e955fb2f2048","index":1,"price":{"value":30,"originalValue":30,"currency":"BRL"},"availabilityId":["11d063c4-73a7-4f87-a0eb-71636cc02029"],"optionGroupsId":["c524c066-96fa-458d-b78c-3712661529b3"]}],"optionGroups":[{"id":"fe67e551-f42f-499a-8afb-0ed893c71fa3","index":0,"name":"Choose your salted pizza flavor","description":"Choose your salted pizza flavor.","externalCode":"12","status":"AVAILABLE","minPermitted":2,"maxPermitted":2,"options":[{"id":"e5232f14-430c-4a94-8ff6-289d5a16a87a","status":"AVAILABLE","itemId":"502ecf11-0509-48ed-b63c-6211c48fd9b9","index":0,"price":{"value":50,"originalValue":50,"currency":"BRL"},"maxPermitted":1},{"id":"e5232f14-430c-4a94-8ff6-289d5a16a87b","status":"AVAILABLE","itemId":"7e507cab-7235-4f75-a0c2-e955fb2f2048","index":1,"price":{"value":43,"originalValue":43,"currency":"BRL"},"maxPermitted":1}]},{"id":"c524c066-96fa-458d-b78c-3712661529b3","index":0,"name":"Choose your sweeted pizza flavor","description":"Choose your sweeted pizza flavor.","externalCode":"12","status":"AVAILABLE","minPermitted":1,"maxPermitted":1,"options":[{"id":"2419d582-357f-4149-9089-12321537f147","status":"AVAILABLE","itemId":"2c0f3447-5309-49cc-a167-4eac5c664470","index":0,"price":{"value":30,"originalValue":30,"currency":"BRL"},"maxPermitted":1}]}],"availabilities":[{"id":"11d063c4-73a7-4f87-a0eb-71636cc02029","startDate":"2021-05-01","endDate":"2021-05-30","hours":[{"dayOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"],"timePeriods":{"startTime":"10:00:00.000Z","endTime":"18:00:00.000Z"}},{"dayOfWeek":["SATURDAY","SUNDAY"],"timePeriods":{"startTime":"14:00:00.000Z","endTime":"18:00:00.000Z"}}]}]},"key":"menuExample","summary":"Merchant Example","id":"paths/~1v1~1merchant/get/responses/200/content/application~1json/examples/menuExample"},"paths/~1v1~1merchant~1{id}~1status/get/responses/200/content/application~1json/examples/menuExample":{"value":{"status":"AVAILABLE","services":[{"id":"string","serviceType":"DELIVERY","serviceHours":{"weekHours":[{"dayOfWeek":["WEDNESDAY","MONDAY","THURSDAY","SUNDAY","FRIDAY","TUESDAY","SATURDAY"],"timePeriods":{"startTime":"00:00:00.000Z","endTime":"03:00:00.000Z"}},{"dayOfWeek":["WEDNESDAY","MONDAY","THURSDAY","SUNDAY","TUESDAY","FRIDAY","SATURDAY"],"timePeriods":{"startTime":"03:00:00.000Z","endTime":"23:59:59.999Z"}}],"holidayHours":[{"date":"2025-10-04","timePeriods":{"startTime":"00:00:00.000Z","endTime":"01:05:00.000Z"}},{"date":"2025-10-03","timePeriods":{"startTime":"00:00:00.000Z","endTime":"01:05:00.000Z"}},{"date":"2025-10-02","timePeriods":{"startTime":"00:00:00.000Z","endTime":"01:05:00.000Z"}},{"date":"2025-10-03","timePeriods":{"startTime":"20:00:00.000Z","endTime":"23:59:59.999Z"}},{"date":"2025-10-01","timePeriods":{"startTime":"20:00:00.000Z","endTime":"23:59:59.999Z"}},{"date":"2025-10-02","timePeriods":{"startTime":"20:00:00.000Z","endTime":"23:59:59.999Z"}}]}}],"merchantSourceAppId":"Keeta"},"key":"menuExample","summary":"MerchantStatus Example","id":"paths/~1v1~1merchant~1{id}~1status/get/responses/200/content/application~1json/examples/menuExample"}},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"OAuth2 should be the standard authentication method between parties."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ORDERS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"MERCHANT"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints,  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is responsible for credentials and token generation."},"children":[],"type":"text"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"For the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"LOGISTICS"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoints, the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" will be responsible for managing these infos."},"children":[],"type":"text"}],"type":"item"}],"type":"list"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Webhooks are an exception and have their own authentication method, not using OAuth."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release only one scope will be used for all endpoints: "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"od.all"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Generating a Client Credentials Token"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To generate a client credentials token, the merchant "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" must retrieve the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" from a "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" or "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Logistics Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" company and access the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getToken"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"/oauth/token"},"children":[],"type":"text"}],"type":"link"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Keeta"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" provide one "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientId"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" and "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"clientSecret"},"children":[],"type":"code"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" credentials for  "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":". Each "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software Service"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" is assigned only one client_id and client_secret."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"},{"$$mdtype":"Node","attributes":{"level":3},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Usage"},"children":[],"type":"text"}],"type":"heading"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"accessToken"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field will contain the token used to authenticate against the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Open Delivery"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" APIs. Once you’ve obtained this token, you can provide it in the “Authorization” header of requests you make to endpoints that require client credentials scopes."},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{},"children":[],"type":"softbreak"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"expiresIn"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" field indicates the lifetime of the access token, provided in seconds. This should be cached and re-used across requests until (or shortly before) expiration, not re-generated per request."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[{"$$mdtype":"Node","attributes":{"content":"curl \n -H 'authorization: Bearer <TOKEN>' \n https://{baseURL}/v1/events:polling\n"},"children":[],"type":"text"}],"type":"fence"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Refresh Token is not available at this version."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"flows":{"clientCredentials":{"tokenUrl":"oauth/token","scopes":{"od.all":"Access to all **Open Delivery** APIs"}}}},"apiKey":{"id":"apiKey","type":"apiKey","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"The apiKey is a key that should be generated by the endpoint's host and passed to its clients. Each client of the endpoint can have its own key. The creation and content of the key is of responsibility of the endpoint's host."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"As of the time of this release, only the "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"#operation/getMerchant"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"GET /v1/merchant"},"children":[],"type":"text"}],"type":"link"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" endpoint can require authentication via apiKey."},"children":[],"type":"text"}],"type":"paragraph"}],"type":"blockquote"}],"in":"header","paramName":"X-API-KEY"},"Sig":{"id":"Sig","type":"apiKey","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"To enhance overall security, Keeta requires "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Software services"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":" to include a signature in the header when making requests to Keeta. "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"name":"br","attrs":{}},"children":[],"type":"tag","tag":"html"},{"$$mdtype":"Node","inline":true,"attributes":{"content":"The signature should be generated as follows: SHA256 hash of the request body, using the client secret as the key."},"children":[],"type":"text"}],"type":"paragraph"}],"in":"header","paramName":"X-App-Signature"}},"specVersion":"3.0.3","servers":[{"url":"https://open.mykeeta.com/api/open/opendelivery"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/en/apis/@opendelivery/opendelivery.json?download"},{"url":"/_bundle/@l10n/en/apis/@opendelivery/opendelivery.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Keeta Open Delivery API"}},"baseSlug":"/en/apis/opendelivery","routesMapping":{}}