{"items":[{"type":"link","label":"Developer Tools","link":"/en/developers/openapi","routeSlug":"/en/developers/openapi","content":{"contentType":"overview","meta":{"name":"Developer Tools"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/en/developers/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/en/developers/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Altegio API Agreement","url":"/en/api-license-agreement"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://alteg.io/en/info/terms/"}]},{"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":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Developer Tools (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs for partners building integrations with the Altegio platform."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.alteg.io/api"},"children":[]}]}]}]}],"sectionId":"/en/developers/openapi"}],"sectionId":"/en/developers/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/start-here"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start here"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Building your first marketplace app? Follow "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/developers/marketplace-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Install & test your app before moderation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It explains which IDs and tokens you need, how the two-step installation works, and how to verify your first authenticated call."},"children":[]}]}]}]}],"sectionId":"/en/developers/openapi/section/start-here"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/available-methods"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Methods"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marketplace"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Manage your marketplace applications: list connected locations, configure tariffs, handle billing, process installation/uninstallation callbacks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Configure event notifications for your integrations. Receive real-time updates when appointments, clients, or other entities change."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VoIP Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Connect telephony systems to match incoming calls with client records and log call history."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dictionaries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Reference data for building forms and validations: countries, cities, business types."},"children":[]}]}]}]}],"sectionId":"/en/developers/openapi/section/available-methods"}]}]}},{"type":"link","label":"Start here","link":"/en/developers/openapi/section/start-here","routeSlug":"/en/developers/openapi/section/start-here","content":null},{"type":"link","label":"Available Methods","link":"/en/developers/openapi/section/available-methods","routeSlug":"/en/developers/openapi/section/available-methods","content":null},{"type":"separator","label":"Developers","content":null},{"type":"group","label":"Marketplace","link":"/en/developers/openapi/marketplace","routeSlug":"/en/developers/openapi/marketplace","items":[{"label":"Connect an Application to a Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_location_grant_access","routeSlug":"/en/developers/openapi/marketplace/marketplace_location_grant_access","metadata":{"seo":{"title":"Connect an Application to a Location","description":"Step 1 of the two-step installation handshake — the location owner grants the application access to their location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_location_grant_access","name":"Connect an Application to a Location","isWebhook":false,"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1grant_access/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Connect an Application to a Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 1 of the two-step installation handshake"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the location owner grants the application access to their location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call this on behalf of the location owner (combined partner + user token). On success the application is linked to the location with status "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the partner service must then confirm the installation with the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Marketplace/operation/marketplace_notification_settings_callback"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"installation callback"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move the link to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-public (draft/whitelisted) applications the link is activated immediately (fast install) instead of going through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticated user must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage user rights"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the location. See the end-to-end "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/developers/marketplace-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Install & test your app before moderation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}","description":"Combined partner and user tokens for authenticated user operations"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_508","description":"Location ID","required":true},{"name":"application_id","in":"path","schemaId":"schema_508","description":"Application ID","required":true}],"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1grant_access/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1grant_access/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{company_id}/marketplace/applications/{application_id}/grant_access","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_508"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_508"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["201","401","403","404"],"pointer":"/company/{company_id}/marketplace/applications/{application_id}/grant_access","href":"marketplace/marketplace_location_grant_access","openApiOperationId":"marketplace_location_grant_access","summary":"Connect an Application to a Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access granted. The application–location link is created with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fast-install applications)."},"children":[]}]}]}]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the user lacks the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage user rights"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the location, or installation of this application is blocked for the location."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Application not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1grant_access/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_location_grant_access"}],"panels":[]}]},"httpPath":"/company/{company_id}/marketplace/applications/{application_id}/grant_access"},{"label":"Permissions Requested by an Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_location_application_permissions","routeSlug":"/en/developers/openapi/marketplace/marketplace_location_application_permissions","metadata":{"seo":{"title":"Permissions Requested by an Application","description":"Returns the list of user permissions the application declares for a location — the access rights the system user receives once the installation is confirmed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_location_application_permissions","name":"Permissions Requested by an Application","isWebhook":false,"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permissions Requested by an Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of user permissions the application declares for a location — the access rights the system user receives once the installation is confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful before calling "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Marketplace/operation/marketplace_location_grant_access"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect an Application to a Location"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to show the owner exactly what they are granting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticated user must have the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage user rights"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New to this flow? Follow "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/developers/marketplace-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Install & test your app before moderation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from credentials through the final "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status check."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}","description":"Combined partner and user tokens for authenticated user operations"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"company_id","in":"path","schemaId":"schema_508","description":"Location ID","required":true},{"name":"application_id","in":"path","schemaId":"schema_508","description":"Application ID","required":true}],"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1permissions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1permissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{company_id}/marketplace/applications/{application_id}/permissions","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_508"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_508"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{company_id}/marketplace/applications/{application_id}/permissions","href":"marketplace/marketplace_location_application_permissions","openApiOperationId":"marketplace_location_application_permissions","summary":"Permissions Requested by an Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of declared permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden — the user lacks the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage user rights"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the location."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Application not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1company~1{company_id}~1marketplace~1applications~1{application_id}~1permissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_510"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_location_application_permissions"}],"panels":[]}]},"httpPath":"/company/{company_id}/marketplace/applications/{application_id}/permissions"},{"label":"Data About Locations Connected to the Application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/list_marketplace_app_locations","routeSlug":"/en/developers/openapi/marketplace/list_marketplace_app_locations","metadata":{"seo":{"title":"Data About Locations Connected to the Application","description":"This endpoint retrieves a list of locations that have connected a specific application, along with detailed information about each."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_marketplace_app_locations","name":"Data About Locations Connected to the Application","isWebhook":false,"pointer":"/paths/~1marketplace~1application~1{application_id}~1salons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data About Locations Connected to the Application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves a list of locations that have connected a specific application, along with detailed information about each.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_511","description":"Application ID","required":true}],"pointer":"/paths/~1marketplace~1application~1{application_id}~1salons/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_511","description":"Page number","required":true},{"name":"count","in":"query","schemaId":"schema_512","description":"Number of elements per page","required":true}],"pointer":"/paths/~1marketplace~1application~1{application_id}~1salons/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1application~1{application_id}~1salons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/marketplace/application/{application_id}/salons","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_511"}],"query":[{"name":"page","in":"query","required":true,"schemaId":"schema_511"},{"name":"count","in":"query","required":true,"schemaId":"schema_512"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/marketplace/application/{application_id}/salons","href":"marketplace/list_marketplace_app_locations","openApiOperationId":"list_marketplace_app_locations","summary":"Data About Locations Connected to the Application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Locations array","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/companies_data_types"}},"schemaId":"components/schemas/companies_data_types"},{"code":"401","description":"No partner token given","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"No access to application.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"}],"pointer":"/paths/~1marketplace~1application~1{application_id}~1salons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/companies_data_types","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/companies_data_types"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/list_marketplace_app_locations"}],"panels":[]}]},"httpPath":"/marketplace/application/{application_id}/salons"},{"label":"Get application tariffs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_partner_applications_tariffs_list","routeSlug":"/en/developers/openapi/marketplace/marketplace_partner_applications_tariffs_list","metadata":{"seo":{"title":"Get application tariffs","description":"Retrieves list of tariffs for the application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_partner_applications_tariffs_list","name":"Get application tariffs","isWebhook":false,"pointer":"/paths/~1marketplace~1application~1{application_id}~1tariffs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get application tariffs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves list of tariffs for the application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For marketplace partners only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_508","description":"Application ID","required":true,"example":123}],"pointer":"/paths/~1marketplace~1application~1{application_id}~1tariffs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_513","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer {partner_token}"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1marketplace~1application~1{application_id}~1tariffs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/marketplace/application/{application_id}/tariffs","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"example":123,"schemaId":"schema_508"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_513"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/marketplace/application/{application_id}/tariffs","href":"marketplace/marketplace_partner_applications_tariffs_list","openApiOperationId":"marketplace_partner_applications_tariffs_list","summary":"Get application tariffs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tariffs retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}},"schemaId":"schema_514"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"404","description":"Application not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"}],"pointer":"/paths/~1marketplace~1application~1{application_id}~1tariffs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_514","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}}},{"code":"401","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"403","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"404","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_partner_applications_tariffs_list"}],"panels":[]}]},"httpPath":"/marketplace/application/{application_id}/tariffs"},{"label":"Set payment discount for locations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_partner_application_add_discount","routeSlug":"/en/developers/openapi/marketplace/marketplace_partner_application_add_discount","metadata":{"seo":{"title":"Set payment discount for locations","description":"Sets a payment discount for specific locations when they pay through Altegio platform."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_partner_application_add_discount","name":"Set payment discount for locations","isWebhook":false,"pointer":"/paths/~1marketplace~1application~1add_discount/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set payment discount for locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets a payment discount for specific locations when they pay through Altegio platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint is intended for marketplace partners only."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires marketplace partner authorization."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_513","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_516","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer {partner_token}"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1marketplace~1application~1add_discount/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_517"}},"schemaId":"schema_517","pointer":"/paths/~1marketplace~1application~1add_discount/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/application/add_discount","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_513"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_516"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_517"}},"responseCodes":["200","401","403","404"],"pointer":"/marketplace/application/add_discount","href":"marketplace/marketplace_partner_application_add_discount","openApiOperationId":"marketplace_partner_application_add_discount","summary":"Set payment discount for locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_517","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_517"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Discount successfully applied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518"},{"code":"401","description":"Unauthorized - partner token not provided or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"403","description":"Forbidden - no access to application","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}},"schemaId":"schema_519"},{"code":"404","description":"Application not installed in location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"}],"pointer":"/paths/~1marketplace~1application~1add_discount/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"401","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"403","schemaId":"schema_519","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}}},{"code":"404","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_partner_application_add_discount"}],"panels":[]}]},"httpPath":"/marketplace/application/add_discount"},{"label":"Generate payment link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_partner_application_payment_link","routeSlug":"/en/developers/openapi/marketplace/marketplace_partner_application_payment_link","metadata":{"seo":{"title":"Generate payment link","description":"Generates a payment link for application payment through Altegio platform."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_partner_application_payment_link","name":"Generate payment link","isWebhook":false,"pointer":"/paths/~1marketplace~1application~1payment_link/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate payment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a payment link for application payment through Altegio platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" For marketplace partners only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"salon_id","in":"query","schemaId":"schema_508","description":"Location ID","required":true,"example":123},{"name":"application_id","in":"query","schemaId":"schema_508","description":"Application ID","required":true,"example":456},{"name":"discount","in":"query","schemaId":"schema_521","description":"Discount percentage (optional)","example":15.55}],"pointer":"/paths/~1marketplace~1application~1payment_link/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_513","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer {partner_token}"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1marketplace~1application~1payment_link/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/marketplace/application/payment_link","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"salon_id","in":"query","required":true,"example":123,"schemaId":"schema_508"},{"name":"application_id","in":"query","required":true,"example":456,"schemaId":"schema_508"},{"name":"discount","in":"query","required":false,"example":15.55,"schemaId":"schema_521"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_513"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/marketplace/application/payment_link","href":"marketplace/marketplace_partner_application_payment_link","openApiOperationId":"marketplace_partner_application_payment_link","summary":"Generate payment link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Payment link generated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"404","description":"Application not installed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"}],"pointer":"/paths/~1marketplace~1application~1payment_link/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"401","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"403","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"404","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_partner_application_payment_link"}],"panels":[]}]},"httpPath":"/marketplace/application/payment_link"},{"label":"Update notification channel availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_partner_applications_update_channel","routeSlug":"/en/developers/openapi/marketplace/marketplace_partner_applications_update_channel","metadata":{"seo":{"title":"Update notification channel availability","description":"Updates available notification channels for the application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_partner_applications_update_channel","name":"Update notification channel availability","isWebhook":false,"pointer":"/paths/~1marketplace~1application~1update_channel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update notification channel availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates available notification channels for the application."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only for Chat Bots and SMS Aggregators category applications."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For marketplace partners only."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_513","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_516","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer {partner_token}"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1marketplace~1application~1update_channel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523","pointer":"/paths/~1marketplace~1application~1update_channel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/application/update_channel","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_513"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_516"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_523"}},"responseCodes":["200","401","403","422"],"pointer":"/marketplace/application/update_channel","href":"marketplace/marketplace_partner_applications_update_channel","openApiOperationId":"marketplace_partner_applications_update_channel","summary":"Update notification channel availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_523"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Channel availability updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_524"}},"schemaId":"schema_524"}],"pointer":"/paths/~1marketplace~1application~1update_channel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"401","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"403","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"422","schemaId":"schema_524","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_524"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_partner_applications_update_channel"}],"panels":[]}]},"httpPath":"/marketplace/application/update_channel"},{"label":"Application Status Data for Any Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/get_marketplace_integration_status","routeSlug":"/en/developers/openapi/marketplace/get_marketplace_integration_status","metadata":{"seo":{"title":"Application Status Data for Any Location","description":"Retrieves the application's installation status in a specific location. Use it after the installation callback to confirm that the status is active."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_marketplace_integration_status","name":"Application Status Data for Any Location","isWebhook":false,"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Status Data for Any Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the application's installation status in a specific location. Use it after the installation callback to confirm that the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the complete owner grant → partner confirmation → status check flow, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/developers/marketplace-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Install & test your app before moderation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_511","description":"Location ID","required":true},{"name":"application_id","in":"path","schemaId":"schema_511","description":"Application ID","required":true}],"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/marketplace/salon/{location_id}/application/{application_id}","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_511"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_511"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/marketplace/salon/{location_id}/application/{application_id}","href":"marketplace/get_marketplace_integration_status","openApiOperationId":"get_marketplace_integration_status","summary":"Application Status Data for Any Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Info about application location link","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_525"}},"schemaId":"schema_525"},{"code":"401","description":"No partner token given.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"No application access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Application isn't installed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_525","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_525"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/get_marketplace_integration_status"}],"panels":[]}]},"httpPath":"/marketplace/salon/{location_id}/application/{application_id}"},{"label":"Application Uninstall","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/uninstall_marketplace_app","routeSlug":"/en/developers/openapi/marketplace/uninstall_marketplace_app","metadata":{"seo":{"title":"Application Uninstall","description":"This endpoint is used by the partner service to uninstall the application from a specific location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uninstall_marketplace_app","name":"Application Uninstall","isWebhook":false,"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}~1uninstall/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Uninstall","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used by the partner service to uninstall the application from a specific location.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_511","description":"Location ID","required":true},{"name":"application_id","in":"path","schemaId":"schema_511","description":"Application ID","required":true}],"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}~1uninstall/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}~1uninstall/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/salon/{location_id}/application/{application_id}/uninstall","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_511"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_511"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/marketplace/salon/{location_id}/application/{application_id}/uninstall","href":"marketplace/uninstall_marketplace_app","openApiOperationId":"uninstall_marketplace_app","summary":"Application Uninstall"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successfully uninstalled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"code":"401","description":"No partner token given.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"No application access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Application isn't installed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1marketplace~1salon~1{location_id}~1application~1{application_id}~1uninstall/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/200_success_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/200_success_response"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/uninstall_marketplace_app"}],"panels":[]}]},"httpPath":"/marketplace/salon/{location_id}/application/{application_id}/uninstall"},{"label":"Application Installation for a Location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_notification_settings_callback","routeSlug":"/en/developers/openapi/marketplace/marketplace_notification_settings_callback","metadata":{"seo":{"title":"Application Installation for a Location","description":"Step 2 of the two-step installation handshake — the partner confirms the installation and delivers integration settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_notification_settings_callback","name":"Application Installation for a Location","isWebhook":false,"pointer":"/paths/~1marketplace~1partner~1callback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Installation for a Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step 2 of the two-step installation handshake"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the partner confirms the installation and delivers integration settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this partner callback is served from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.alteg.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > root — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.alteg.io/api/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The full URL is > "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.alteg.io/marketplace/partner/callback"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the owner grants access with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Marketplace/operation/marketplace_location_grant_access"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect an Application to a Location"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the application–location link is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Send this callback with your "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner Token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Account settings) to move the link to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", link the system user, and apply the integration settings below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirmation window:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 hour"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after the owner connects to send this callback. If you do not confirm in time, the link stays "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the owner must reconnect. Verify the resulting status with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Marketplace/operation/get_marketplace_integration_status"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application Status Data for Any Location"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the end-to-end "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/developers/marketplace-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Install & test your app before moderation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1partner~1callback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_526"}},"schemaId":"schema_526","pointer":"/paths/~1marketplace~1partner~1callback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/partner/callback","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_526"}},"responseCodes":["201","401","403","422"],"pointer":"/marketplace/partner/callback","href":"marketplace/marketplace_notification_settings_callback","openApiOperationId":"marketplace_notification_settings_callback","summary":"Application Installation for a Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"schemaId":"schema_526","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_526"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"All parameters installed"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"422","description":"Invalid parameters given","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"}],"pointer":"/paths/~1marketplace~1partner~1callback/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"422","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_notification_settings_callback"}],"panels":[]}]},"httpPath":"/marketplace/partner/callback"},{"label":"Redirect URL after user registration with the partner service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_notification_settings_redirect_callback","routeSlug":"/en/developers/openapi/marketplace/marketplace_notification_settings_redirect_callback","metadata":{"seo":{"title":"Redirect URL after user registration with the partner service","description":"After completing registration, the user must be redirected to this URL in the browser, along with any required data needed by the partner service."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_notification_settings_redirect_callback","name":"Redirect URL after user registration with the partner service","isWebhook":false,"pointer":"/paths/~1marketplace~1partner~1callback~1redirect/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Redirect URL after user registration with the partner service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"After completing registration, the user must be redirected to this URL in the browser, along with any required data needed by the partner service.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1partner~1callback~1redirect/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_526"}},"schemaId":"schema_526","pointer":"/paths/~1marketplace~1partner~1callback~1redirect/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/partner/callback/redirect","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_526"}},"responseCodes":["200","301","401","403","422"],"pointer":"/marketplace/partner/callback/redirect","href":"marketplace/marketplace_notification_settings_redirect_callback","openApiOperationId":"marketplace_notification_settings_redirect_callback","summary":"Redirect URL after user registration with the partner service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"schemaId":"schema_526","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_526"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"301","description":"Redirect to partner service"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"422","description":"Invalid parameters given","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"}],"pointer":"/paths/~1marketplace~1partner~1callback~1redirect/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"301"},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"422","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_notification_settings_redirect_callback"}],"panels":[]}]},"httpPath":"/marketplace/partner/callback/redirect"},{"label":"Notify Altegio of Successful Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_notification_payment_callback","routeSlug":"/en/developers/openapi/marketplace/marketplace_notification_payment_callback","metadata":{"seo":{"title":"Notify Altegio of Successful Payment","description":"A webhook notification must be sent to this address to inform Altegio of a successful payment made on the partner service’s side."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_notification_payment_callback","name":"Notify Altegio of Successful Payment","isWebhook":false,"pointer":"/paths/~1marketplace~1partner~1payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notify Altegio of Successful Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A webhook notification must be sent to this address to inform Altegio of a successful payment made on the partner service’s side."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1partner~1payment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528","pointer":"/paths/~1marketplace~1partner~1payment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/partner/payment","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_528"}},"responseCodes":["200","401","403","422"],"pointer":"/marketplace/partner/payment","href":"marketplace/marketplace_notification_payment_callback","openApiOperationId":"marketplace_notification_payment_callback","summary":"Notify Altegio of Successful Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_528"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook ok","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}},"schemaId":"schema_529"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"422","description":"Wrong parameters given","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"}],"pointer":"/paths/~1marketplace~1partner~1payment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_529","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"422","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_notification_payment_callback"}],"panels":[]}]},"httpPath":"/marketplace/partner/payment"},{"label":"Chargeback Notice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_payment_refund_callback","routeSlug":"/en/developers/openapi/marketplace/marketplace_payment_refund_callback","metadata":{"seo":{"title":"Chargeback Notice","description":"Chargeback Notice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_payment_refund_callback","name":"Chargeback Notice","isWebhook":false,"pointer":"/paths/~1marketplace~1partner~1payment~1refund~1{payment_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chargeback Notice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Chargeback Notice\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_id","in":"path","schemaId":"schema_511","description":"Payment ID.","required":true,"example":123}],"pointer":"/paths/~1marketplace~1partner~1payment~1refund~1{payment_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1partner~1payment~1refund~1{payment_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/partner/payment/refund/{payment_id}","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[{"name":"payment_id","in":"path","required":true,"example":123,"schemaId":"schema_511"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/marketplace/partner/payment/refund/{payment_id}","href":"marketplace/marketplace_payment_refund_callback","openApiOperationId":"marketplace_payment_refund_callback","summary":"Chargeback Notice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Refund confirmed"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"422","description":"Invalid parameters given","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"}],"pointer":"/paths/~1marketplace~1partner~1payment~1refund~1{payment_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"422","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_payment_refund_callback"}],"panels":[]}]},"httpPath":"/marketplace/partner/payment/refund/{payment_id}"},{"label":"Notify Altegio of Available SMS Sender Names","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/set_marketplace_notification_short_names","routeSlug":"/en/developers/openapi/marketplace/set_marketplace_notification_short_names","metadata":{"seo":{"title":"Notify Altegio of Available SMS Sender Names","description":"This endpoint is used to send the list of SMS sender names available to the user. The user will be able to choose from any of the provided sender names."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"set_marketplace_notification_short_names","name":"Notify Altegio of Available SMS Sender Names","isWebhook":false,"pointer":"/paths/~1marketplace~1partner~1short_names/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notify Altegio of Available SMS Sender Names","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is used to send the list of SMS sender names available to the user. The user will be able to choose from any of the provided sender names.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace~1partner~1short_names/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530","pointer":"/paths/~1marketplace~1partner~1short_names/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace/partner/short_names","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_530"}},"responseCodes":["201","401","403","422"],"pointer":"/marketplace/partner/short_names","href":"marketplace/set_marketplace_notification_short_names","openApiOperationId":"set_marketplace_notification_short_names","summary":"Notify Altegio of Available SMS Sender Names"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://app.alteg.io"}],"schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_530"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"422","description":"Invalid params given","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"}],"pointer":"/paths/~1marketplace~1partner~1short_names/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"422","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/set_marketplace_notification_short_names"}],"panels":[]}]},"httpPath":"/marketplace/partner/short_names"},{"label":"Webhook from Altegio About Application Events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/marketplace/marketplace_webhook","routeSlug":"/en/developers/openapi/marketplace/marketplace_webhook","metadata":{"seo":{"title":"Webhook from Altegio About Application Events","description":"Note: This is not a callable endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"marketplace_webhook","name":"Webhook from Altegio About Application Events","isWebhook":false,"pointer":"/paths/~1marketplace_webhook/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook from Altegio About Application Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: This is not a callable endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section describes how Altegio sends webhook notifications when specific events occur in the application-to-location lifecycle. The following event types are currently supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uninstall — Sent when the application is disabled on the Altegio side."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"freeze — Sent when the integration is frozen due to service expiration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can configure the webhook URL for receiving these events in your Altegio Developer Account."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1marketplace_webhook/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531","pointer":"/paths/~1marketplace_webhook/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/marketplace_webhook","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_531"}},"responseCodes":["200","401","403","404"],"pointer":"/marketplace_webhook","href":"marketplace/marketplace_webhook","openApiOperationId":"marketplace_webhook","summary":"Webhook from Altegio About Application Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io"}],"schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_531"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"From the side of the partner, a response code of successful processing (200-299) is expected."},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1marketplace_webhook/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/marketplace/marketplace_webhook"}],"panels":[]}]},"httpPath":"/marketplace_webhook"}],"content":{"contentType":"group","meta":{"name":"Marketplace"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Marketplace","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Marketplace application management, billing, and installation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Installing an application on a location is a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two-step handshake"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the owner connects the app ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), then the partner confirms with the installation callback (→ status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/developers/marketplace-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Install & test your app before moderation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Host note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" partner callbacks ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/marketplace/partner/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are served from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://app.alteg.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" root, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.alteg.io/api/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each such operation documents its own server."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company/{company_id}/marketplace/applications/{application_id}/grant_access","summary":"Connect an Application to a Location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_location_grant_access","deprecated":false},{"title":"/company/{company_id}/marketplace/applications/{application_id}/permissions","summary":"Permissions Requested by an Application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/marketplace/marketplace_location_application_permissions","deprecated":false},{"title":"/marketplace/application/{application_id}/salons","summary":"Data About Locations Connected to the Application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/marketplace/list_marketplace_app_locations","deprecated":false},{"title":"/marketplace/application/{application_id}/tariffs","summary":"Get application tariffs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/marketplace/marketplace_partner_applications_tariffs_list","deprecated":false},{"title":"/marketplace/application/add_discount","summary":"Set payment discount for locations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_partner_application_add_discount","deprecated":false},{"title":"/marketplace/application/payment_link","summary":"Generate payment link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/marketplace/marketplace_partner_application_payment_link","deprecated":false},{"title":"/marketplace/application/update_channel","summary":"Update notification channel availability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_partner_applications_update_channel","deprecated":false},{"title":"/marketplace/salon/{location_id}/application/{application_id}","summary":"Application Status Data for Any Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/marketplace/get_marketplace_integration_status","deprecated":false},{"title":"/marketplace/salon/{location_id}/application/{application_id}/uninstall","summary":"Application Uninstall","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/uninstall_marketplace_app","deprecated":false},{"title":"/marketplace/partner/callback","summary":"Application Installation for a Location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_notification_settings_callback","deprecated":false},{"title":"/marketplace/partner/callback/redirect","summary":"Redirect URL after user registration with the partner service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_notification_settings_redirect_callback","deprecated":false},{"title":"/marketplace/partner/payment","summary":"Notify Altegio of Successful Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_notification_payment_callback","deprecated":false},{"title":"/marketplace/partner/payment/refund/{payment_id}","summary":"Chargeback Notice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_payment_refund_callback","deprecated":false},{"title":"/marketplace/partner/short_names","summary":"Notify Altegio of Available SMS Sender Names","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/set_marketplace_notification_short_names","deprecated":false},{"title":"/marketplace_webhook","summary":"Webhook from Altegio About Application Events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/marketplace/marketplace_webhook","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/en/developers/openapi/webhooks","routeSlug":"/en/developers/openapi/webhooks","items":[{"label":"Get event notification settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/webhooks/get_event_notification_settings","routeSlug":"/en/developers/openapi/webhooks/get_event_notification_settings","metadata":{"seo":{"title":"Get event notification settings","description":"Get event notification settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_event_notification_settings","name":"Get event notification settings","isWebhook":false,"pointer":"/paths/~1hooks_settings~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get event notification settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}","description":"Combined partner and user tokens for authenticated user operations"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_511","description":"location ID","required":true}],"pointer":"/paths/~1hooks_settings~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_509","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer partner_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hooks_settings~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hooks_settings/{location_id}","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_511"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_509"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/hooks_settings/{location_id}","href":"webhooks/get_event_notification_settings","openApiOperationId":"get_event_notification_settings","summary":"Get event notification settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1hooks_settings~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/get_event_notification_settings"}],"panels":[]}]},"httpPath":"/hooks_settings/{location_id}"},{"label":"Change Event Notification Settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/webhooks/update_event_notification_settings","routeSlug":"/en/developers/openapi/webhooks/update_event_notification_settings","metadata":{"seo":{"title":"Change Event Notification Settings","description":"Change Event Notification Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_event_notification_settings","name":"Change Event Notification Settings","isWebhook":false,"pointer":"/paths/~1hooks_settings~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change Event Notification Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}","description":"Combined partner and user tokens for authenticated user operations"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_511","description":"location ID","required":true}],"pointer":"/paths/~1hooks_settings~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_509","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer partner_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hooks_settings~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532","pointer":"/paths/~1hooks_settings~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hooks_settings/{location_id}","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_511"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_509"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_532"}},"responseCodes":["201","401","403","404"],"pointer":"/hooks_settings/{location_id}","href":"webhooks/update_event_notification_settings","openApiOperationId":"update_event_notification_settings","summary":"Change Event Notification Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_532"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/post/responses/201/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1hooks_settings~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/hooks_settings_response_data_types","exampleIds":["paths/~1hooks_settings~1{location_id}/post/responses/201/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/update_event_notification_settings"}],"panels":[]}]},"httpPath":"/hooks_settings/{location_id}"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Location Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_salon","routeSlug":"/en/developers/openapi/webhooks/webhook_salon","metadata":{"seo":{"title":"Location Event","description":"Sent when a location is created, updated, or deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_salon","name":"Location Event","isWebhook":true,"pointer":"/paths/SalonEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Location Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sent when a location is created, updated, or deleted."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_533","exampleIds":["paths/SalonEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_533","exampleIds":["paths/SalonEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/SalonEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"SalonEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_533","exampleIds":["paths/SalonEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"SalonEvent","href":"webhooks/webhook_salon","openApiOperationId":"webhook_salon","summary":"Location Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_533","exampleIds":["paths/SalonEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_533","exampleIds":["paths/SalonEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/SalonEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_salon"}],"panels":[]}]},"httpPath":"SalonEvent"},{"label":"Team Member Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_staff","routeSlug":"/en/developers/openapi/webhooks/webhook_staff","metadata":{"seo":{"title":"Team Member Event","description":"Sent when a team member is created, updated, or deleted. The data field matches the response from GET /company/{company_id}/staff/{staff_id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_staff","name":"Team Member Event","isWebhook":true,"pointer":"/paths/StaffEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Member Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a team member is created, updated, or deleted. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field matches the response from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /company/{company_id}/staff/{staff_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_534","exampleIds":["paths/StaffEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_534","exampleIds":["paths/StaffEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/StaffEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"StaffEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_534","exampleIds":["paths/StaffEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"StaffEvent","href":"webhooks/webhook_staff","openApiOperationId":"webhook_staff","summary":"Team Member Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_534","exampleIds":["paths/StaffEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_534","exampleIds":["paths/StaffEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/StaffEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_staff"}],"panels":[]}]},"httpPath":"StaffEvent"},{"label":"Service Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_service","routeSlug":"/en/developers/openapi/webhooks/webhook_service","metadata":{"seo":{"title":"Service Event","description":"Sent when a service is created, updated, or deleted. The data field matches the response from GET /company/{company_id}/services/{service_id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_service","name":"Service Event","isWebhook":true,"pointer":"/paths/ServiceEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a service is created, updated, or deleted. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field matches the response from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /company/{company_id}/services/{service_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_535","exampleIds":["paths/ServiceEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_535","exampleIds":["paths/ServiceEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/ServiceEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ServiceEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_535","exampleIds":["paths/ServiceEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"ServiceEvent","href":"webhooks/webhook_service","openApiOperationId":"webhook_service","summary":"Service Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_535","exampleIds":["paths/ServiceEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_535","exampleIds":["paths/ServiceEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/ServiceEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_service"}],"panels":[]}]},"httpPath":"ServiceEvent"},{"label":"Service Category Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_service_category","routeSlug":"/en/developers/openapi/webhooks/webhook_service_category","metadata":{"seo":{"title":"Service Category Event","description":"Sent when a service category is created, updated, or deleted. The data field matches the response from GET /company/{company_id}/service/categories."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_service_category","name":"Service Category Event","isWebhook":true,"pointer":"/paths/ServiceCategoryEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service Category Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a service category is created, updated, or deleted. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field matches the response from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /company/{company_id}/service/categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_536","exampleIds":["paths/ServiceCategoryEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_536","exampleIds":["paths/ServiceCategoryEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/ServiceCategoryEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ServiceCategoryEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_536","exampleIds":["paths/ServiceCategoryEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"ServiceCategoryEvent","href":"webhooks/webhook_service_category","openApiOperationId":"webhook_service_category","summary":"Service Category Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_536","exampleIds":["paths/ServiceCategoryEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_536","exampleIds":["paths/ServiceCategoryEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/ServiceCategoryEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_service_category"}],"panels":[]}]},"httpPath":"ServiceCategoryEvent"},{"label":"Client Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_client","routeSlug":"/en/developers/openapi/webhooks/webhook_client","metadata":{"seo":{"title":"Client Event","description":"Sent when a client is created, updated, or deleted. The data field contains the full client profile with all default includes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_client","name":"Client Event","isWebhook":true,"pointer":"/paths/ClientEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Client Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a client is created, updated, or deleted. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the full client profile with all default includes."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_537","exampleIds":["paths/ClientEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_537","exampleIds":["paths/ClientEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/ClientEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ClientEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_537","exampleIds":["paths/ClientEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"ClientEvent","href":"webhooks/webhook_client","openApiOperationId":"webhook_client","summary":"Client Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_537","exampleIds":["paths/ClientEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_537","exampleIds":["paths/ClientEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/ClientEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_client"}],"panels":[]}]},"httpPath":"ClientEvent"},{"label":"Appointment Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_record","routeSlug":"/en/developers/openapi/webhooks/webhook_record","metadata":{"seo":{"title":"Appointment Event","description":"Sent when an appointment is created, updated, or deleted. The data field matches the response from GET /record/{company_id}/{record_id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_record","name":"Appointment Event","isWebhook":true,"pointer":"/paths/RecordEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appointment Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when an appointment is created, updated, or deleted. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field matches the response from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /record/{company_id}/{record_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_538","exampleIds":["paths/RecordEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_538","exampleIds":["paths/RecordEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/RecordEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"RecordEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_538","exampleIds":["paths/RecordEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"RecordEvent","href":"webhooks/webhook_record","openApiOperationId":"webhook_record","summary":"Appointment Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_538","exampleIds":["paths/RecordEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_538","exampleIds":["paths/RecordEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/RecordEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_record"}],"panels":[]}]},"httpPath":"RecordEvent"},{"label":"Loyalty Card Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_loyalty_card","routeSlug":"/en/developers/openapi/webhooks/webhook_loyalty_card","metadata":{"seo":{"title":"Loyalty Card Event","description":"Sent when a loyalty card is created, updated, or deleted. Uses a simplified payload with essential fields only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_loyalty_card","name":"Loyalty Card Event","isWebhook":true,"pointer":"/paths/LoyaltyCardEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loyalty Card Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sent when a loyalty card is created, updated, or deleted. Uses a simplified payload with essential fields only."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_539","exampleIds":["paths/LoyaltyCardEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_539","exampleIds":["paths/LoyaltyCardEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/LoyaltyCardEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"LoyaltyCardEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_539","exampleIds":["paths/LoyaltyCardEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"LoyaltyCardEvent","href":"webhooks/webhook_loyalty_card","openApiOperationId":"webhook_loyalty_card","summary":"Loyalty Card Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_539","exampleIds":["paths/LoyaltyCardEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_539","exampleIds":["paths/LoyaltyCardEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/LoyaltyCardEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_loyalty_card"}],"panels":[]}]},"httpPath":"LoyaltyCardEvent"},{"label":"Schedule Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_schedule","routeSlug":"/en/developers/openapi/webhooks/webhook_schedule","metadata":{"seo":{"title":"Schedule Event","description":"Sent when a team member's schedule is created, updated, or deleted. The resource_id refers to the team member (staff) ID whose schedule changed. The data field is always an empty array for schedule events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_schedule","name":"Schedule Event","isWebhook":true,"pointer":"/paths/ScheduleEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a team member's schedule is created, updated, or deleted. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the team member (staff) ID whose schedule changed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is always an empty array for schedule events."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_540","exampleIds":["paths/ScheduleEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_540","exampleIds":["paths/ScheduleEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/ScheduleEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"ScheduleEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_540","exampleIds":["paths/ScheduleEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"ScheduleEvent","href":"webhooks/webhook_schedule","openApiOperationId":"webhook_schedule","summary":"Schedule Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_540","exampleIds":["paths/ScheduleEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_540","exampleIds":["paths/ScheduleEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/ScheduleEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_schedule"}],"panels":[]}]},"httpPath":"ScheduleEvent"},{"label":"Product Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_good","routeSlug":"/en/developers/openapi/webhooks/webhook_good","metadata":{"seo":{"title":"Product Event","description":"Sent when a product is created, updated, or deleted. The data field matches the response from GET /goods/{company_id}/{good_id}."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_good","name":"Product Event","isWebhook":true,"pointer":"/paths/GoodEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a product is created, updated, or deleted. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field matches the response from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /goods/{company_id}/{good_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_541","exampleIds":["paths/GoodEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_541","exampleIds":["paths/GoodEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/GoodEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"GoodEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_541","exampleIds":["paths/GoodEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"GoodEvent","href":"webhooks/webhook_good","openApiOperationId":"webhook_good","summary":"Product Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_541","exampleIds":["paths/GoodEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_541","exampleIds":["paths/GoodEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/GoodEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_good"}],"panels":[]}]},"httpPath":"GoodEvent"},{"label":"Product Operation Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_goods_operation","routeSlug":"/en/developers/openapi/webhooks/webhook_goods_operation","metadata":{"seo":{"title":"Product Operation Event","description":"Sent when a product operation occurs: sale, receipt, consumable write-off, product write-off, or product movement.The resource field indicates the specific operation type: goods_operations_sale, goods_operations_receipt, goods_operations_consumable, goods_operations_stolen, goods_operations_move."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_goods_operation","name":"Product Operation Event","isWebhook":true,"pointer":"/paths/GoodsOperationEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Operation Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a product operation occurs: sale, receipt, consumable write-off, product write-off, or product movement."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates the specific operation type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods_operations_sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods_operations_receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods_operations_consumable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods_operations_stolen"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods_operations_move"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542","exampleIds":["paths/GoodsOperationEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_542","exampleIds":["paths/GoodsOperationEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/GoodsOperationEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"GoodsOperationEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_542","exampleIds":["paths/GoodsOperationEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"GoodsOperationEvent","href":"webhooks/webhook_goods_operation","openApiOperationId":"webhook_goods_operation","summary":"Product Operation Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_542","exampleIds":["paths/GoodsOperationEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542","exampleIds":["paths/GoodsOperationEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/GoodsOperationEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_goods_operation"}],"panels":[]}]},"httpPath":"GoodsOperationEvent"},{"label":"Financial Operation Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/en/developers/openapi/webhooks/webhook_finances_operation","routeSlug":"/en/developers/openapi/webhooks/webhook_finances_operation","metadata":{"seo":{"title":"Financial Operation Event","description":"Sent when a financial transaction is created, updated, or deleted. May optionally include payment_system_transaction_ids if the feature is enabled for the location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhook_finances_operation","name":"Financial Operation Event","isWebhook":true,"pointer":"/paths/FinancesOperationEvent/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Financial Operation Event","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a financial transaction is created, updated, or deleted. May optionally include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_system_transaction_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the feature is enabled for the location."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_543","exampleIds":["paths/FinancesOperationEvent/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_543","exampleIds":["paths/FinancesOperationEvent/post/requestBody/content/application~1json/example"],"pointer":"/paths/FinancesOperationEvent/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"FinancesOperationEvent","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_543","exampleIds":["paths/FinancesOperationEvent/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"FinancesOperationEvent","href":"webhooks/webhook_finances_operation","openApiOperationId":"webhook_finances_operation","summary":"Financial Operation Event"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_543","exampleIds":["paths/FinancesOperationEvent/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_543","exampleIds":["paths/FinancesOperationEvent/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":"Your server should return any 2xx status code to acknowledge receipt."}],"pointer":"/paths/FinancesOperationEvent/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/webhook_finances_operation"}],"panels":[]}]},"httpPath":"FinancesOperationEvent"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook configuration and event notifications."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Altegio sends real-time HTTP POST notifications to your configured URLs when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"events occur in subscribed locations. Each notification contains a JSON payload"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the event envelope ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the full resource "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery details:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method: POST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content-Type: application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery delay: ~5 seconds after the event"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your endpoint must respond with a 2xx status code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Webhooks/operation/get_event_notification_settings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Settings"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint to subscribe to specific resource types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry behavior:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If your endpoint returns a non-2xx status or times out, the delivery is considered failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed deliveries are not retried automatically"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook delivery timeout: 15 seconds"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hooks_settings/{location_id}","summary":"Get event notification settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/get_event_notification_settings","deprecated":false},{"title":"/hooks_settings/{location_id}","summary":"Change Event Notification Settings","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/update_event_notification_settings","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"SalonEvent","summary":"Location Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_salon","deprecated":false},{"title":"StaffEvent","summary":"Team Member Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_staff","deprecated":false},{"title":"ServiceEvent","summary":"Service Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_service","deprecated":false},{"title":"ServiceCategoryEvent","summary":"Service Category Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_service_category","deprecated":false},{"title":"ClientEvent","summary":"Client Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_client","deprecated":false},{"title":"RecordEvent","summary":"Appointment Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_record","deprecated":false},{"title":"LoyaltyCardEvent","summary":"Loyalty Card Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_loyalty_card","deprecated":false},{"title":"ScheduleEvent","summary":"Schedule Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_schedule","deprecated":false},{"title":"GoodEvent","summary":"Product Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_good","deprecated":false},{"title":"GoodsOperationEvent","summary":"Product Operation Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_goods_operation","deprecated":false},{"title":"FinancesOperationEvent","summary":"Financial Operation Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/webhook_finances_operation","deprecated":false}]}]}]}]}},{"type":"group","label":"VoIP Integration","link":"/en/developers/openapi/voip-integration","routeSlug":"/en/developers/openapi/voip-integration","items":[{"label":"VoIP events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/voip-integration/handle_voip_integration_event","routeSlug":"/en/developers/openapi/voip-integration/handle_voip_integration_event","metadata":{"seo":{"title":"VoIP events","description":"Enable integration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"handle_voip_integration_event","name":"VoIP events","isWebhook":false,"pointer":"/paths/~1voip~1integration/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VoIP events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"voip-integration/handle_voip_integration_event/request/enable-integration","deepLinkHash":"/voip-integration/handle_voip_integration_event#voip-integration/handle_voip_integration_event/request/enable-integration"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable integration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the api and activate access to the settings in the user interface, you need to activate the integration by sending the \"Enable integration\" request. After a successful connection, access to the section with routing settings will be opened in the chain user interface."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"voip-integration/handle_voip_integration_event/request/disable-integration","deepLinkHash":"/voip-integration/handle_voip_integration_event#voip-integration/handle_voip_integration_event/request/disable-integration"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable integration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To disable the integration, you can use the \"Disable integration\" method. After the integration is disabled, access to the user interface settings section is closed, the requests \"Call notification\" and \"Call information saving\" are not processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"voip-integration/handle_voip_integration_event/request/call-notification","deepLinkHash":"/voip-integration/handle_voip_integration_event#voip-integration/handle_voip_integration_event/request/call-notification"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call notification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To display notifications about an incoming call, the \"Call notification\" method is used, the call type (\"incoming\", \"outgoing\", \"internal\") is specified in the parameters, but currently notifications are displayed only for the \"incoming\" value. Notifications are displayed for users defined based on routing settings. When specifying the \"user\" and \"diversion\" parameters at the same time, \"user\" is the priority when searching for routes."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"voip-integration/handle_voip_integration_event/request/saving-call-information","deepLinkHash":"/voip-integration/handle_voip_integration_event#voip-integration/handle_voip_integration_event/request/saving-call-information"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saving call information"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information about the call is automatically saved to the chain history and to the history of chain locations in accordance with the call routing settings."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_509","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer partner_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1voip~1integration/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","pointer":"/paths/~1voip~1integration/post/requestBody","description":"Request bodies"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/voip/integration","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_509"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_544"}},"responseCodes":["202","401","403","404"],"pointer":"/voip/integration","href":"voip-integration/handle_voip_integration_event","openApiOperationId":"handle_voip_integration_event","summary":"VoIP events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_544"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/voip_integration_response_data_types","exampleIds":["paths/~1voip~1integration/post/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/voip_integration_response_data_types","exampleIds":["paths/~1voip~1integration/post/responses/202/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1voip~1integration/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/voip_integration_response_data_types","exampleIds":["paths/~1voip~1integration/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/voip_integration_response_data_types","exampleIds":["paths/~1voip~1integration/post/responses/202/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/voip-integration/handle_voip_integration_event"}],"panels":[]}]},"httpPath":"/voip/integration"},{"label":"Get Location's Call List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/voip-integration/list_voip_calls","routeSlug":"/en/developers/openapi/voip-integration/list_voip_calls","metadata":{"seo":{"title":"Get Location's Call List","description":"This endpoint is designed to get a list of calls in a location, taking into account filters and pagination"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_voip_calls","name":"Get Location's Call List","isWebhook":false,"pointer":"/paths/~1voip~1integration~1calls/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Location's Call List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint is designed to get a list of calls in a location, taking into account filters and pagination\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}","description":"Combined partner and user tokens for authenticated user operations"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1voip~1integration~1calls/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_545"}},"schemaId":"schema_545","pointer":"/paths/~1voip~1integration~1calls/get/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/voip/integration/calls","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_545"}},"responseCodes":["200","401","403"],"pointer":"/voip/integration/calls","href":"voip-integration/list_voip_calls","openApiOperationId":"list_voip_calls","summary":"Get Location's Call List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_545"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Calls list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}},"schemaId":"schema_546"},{"code":"401","description":"Partner token not passed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"No access (requires the right to view \"Overview - Calls\").","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"}],"pointer":"/paths/~1voip~1integration~1calls/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_546","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/voip-integration/list_voip_calls"}],"panels":[]}]},"httpPath":"/voip/integration/calls"}],"content":{"contentType":"group","meta":{"name":"VoIP Integration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VoIP Integration","showPageActions":true},{"nodeType":"markdoc","content":"Telephony integration endpoints."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/voip/integration","summary":"VoIP events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/voip-integration/handle_voip_integration_event","deprecated":false},{"title":"/voip/integration/calls","summary":"Get Location's Call List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/voip-integration/list_voip_calls","deprecated":false}]}]}]}]}},{"type":"group","label":"Dictionaries","link":"/en/developers/openapi/dictionaries","routeSlug":"/en/developers/openapi/dictionaries","items":[{"label":"Get a list of countries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/dictionaries/get_country_list","routeSlug":"/en/developers/openapi/dictionaries/get_country_list","metadata":{"seo":{"title":"Get a list of countries","description":"Get a list of countries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_country_list","name":"Get a list of countries","isWebhook":false,"pointer":"/paths/~1countries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of countries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_509","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer partner_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1countries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/countries","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_509"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/countries","href":"dictionaries/get_country_list","openApiOperationId":"get_country_list","summary":"Get a list of countries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/countries_response_data_types","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/countries_response_data_types","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1countries/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/countries_response_data_types","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/countries_response_data_types","exampleIds":["paths/~1countries/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionaries/get_country_list"}],"panels":[]}]},"httpPath":"/countries"},{"label":"Get a list of cities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/dictionaries/get_city_list","routeSlug":"/en/developers/openapi/dictionaries/get_city_list","metadata":{"seo":{"title":"Get a list of cities","description":"Get a list of cities"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_city_list","name":"Get a list of cities","isWebhook":false,"pointer":"/paths/~1cities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of cities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"country_id","in":"query","schemaId":"schema_511","description":"Country ID to get cities from"},{"name":"company_id","in":"query","schemaId":"schema_511","description":"Location ID. If passed, the city of the location will also be returned, regardless of whether it belongs to the specified country or not"}],"pointer":"/paths/~1cities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_509","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer partner_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1cities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cities","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"country_id","in":"query","schemaId":"schema_511"},{"name":"company_id","in":"query","schemaId":"schema_511"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_509"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/cities","href":"dictionaries/get_city_list","openApiOperationId":"get_city_list","summary":"Get a list of cities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cities_response_data_types","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/cities_response_data_types","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1cities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/cities_response_data_types","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/cities_response_data_types","exampleIds":["paths/~1cities/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionaries/get_city_list"}],"panels":[]}]},"httpPath":"/cities"},{"label":"Get business types by group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/developers/openapi/dictionaries/get_business_types_by_group","routeSlug":"/en/developers/openapi/dictionaries/get_business_types_by_group","metadata":{"seo":{"title":"Get business types by group","description":"Get business types by group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_business_types_by_group","name":"Get business types by group","isWebhook":false,"pointer":"/paths/~1references~1business_groups_with_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get business types by group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. application/vnd.api.v2+json"},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_509","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_509","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer partner_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1references~1business_groups_with_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/references/business_groups_with_types","servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_509"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_509"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_509"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/references/business_groups_with_types","href":"dictionaries/get_business_types_by_group","openApiOperationId":"get_business_types_by_group","summary":"Get business types by group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/developers/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/references_business_group_response_data_types","exampleIds":["paths/~1references~1business_groups_with_types/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/references_business_group_response_data_types","exampleIds":["paths/~1references~1business_groups_with_types/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}},"schemaId":"components/schemas/401_unauthorized_response"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}},"schemaId":"components/schemas/403_forbidden_response"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}},"schemaId":"components/schemas/404_not_found_response"}],"pointer":"/paths/~1references~1business_groups_with_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/references_business_group_response_data_types","exampleIds":["paths/~1references~1business_groups_with_types/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/references_business_group_response_data_types","exampleIds":["paths/~1references~1business_groups_with_types/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"403","schemaId":"components/schemas/403_forbidden_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/403_forbidden_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dictionaries/get_business_types_by_group"}],"panels":[]}]},"httpPath":"/references/business_groups_with_types"}],"content":{"contentType":"group","meta":{"name":"Dictionaries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dictionaries","showPageActions":true},{"nodeType":"markdoc","content":"Reference data (countries, cities, business types)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/countries","summary":"Get a list of countries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionaries/get_country_list","deprecated":false},{"title":"/cities","summary":"Get a list of cities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionaries/get_city_list","deprecated":false},{"title":"/references/business_groups_with_types","summary":"Get business types by group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dictionaries/get_business_types_by_group","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/response_success_false_object":{"id":"components/schemas/response_success_false_object","kind":"json-schema","title":"Unsuccessful response status","data":{"title":"Unsuccessful response status","type":"boolean","description":"Response status.","example":false}},"components/schemas/response_data_null_object":{"id":"components/schemas/response_data_null_object","kind":"json-schema","title":"No data in response","data":{"title":"No data in response","type":["object","null"],"description":"Response data.","example":null}},"components/schemas/response_meta_error_unauthorized_object":{"id":"components/schemas/response_meta_error_unauthorized_object","kind":"json-schema","title":"Response error message","data":{"title":"Response error message","type":"object","description":"Additional response data.","properties":{"message":{"type":"string","description":"Error message.","example":"Authentication needed."}}}},"components/schemas/401_unauthorized_response":{"id":"components/schemas/401_unauthorized_response","kind":"json-schema","title":"401_unauthorized_response","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_false_object"},"data":{"$ref":"#/components/schemas/response_data_null_object"},"meta":{"$ref":"#/components/schemas/response_meta_error_unauthorized_object"}}}},"components/schemas/response_meta_error_forbidden_object":{"id":"components/schemas/response_meta_error_forbidden_object","kind":"json-schema","title":"Response error message","data":{"title":"Response error message","type":"object","description":"Additional response data.","properties":{"message":{"type":"string","description":"Error message.","example":"Access denied."}}}},"components/schemas/403_forbidden_response":{"id":"components/schemas/403_forbidden_response","kind":"json-schema","title":"403_forbidden_response","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_false_object"},"data":{"$ref":"#/components/schemas/response_data_null_object"},"meta":{"$ref":"#/components/schemas/response_meta_error_forbidden_object"}}}},"components/schemas/response_meta_empty_object":{"id":"components/schemas/response_meta_empty_object","kind":"json-schema","title":"Empty meta object","data":{"title":"Empty meta object","type":["object","array"],"description":"Additional response data (empty object or empty array)","example":{}}},"components/schemas/404_not_found_response":{"id":"components/schemas/404_not_found_response","kind":"json-schema","title":"404_not_found_response","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_false_object"},"data":{"$ref":"#/components/schemas/response_data_null_object"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}}},"components/schemas/response_success_true_object":{"id":"components/schemas/response_success_true_object","kind":"json-schema","title":"Successful response status","data":{"title":"Successful response status","type":"boolean","description":"Response status.","example":true}},"components/schemas/companies_data_types":{"id":"components/schemas/companies_data_types","kind":"json-schema","title":"Root Type for companies_data_types","data":{"title":"Root Type for companies_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Success status (true)"},"data":{"type":"array","description":"Array of objects","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"public_title":{"type":"string","description":"Public display name of the location"},"short_descr":{"type":"string","description":"location category"},"logo":{"type":"string","description":"location logo image address"},"active":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is the location active (1 = active, 0 = inactive)"},"children":[]}]}]}]},"phone":{"type":"string","description":"location phone number"},"phones":{"type":"array","description":"Array of location phone numbers","items":{"type":"string"}},"email":{"type":"string","description":"Location email address"},"country_id":{"type":"number","description":"Identifier of the country in which the location is located"},"schedule":{"type":"string","description":"location schedule"},"country":{"type":"string","description":"location country name"},"city_id":{"type":"number","description":"City ID where the location is located"},"city":{"type":"string","description":"location city name"},"timezone":{"type":"number","description":"Timezone offset in hours"},"timezone_name":{"type":"string","description":"timezone locations"},"address":{"type":"string","description":"Address where the location is located"},"coordinate_lat":{"type":"number","description":"Latitude","format":"float"},"coordinate_lon":{"type":"number","description":"Longitude","format":"float"},"phone_confirmation":{"type":"boolean","description":"Do I need to confirm my phone number via SMS when appointment?"},"active_staff_count":{"type":"number","description":"Number of team members available for appointment"},"next_slot":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the next free session in the location (ISO8601). The field will be present only if the GET parameter forBooking=1 is passed"},"children":[]}]}]}],"format":"date-time"},"app_ios":{"type":"string","description":"Link to iOS App"},"app_android":{"type":"string","description":"Link to app for Android"},"currency_short_title":{"type":"string","description":"Abbreviated currency name"},"reminds_sms_disabled":{"type":"boolean","description":"SMS reminders disabled"},"reminds_sms_default":{"type":"integer","description":"Default SMS reminder setting"},"group_priority":{"type":"number","description":"The higher the priority, the higher the location when displayed in the list of chain locations"},"bookform_group_priority":{"type":"number","description":"Priority for booking form display"},"description":{"type":"string","description":"Full HTML description of the location"},"photos":{"type":"array","description":"Array of location photo paths","items":{"type":"string"}},"company_photos":{"type":"array","description":"Array of full location photo URLs","items":{"type":"string"}},"booking_widget_promo":{"type":["object","null"],"description":"Booking widget promo configuration"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of locations","example":{"success":true,"data":[{"id":1050,"title":"La Visage","public_title":"La Visage Beauty","short_descr":"Beauty saloon","logo":"https://app.alteg.io/images/no-master.png","active":1,"phone":"+13155550175","phones":["+13155550175"],"email":"info@lavisage.com","country_id":7,"schedule":"","country":"United States","city_id":181,"city":"New York","timezone":-5,"timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"phone_confirmation":true,"active_staff_count":2,"next_slot":"2026-03-23T10:10:00-05:00","app_ios":"","app_android":"","currency_short_title":"$","reminds_sms_disabled":false,"reminds_sms_default":1,"group_priority":900,"bookform_group_priority":0,"description":"<p>Welcome to La Visage</p>","photos":[],"booking_widget_promo":null}],"meta":[]}}},"components/schemas/200_success_response":{"id":"components/schemas/200_success_response","kind":"json-schema","title":"200_success_response","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/response_data_null_object"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}}},"components/schemas/response_meta_validation_exception_object":{"id":"components/schemas/response_meta_validation_exception_object","kind":"json-schema","title":"Request validation error message","data":{"title":"Request validation error message","type":"object","description":"Additional response data.","properties":{"message":{"type":"string","description":"Error message.","example":"An error has occurred."},"errors":{"type":"array","description":"Set of a validation error messages.","items":{"type":"object","additionalProperties":true}}}}},"components/schemas/422_unprocessable_entity_response":{"id":"components/schemas/422_unprocessable_entity_response","kind":"json-schema","title":"422_unprocessable_entity_response","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_false_object"},"data":{"$ref":"#/components/schemas/response_data_null_object"},"meta":{"$ref":"#/components/schemas/response_meta_validation_exception_object"}}}},"components/schemas/hooks_settings_response_data_types":{"id":"components/schemas/hooks_settings_response_data_types","kind":"json-schema","title":"Root Type for hooks_settings_response_data_types","data":{"title":"Root Type for hooks_settings_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"urls":{"type":"array","description":"List of addresses to send notifications to","items":{"type":"string"}},"active":{"type":"integer","description":"1 - notifications are active, 0 - not active","format":"int32"},"salon":{"type":"integer","description":"1 - send events by location entity, 0 - do not send","format":"int32"},"service_category":{"type":"integer","description":"1 - send events by service category entity, 0 - do not send","format":"int32"},"service":{"type":"integer","description":"1 - send events by service entity, 0 - do not send","format":"int32"},"good":{"type":"integer","description":"1 - send events by product entity, 0 - don't send","format":"int32"},"master":{"type":"integer","description":"1 - send events by team member entity, 0 - don't send","format":"int32"},"client":{"type":"integer","description":"1 - send events by client entity, 0 - don't send","format":"int32"},"record":{"type":"integer","description":"1 - send events by appointment entity, 0 - do not send","format":"int32"},"goods_operations_sale":{"type":"integer","description":"1 - send events by the product sale entity, 0 - do not send","format":"int32"},"goods_operations_receipt":{"type":"integer","description":"1 - send events by the entity arrival of products, 0 - do not send","format":"int32"},"goods_operations_consumable":{"type":"integer","description":"1 - send events by the consumable write-off entity, 0 - do not send","format":"int32"},"goods_operations_stolen":{"type":"integer","description":"1 - send events by the product write-off entity, 0 - do not send","format":"int32"},"goods_operations_move":{"type":"integer","description":"1 - send events by the product movement entity, 0 - no send","format":"int32"},"finances_operation":{"type":"integer","description":"1 - send events by entity financial operation, 0 - no send","format":"int32"}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Event notification settings","example":{"success":true,"data":{"urls":["https://dev.tools.test.com/test/Hooks"],"active":0,"salon":1,"service_category":0,"service":1,"good":1,"master":1,"client":1,"record":1,"goods_operations_sale":1,"goods_operations_receipt":1,"goods_operations_consumable":1,"goods_operations_stolen":1,"goods_operations_move":1,"finances_operation":1},"meta":[]}}},"components/schemas/voip_integration_enable_request_data_types":{"id":"components/schemas/voip_integration_enable_request_data_types","kind":"json-schema","title":"Connect Integration","data":{"title":"Connect Integration","required":["command","crm_token","type"],"type":"object","properties":{"command":{"type":"string","description":"Operation type: 'setup'"},"type":{"type":"string","description":"Operation type, in this case 'enable'"},"crm_token":{"type":"string","description":"CRM-token from the VoIP Integration in the client's chain section"}},"description":"Connect integration","example":{"command":"setup","type":"enable","crm_token":"7cf262d6-1656-43f9-86ac-2826bdc125d2"}}},"components/schemas/voip_integration_disable_request_data_types":{"id":"components/schemas/voip_integration_disable_request_data_types","kind":"json-schema","title":"Disable integration","data":{"title":"Disable integration","required":["command","crm_token","type"],"type":"object","properties":{"command":{"type":"string","description":"Operation type: 'setup'"},"type":{"type":"string","description":"Operation type, in this case 'disable'"},"crm_token":{"type":"string","description":"CRM-token from the VoIP Integration in the client's chain section"}},"description":"Disable Integration","example":{"command":"setup","type":"disable","crm_token":"7cf262d6-1656-43f9-86ac-2826bdc125d2"}}},"components/schemas/voip_integration_history_request_data_types":{"id":"components/schemas/voip_integration_history_request_data_types","kind":"json-schema","title":"Saving call information","data":{"title":"Saving call information","required":["command","crm_token","diversion","phone","type"],"type":"object","properties":{"command":{"type":"string","description":"Operation type: 'history'"},"type":{"type":"string","description":"Operation type (\"incoming\", \"outgoing\", \"internal\")"},"crm_token":{"type":"string","description":"CRM-token from the VoIP Integration in the client's chain section"},"phone":{"type":"string","description":"Caller number"},"user":{"type":"string","description":"SIP subscriber ID"},"diversion":{"type":"string","description":"The number through which the call came"},"duration":{"type":"number","description":"Call duration (in seconds)"},"link":{"type":"string","description":"Call recording link"},"call_id":{"type":"string","description":"Call ID in voip system"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call status 'success'|'missed'"},"children":[]}]}]}]},"date":{"type":"string","description":"Date and time of the call (ISO8601)","format":"date-time"}},"description":"Save Call Information","example":{"command":"history","type":"incoming","crm_token":"7cf262d6-1656-43f9-86ac-2826bdc125d2","phone":"+13155550175","user":"external_user_id","diversion":"+13155550176","duration":90,"link":"https://external.call.storage/call_record.mp3","call_id":"external_call_id","status":"success","date":"2026-09-01T14:40:28-05:00"}}},"components/schemas/voip_integration_notification_request_data_types":{"id":"components/schemas/voip_integration_notification_request_data_types","kind":"json-schema","title":"call notification","data":{"title":"call notification","required":["command","crm_token","diversion","phone","type"],"type":"object","properties":{"command":{"type":"string","description":"Operation type: 'event'"},"type":{"type":"string","description":"Operation type, in this case \"incoming\""},"crm_token":{"type":"string","description":"CRM-token from the VoIP Integration in the client's chain section"},"phone":{"type":"string","description":"Caller number"},"user":{"type":"string","description":"SIP number"},"diversion":{"type":"string","description":"The number through which the call came"}},"description":"Call Notification","example":{"command":"event","type":"incoming","crm_token":"7cf262d6-1656-43f9-86ac-2826bdc125d2","phone":"+13155550175","user":"external_user_id","diversion":"+13155550176"}}},"components/schemas/voip_integration_response_data_types":{"id":"components/schemas/voip_integration_response_data_types","kind":"json-schema","title":"Root Type for voip_integration_setup_response_data_types","data":{"title":"Root Type for voip_integration_setup_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Success status (true)"},"data":{"type":"string","description":"Contains null"},"meta":{"type":"object","properties":{"message":{"type":"string"}},"description":"Metadata (contain an \"Accepted\" message)"}},"description":"Connect Integration","example":{"success":true,"meta":{"message":"Accepted"}}}},"components/schemas/countries_response_data_types":{"id":"components/schemas/countries_response_data_types","kind":"json-schema","title":"Root Type for countries_response_data_types","data":{"title":"Root Type for countries_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of objects with data","items":{"type":"object","properties":{"id":{"type":"number","description":"Country ID"},"title":{"type":"string","description":"Short country name"},"full_title":{"type":"string","description":"Full country name"},"iso_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code"},"phone_code":{"type":"string","description":"Country phone code"},"phone_template":{"type":"string","description":"Country phone number mask"},"phone_example":{"type":"string","description":"Country phone number example"},"currency":{"type":"string","description":"Country currency symbol"},"exchange":{"type":"number","description":"Currency exchange rate"},"lang_id":{"type":"number","description":"Language ID"},"group_type":{"type":"number","description":"Country group type"},"is_eu":{"type":"boolean","description":"Whether the country is in the European Union"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of countries","example":{"success":true,"data":[{"id":7,"title":"USA","full_title":"United States","iso_code":"US","phone_code":"1","phone_template":"+1 xxx-xxx-xxxx","phone_example":"+1 201-123-4567","currency":"$","exchange":32.99,"lang_id":2,"group_type":1,"is_eu":false},{"id":56,"title":"France","full_title":"France","iso_code":"FR","phone_code":"33","phone_template":"+33 x xx xx xx xx","phone_example":"+33 1 23 45 67 89","currency":"€","exchange":11.18,"lang_id":8,"group_type":1,"is_eu":true}],"meta":[]}}},"components/schemas/cities_response_data_types":{"id":"components/schemas/cities_response_data_types","kind":"json-schema","title":"Root Type for cities_response_data_types","data":{"title":"Root Type for cities_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of objects with data","items":{"type":"object","properties":{"id":{"type":"number","description":"City ID"},"country_id":{"type":"number","description":"Country ID"},"title":{"type":"string","description":"City name"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of cities","example":{"success":true,"data":[{"id":2,"country_id":7,"title":"New York"},{"id":1040,"country_id":30,"title":"Belfast"},{"id":1201,"country_id":38,"title":"București"},{"id":1334,"country_id":31,"title":"Budapest"}],"meta":[]}}},"components/schemas/references_business_group_response_data_types":{"id":"components/schemas/references_business_group_response_data_types","kind":"json-schema","title":"Root Type for references_business_group_response_data_types","data":{"title":"Root Type for references_business_group_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of objects with data","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Category ID"},"title":{"type":"string","description":"name of category"},"image":{"type":"string","description":"Group image"},"image_small":{"type":"string","description":"Group small image"},"types":{"type":"array","description":"Related business types","items":{"type":"object","properties":{"id":{"type":"number","description":"Type identifier"},"title":{"type":"string","description":"Type name"},"business_group_id":{"type":"number","description":"Business group ID"}}}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of business types found)"}},"description":"Getting a list of business types grouped by group","example":{"success":true,"data":[{"id":10,"title":"Domestic services","image":"https://app.alteg.io/images/business-groups/services.png","types":[{"id":31,"title":"Studio","business_group_id":10}]},{"id":1,"title":"beauty","image":"https://app.alteg.io/images/business-groups/beauty.png","types":[{"id":1,"title":"Beauty Salons","business_group_id":1},{"id":25,"title":"Spa","business_group_id":1}]}],"meta":{"count":10}}}},"components/schemas/salon":{"id":"components/schemas/salon","kind":"json-schema","title":"Webhook Salon Data","data":{"title":"Webhook Salon Data","description":"Location data sent in webhook notifications. Corresponds to the output of the location detail API. Contains comprehensive location information.","type":"object","properties":{"id":{"type":"integer","description":"Location ID."},"title":{"type":"string","description":"Location name."},"public_title":{"type":"string","description":"Public display name."},"phone":{"type":"string","description":"Primary phone number."},"phones":{"type":"array","items":{"type":"string"},"description":"All phone numbers."},"country_id":{"type":"integer"},"country":{"type":"string"},"city_id":{"type":"integer"},"city":{"type":"string"},"active":{"type":"integer","enum":[0,1],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 — active, 0 — inactive."},"children":[]}]}]}]},"timezone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timezone offset (e.g. \"+3\")."},"children":[]}]}]}]},"timezone_name":{"type":"string","description":"IANA timezone name."},"address":{"type":"string"},"coordinate_lat":{"type":"number"},"coordinate_lon":{"type":"number"},"currency_short_title":{"type":"string","description":"Currency code (e.g. \"USD\")."},"business_group_id":{"type":"integer"},"business_type_id":{"type":"integer"},"site":{"type":"string","description":"Website URL."},"zip":{"type":"string"},"logo":{"type":"string","description":"Logo URL."},"short_descr":{"type":"string","description":"Short description."},"description":{"type":"string","description":"Full description (HTML)."},"schedule":{"type":"object","description":"Working hours schedule."},"email":{"type":"string"},"social":{"type":"object","description":"Social media links.","properties":{"facebook":{"type":"string"},"instagram":{"type":"string"},"telegram":{"type":"string"},"whatsapp":{"type":"string"},"viber":{"type":"string"},"vk":{"type":"string"}}},"main_group_id":{"type":"integer"},"main_group":{"type":["object","null"],"properties":{"id":{"type":"integer"},"title":{"type":"string"}}},"record_type_id":{"type":"integer"},"booking_comment_required":{"type":"boolean"},"booking_email_required":{"type":"boolean"}},"additionalProperties":true}},"components/schemas/staff":{"id":"components/schemas/staff","kind":"json-schema","title":"Webhook Staff Data","data":{"title":"Webhook Staff Data","description":"Team member data sent in webhook notifications. Matches the output of the team member detail API.","type":"object","properties":{"id":{"type":"integer","description":"Team member ID."},"api_id":{"type":"string"},"name":{"type":"string","description":"Full name."},"specialization":{"type":"string"},"position":{"type":"object","description":"Position details.","properties":{"id":{"type":"integer"},"title":{"type":"string"}}},"show_rating":{"type":"integer","enum":[0,1]},"rating":{"type":"number"},"votes_count":{"type":"integer"},"avatar":{"type":"string","description":"Avatar thumbnail URL."},"avatar_big":{"type":"string","description":"Full-size avatar URL."},"comments_count":{"type":"integer"},"weight":{"type":"integer","description":"Sort order."},"information":{"type":"string","description":"HTML biography."},"hidden":{"type":"integer","enum":[0,1]},"fired":{"type":"integer","enum":[0,1],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 — dismissed, 0 — active."},"children":[]}]}]}]},"status":{"type":"integer","enum":[0,1]},"position_id":{"type":"integer"},"schedule_till":{"type":"string","description":"Schedule end date."},"image_group":{"type":"object","description":"Image group data."},"prepaid":{"type":"string","description":"Prepaid slug."},"user_id":{"type":["integer","null"]},"user":{"type":["object","null"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"avatar":{"type":"string"}}},"has_access_timetable":{"type":"boolean"},"is_paid_staff":{"type":"boolean"}},"additionalProperties":true}},"components/schemas/service":{"id":"components/schemas/service","kind":"json-schema","title":"Webhook Service Data","data":{"title":"Webhook Service Data","description":"Service data sent in webhook notifications. Matches the output of the service detail API.","type":"object","properties":{"id":{"type":"integer","description":"Service ID."},"salon_service_id":{"type":"integer"},"title":{"type":"string"},"booking_title":{"type":"string","description":"Title shown in online booking."},"category_id":{"type":"integer"},"price_min":{"type":"number"},"price_max":{"type":"number"},"duration":{"type":"integer","description":"Duration in minutes."},"discount":{"type":"number"},"comment":{"type":"string"},"weight":{"type":"integer","description":"Sort order."},"active":{"type":"integer","enum":[0,1]},"api_id":{"type":"string"},"staff":{"type":"array","description":"Assigned team members.","items":{"type":"object","properties":{"id":{"type":"integer"},"seance_length":{"type":"integer"}}}},"image_group":{"type":"object"},"prepaid":{"type":"string"},"is_multi":{"type":"boolean"},"capacity":{"type":"integer"},"is_price_managed_only_in_chain":{"type":"boolean"},"is_comment_managed_only_in_chain":{"type":"boolean"}},"additionalProperties":true}},"components/schemas/service_category":{"id":"components/schemas/service_category","kind":"json-schema","title":"Webhook Service Category Data","data":{"title":"Webhook Service Category Data","description":"Service category data sent in webhook notifications.","type":"object","properties":{"id":{"type":"integer","description":"Service category ID."},"salon_service_id":{"type":"integer"},"title":{"type":"string"},"weight":{"type":"integer","description":"Sort order."},"api_id":{"type":"string"},"staff":{"type":"array","description":"Team member IDs assigned to this category.","items":{"type":"integer"}},"is_chain":{"type":"boolean"}}}},"components/schemas/client":{"id":"components/schemas/client","kind":"json-schema","title":"Webhook Client Data","data":{"title":"Webhook Client Data","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client data sent in webhook notifications. Uses the full client profile with all default includes (email, card, birth_date, comment, discount, visits, sex, sms preferences, money, importance, categories, custom_fields, national_id)."},"children":[]}]}]}],"type":"object","properties":{"id":{"type":"integer","description":"Client ID."},"name":{"type":"string","description":"First name."},"surname":{"type":"string"},"patronymic":{"type":"string"},"display_name":{"type":"string","description":"Formatted full name."},"phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number (visible — webhook always has full access)."},"children":[]}]}]}]},"email":{"type":"string"},"card":{"type":"string","description":"Loyalty card number."},"birth_date":{"type":"string","format":"date","description":"Birthday in YYYY-MM-DD format."},"comment":{"type":"string","description":"Client card comment."},"discount":{"type":"number","description":"Personal discount percentage."},"visits":{"type":"integer","description":"Total visit count."},"sex_id":{"type":"integer","enum":[0,1,2],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 — unknown, 1 — male, 2 — female."},"children":[]}]}]}]},"sex":{"type":"string"},"sms_check":{"type":"integer","enum":[0,1]},"sms_bot":{"type":"integer","enum":[0,1]},"sms_not":{"type":"integer","enum":[0,1]},"spent":{"type":"number","description":"Total amount spent."},"paid":{"type":"number","description":"Total amount paid."},"balance":{"type":"number","description":"Current balance."},"importance_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0 — normal, 1 — VIP, 2 — blacklisted."},"children":[]}]}]}]},"importance":{"type":"string"},"categories":{"type":"array","description":"Client category labels.","items":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"color":{"type":"string"}}}},"last_change_date":{"type":"string","format":"date-time"},"custom_fields":{"type":"array","description":"Custom field values configured for this location.","items":{"type":"object"}},"national_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client national ID — CPF for Brazil, IIN for Kazakhstan. Empty string when not set."},"children":[]}]}]}]}},"additionalProperties":true}},"components/schemas/record":{"id":"components/schemas/record","kind":"json-schema","title":"Webhook Record Data","data":{"title":"Webhook Record Data","description":"Appointment data sent in webhook notifications. Contains comprehensive appointment details including services, team member, client, and financial information.","type":"object","properties":{"id":{"type":"integer","description":"Appointment ID."},"company_id":{"type":"integer"},"staff_id":{"type":"integer"},"clients_count":{"type":"integer"},"date":{"type":"string"},"datetime":{"type":"string","format":"date-time"},"create_date":{"type":"string","format":"date-time"},"last_change_date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"online":{"type":"boolean"},"visit_id":{"type":"integer"},"visit_attendance":{"type":"integer"},"attendance":{"type":"integer"},"confirmed":{"type":"integer","enum":[0,1]},"seance_length":{"type":"integer","description":"Duration in seconds."},"length":{"type":"integer"},"sms_before":{"type":"integer","enum":[0,1]},"sms_now":{"type":"boolean"},"sms_now_text":{"type":"string"},"email_now":{"type":"integer","enum":[0,1]},"notified":{"type":"string"},"master_request":{"type":"string"},"api_id":{"type":"string"},"from_url":{"type":"string"},"review_requested":{"type":"integer","enum":[0,1]},"created_user_id":{"type":"integer"},"deleted":{"type":"boolean"},"paid_full":{"type":"boolean"},"prepaid":{"type":"boolean"},"prepaid_confirmed":{"type":"boolean"},"is_update_blocked":{"type":"boolean"},"activity_id":{"type":"integer"},"bookform_id":{"type":"integer"},"record_from":{"type":"string"},"is_mobile":{"type":"boolean"},"services":{"type":"array","description":"Booked services.","items":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"cost":{"type":"number"},"cost_to_pay":{"type":"number"},"manual_cost":{"type":"number"},"cost_per_unit":{"type":"number"},"discount":{"type":"number"},"first_cost":{"type":"number"},"amount":{"type":"integer"}}}},"staff":{"type":["object","null"],"description":"Assigned team member.","properties":{"id":{"type":"integer"},"api_id":{"type":"string"},"name":{"type":"string"},"specialization":{"type":"string"},"position":{"type":"object"},"avatar":{"type":"string"},"avatar_big":{"type":"string"},"rating":{"type":"number"},"votes_count":{"type":"integer"}}},"client":{"type":["object","null"],"description":"Client details.","properties":{"id":{"type":"integer"},"name":{"type":"string"},"surname":{"type":"string"},"patronymic":{"type":"string"},"display_name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"card":{"type":"string"},"comment":{"type":"string"},"discount":{"type":"number"},"sex":{"type":"string"},"birthday":{"type":"string"},"national_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client national ID — CPF for Brazil, IIN for Kazakhstan. Empty string when not set. Sent in the webhook payload only — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /record/{company_id}/{record_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not return it."},"children":[]}]}]}]},"success_visits_count":{"type":"integer"},"fail_visits_count":{"type":"integer"},"custom_fields":{"type":"array","items":{"type":"object"}},"client_tags":{"type":"array","items":{"type":"object"}}}},"goods_transactions":{"type":"array","description":"Product operations linked to this appointment.","items":{"type":"object"}},"custom_fields":{"type":"array","items":{"type":"object"}},"custom_color":{"type":"string","description":"Hex color code."},"custom_font_color":{"type":"string"},"record_labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"color":{"type":"string"},"icon":{"type":"string"},"font_color":{"type":"string"}}}},"documents":{"type":"array","items":{"type":"object"}},"short_link":{"type":"string"},"sms_remain_hours":{"type":["integer","null"]},"email_remain_hours":{"type":["integer","null"]},"comer":{"type":["object","null"]},"comer_person_info":{"type":["object","null"]},"composite":{"type":["object","array"],"description":"Composite appointment data if applicable."}},"additionalProperties":true}},"components/schemas/loyalty_card":{"id":"components/schemas/loyalty_card","kind":"json-schema","title":"Webhook Loyalty Card Data","data":{"title":"Webhook Loyalty Card Data","description":"Loyalty card data sent in webhook notifications. Uses a simplified transformer with essential fields only.","type":"object","required":["id","balance","number","phone"],"properties":{"id":{"type":"integer","description":"Loyalty card ID."},"balance":{"type":"number","description":"Current card balance."},"number":{"type":"string","description":"Card number."},"phone":{"type":"string","description":"Phone number linked to the card."}}}},"components/schemas/good":{"id":"components/schemas/good","kind":"json-schema","title":"Webhook Good Data","data":{"title":"Webhook Good Data","description":"Product data sent in webhook notifications. Matches the output of the product detail API.","type":"object","properties":{"good_id":{"type":"integer","description":"Product ID."},"title":{"type":"string"},"value":{"type":"string","description":"Same as title."},"label":{"type":"string","description":"Title with article in parentheses."},"article":{"type":"string"},"category":{"type":"string"},"category_id":{"type":"integer"},"salon_id":{"type":"integer"},"cost":{"type":"number"},"unit_id":{"type":"integer"},"unit_short_title":{"type":"string"},"service_unit_id":{"type":"integer"},"service_unit_short_title":{"type":"string"},"actual_cost":{"type":"number"},"unit_actual_cost":{"type":"number"},"unit_actual_cost_format":{"type":"string","description":"Formatted price string."},"unit_equals":{"type":"number"},"barcode":{"type":"string"},"is_chain":{"type":"boolean"},"comment":{"type":"string"},"loyalty_abonement_type_id":{"type":"integer"},"loyalty_certificate_type_id":{"type":"integer"},"loyalty_certificate_type":{"type":["object","null"]},"loyalty_allow_empty_code":{"type":"integer","enum":[0,1]},"loyalty_serial_number_limited":{"type":"integer","enum":[0,1]},"actual_amounts":{"type":"array","items":{"type":"object"}},"critical_amount":{"type":["number","null"]},"desired_amount":{"type":"number"},"last_change_date":{"type":"string","format":"date-time"},"is_goods_mark_enabled":{"type":"boolean"}},"additionalProperties":true}},"components/schemas/goods_operations":{"id":"components/schemas/goods_operations","kind":"json-schema","title":"Webhook Goods Operation Data","data":{"title":"Webhook Goods Operation Data","description":"Product operation data sent in webhook notifications. Covers all operation types: sale, receipt, consumable write-off, product write-off, and movement.","type":"object","properties":{"id":{"type":"integer","description":"Transaction ID."},"document_id":{"type":"integer"},"type_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction type: 1 — sale, 2 — write-off, etc."},"children":[]}]}]}]},"type":{"type":"string"},"operation_unit_type":{"type":"string"},"amount":{"type":"number"},"create_date":{"type":"string","format":"date-time"},"cost_per_unit":{"type":"number"},"cost":{"type":"number"},"discount":{"type":"number"},"comment":{"type":"string"},"record_id":{"type":"integer"},"last_change_date":{"type":"string","format":"date-time"},"loyalty_abonement_id":{"type":["integer","null"]},"loyalty_certificate_id":{"type":["integer","null"]},"good":{"type":"object","description":"Related product.","properties":{"id":{"type":"integer"},"title":{"type":"string"}}},"unit":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"short_title":{"type":"string"}}},"storage":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"}}},"client":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"phone":{"type":"string"}}},"master":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"}}},"service":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"}}},"supplier":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"}}}},"additionalProperties":true}},"components/schemas/finances_operation":{"id":"components/schemas/finances_operation","kind":"json-schema","title":"Webhook Financial Operation Data","data":{"title":"Webhook Financial Operation Data","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Financial transaction data sent in webhook notifications. Includes default relations (expense, master, supplier, account, client) and webhook-specific includes (record, client.email). May optionally include payment_system_transaction_ids if the feature is enabled for the location."},"children":[]}]}]}],"type":"object","properties":{"id":{"type":"integer","description":"Transaction ID."},"document_id":{"type":"integer"},"date":{"type":["string","null"],"format":"date-time"},"amount":{"type":"number"},"comment":{"type":"string"},"last_change_date":{"type":["string","null"],"format":"date-time"},"record_id":{"type":"integer"},"visit_id":{"type":"integer"},"sold_item_id":{"type":"integer"},"sold_item_type":{"type":"string"},"expense":{"type":"object","description":"Expense category.","properties":{"id":{"type":"integer"},"title":{"type":"string"}}},"master":{"type":"object","description":"Team member."},"supplier":{"type":"object","description":"Supplier."},"account":{"type":"object","description":"Payment account."},"client":{"type":"object","description":"Client with email included.","properties":{"id":{"type":"integer"},"name":{"type":"string"},"surname":{"type":"string"},"patronymic":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}},"record":{"type":"object","description":"Linked appointment (compact)."},"payment_system_transaction_ids":{"type":"array","description":"Payment system transaction IDs (optional, feature-flagged).","items":{"type":"string"}}},"additionalProperties":true}},"schema_508":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_508"},"schema_509":{"kind":"json-schema","data":{"type":"string"},"id":"schema_509"},"schema_510":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","description":"Permissions declared by the application","items":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable permission name","example":"Manage clients"},"slug":{"type":"string","description":"Permission group slug","example":"clients"},"child_permissions":{"type":"array","description":"Concrete permission slugs included in this group","items":{"type":"string"},"example":["create_client","update_client"]}}}},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}},"example":{"success":true,"data":[{"title":"Manage clients","slug":"clients","child_permissions":["create_client","update_client"]}],"meta":[]}},"id":"schema_510"},"schema_511":{"kind":"json-schema","data":{"type":"number"},"id":"schema_511"},"schema_512":{"kind":"json-schema","data":{"type":"number","maximum":1000},"id":"schema_512"},"schema_513":{"kind":"json-schema","data":{"type":"string","default":"application/vnd.api.v2+json"},"id":"schema_513"},"schema_514":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","description":"List of tariffs","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tariff ID","example":89},"title":{"type":"string","description":"Tariff name","example":"1 month"},"options":{"type":"array","description":"Tariff options","items":{"type":"object","properties":{"id":{"type":"integer","description":"Option ID","example":123},"title":{"type":"string","description":"Option name","example":"Solo professional"},"overall_price":{"type":"number","format":"float","description":"Total price","example":500},"duration_in_months":{"type":"integer","description":"Duration in months","example":1},"currency_iso":{"type":"string","description":"Currency ISO code","example":"USD"},"staff_amount":{"type":"integer","description":"Maximum team members for this option","example":1},"free_period_in_months":{"type":"integer","description":"Free trial period in months","example":0}}}}}}},"meta":{"type":"array","example":[]}}},"id":"schema_514"},"schema_515":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object"}}},"id":"schema_515"},"schema_516":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_516"},"schema_517":{"kind":"json-schema","data":{"required":["salon_ids","application_id","discount"],"type":"object","properties":{"salon_ids":{"type":"array","description":"List of location IDs to apply discount","items":{"type":"integer"},"example":[123,456]},"application_id":{"type":"integer","description":"Application ID from marketplace","example":123},"discount":{"type":"number","format":"float","description":"Discount amount (percentage or fixed amount depending on configuration)","example":15.54}}},"id":"schema_517"},"schema_518":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object"},"meta":{"type":"array"}}},"id":"schema_518"},"schema_519":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"No access to application"}}}}},"id":"schema_519"},"schema_520":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Application not found"}}}}},"id":"schema_520"},"schema_521":{"kind":"json-schema","data":{"type":"number","format":"float"},"id":"schema_521"},"schema_522":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"url":{"type":"string","description":"Payment page URL","example":"https://alteg.io/appstore/payment/?salon_id=1111&application_id=1&discount=15.5&source=api&sign=6f9b5bc6fa787780161ed090af9429d5af963562b7a6ac8051888147370674be"}}},"meta":{"type":"array","example":[]}}},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"required":["salon_id","application_id","channel_slug","is_available"],"type":"object","properties":{"salon_id":{"type":"integer","description":"Location ID","example":123},"application_id":{"type":"integer","description":"Application ID","example":456},"channel_slug":{"type":"string","description":"Channel to update availability for","enum":["sms","whatsapp"],"example":"sms"},"is_available":{"type":"boolean","description":"Channel availability flag","example":true}}},"id":"schema_523"},"schema_524":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object"}}}}},"id":"schema_524"},"schema_525":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"object","properties":{"connection_status":{"type":"object","description":"Installation status","properties":{"status":{"type":"string","enum":["pending","freezed","active"],"description":"Application installation status in the location. Pending - waiting for activation from the partner, Freezed - frozen due to non-payment, Active - active"},"created_at":{"type":"string","description":"Date of link creation"}}},"payments":{"type":"array","description":"Payments list","items":{"type":"object","properties":{"payment_sum":{"type":"number","description":"The payment amount for the period."},"id":{"type":"number","description":"Payment ID."},"payment_date":{"type":"string","description":"The date of payment."},"is_refunded":{"type":"boolean","description":"Was there a refund?"},"period_from":{"type":"string","description":"Subscription start date"},"period_to":{"type":"string","description":"Subscription end date"}}}},"logs":{"type":"array","description":"Application status change log in location","items":{"type":"object","properties":{"changed_at":{"type":"string","description":"Status change date"},"status_from":{"type":"string","description":"Previous app status in location"},"status_to":{"type":"string","description":"New application status in the location"},"source":{"type":"string","description":"Status Change Source"}}}}}},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}},"example":{"success":true,"data":{"logs":[{"changed_at":"2022-06-27 12:20:02","status_from":"uninstalled","status_to":"pending","source":"marketplace"},{"changed_at":"2022-06-27 12:22:02","status_from":"pending","status_to":"active","source":"partner_api"}],"payments":[{"id":1523,"payment_sum":1523.12,"payment_date":"2022-06-27 12:22:02","is_refunded":false,"period_from":"2022-06-27 00:00:00","period_to":"2022-07-27 00:00:00"}],"connection_status":{"status":"active","created_at":"2022-06-27 12:20:02"}}}},"id":"schema_525"},"schema_526":{"kind":"json-schema","data":{"required":["salon_id","application_id"],"type":"object","properties":{"salon_id":{"type":"number","description":"Location ID.","example":123},"application_id":{"type":"number","description":"Application ID.","example":123},"api_key":{"type":"number","description":"API-key for messaging module.","example":"2f181e2a-5c22-4ae7-9d9b-07104f312c28"},"webhook_urls":{"type":"array","description":"Webhooks array","items":{"type":"string"},"example":["https://example.com/webhook"]}}},"id":"schema_526"},"schema_527":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true}}},"id":"schema_527"},"schema_528":{"kind":"json-schema","data":{"required":["salon_id","currency_iso","application_id","payment_sum","payment_date","period_from","period_to"],"type":"object","properties":{"salon_id":{"type":"number","description":"Location ID.","example":123},"application_id":{"type":"number","description":"Application ID.","example":123},"currency_iso":{"type":"string","description":"Currency ISO (e.g.: USD, EUR, BYN)","example":"EUR"},"payment_sum":{"type":"number","description":"Payment amount.","example":990.99},"payment_date":{"type":"string","description":"Date and time of payment.","example":"2022-01-01 10:10:00"},"period_from":{"type":"string","description":"Date from which the paid period begins (inclusive).","example":"2022-01-01 10:10:00"},"period_to":{"type":"string","description":"Date from which the paid period ends (inclusive).","example":"2022-02-01 10:10:00"}}},"id":"schema_528"},"schema_529":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"title":"Status.","type":"boolean","description":"Status.","example":true},"data":{"type":"object","description":"Data.","properties":{"id":{"description":"Payment ID","type":"number","example":123}}}}},"id":"schema_529"},"schema_530":{"kind":"json-schema","data":{"required":["salon_id","application_id","short_names"],"type":"object","properties":{"salon_id":{"type":"number","description":"Location ID.","example":123},"application_id":{"type":"number","description":"Application ID","example":123},"short_names":{"type":"array","description":"Array of SMS names","items":{"type":"string"},"example":["Altegio","AL"]}}},"id":"schema_530"},"schema_531":{"kind":"json-schema","data":{"required":["salon_id","application_id","event","partner_token"],"type":"object","properties":{"salon_id":{"type":"number","description":"Location ID.","example":123},"application_id":{"type":"number","description":"Application ID.","example":123},"event":{"type":"string","description":"Event Slug.","enum":["uninstall","freeze"],"example":"uninstall"},"partner_token":{"type":"string","description":"Bearer token of the developer's location (to verify the origin of the webhook)","example":"yasdfkjah2328aj"}}},"id":"schema_531"},"schema_532":{"kind":"json-schema","data":{"required":["active","urls"],"type":"object","properties":{"urls":{"type":"array","description":"List of addresses to send notifications to"},"active":{"type":"number","description":"1 - notifications are active, 0 - not active"},"salon":{"type":"number","description":"1 - send events by location entity, 0 - do not send"},"service_category":{"type":"number","description":"1 - send events by service category entity, 0 - do not send"},"service":{"type":"number","description":"1 - send events by service entity, 0 - do not send"},"good":{"type":"number","description":"1 - send events by product entity, 0 - don't send"},"master":{"type":"number","description":"1 - send events by team member entity, 0 - don't send"},"client":{"type":"number","description":"1 - send events by client entity, 0 - don't send"},"record":{"type":"number","description":"1 - send events by appointment entity, 0 - do not send"},"goods_operations_sale":{"type":"number","description":"1 - send events by the product sale entity, 0 - do not send"},"goods_operations_receipt":{"type":"number","description":"1 - send events by the entity arrival of products, 0 - do not send"},"goods_operations_consumable":{"type":"number","description":"1 - send events by the consumable write-off entity, 0 - do not send"},"goods_operations_stolen":{"type":"number","description":"1 - send events by the product write-off entity, 0 - do not send"},"goods_operations_move":{"type":"number","description":"1 - send events by the product movement entity, 0 - no send"},"finances_operation":{"type":"number","description":"1 - send events by entity financial operation, 0 - no send"},"self_sending":{"type":"number","description":"1 - The webhook creator will receive events triggered by their own actions, 0 - The webhook creator will not receive events triggered by their own actions"}},"example":{"urls":["https://dev.tools.test.com/test/Hooks"],"active":0,"salon":1,"service_category":0,"service":1,"good":1,"master":1,"client":1,"record":1,"goods_operations_sale":1,"goods_operations_receipt":1,"goods_operations_consumable":1,"goods_operations_stolen":1,"goods_operations_move":1,"finances_operation":1,"self_sending":0}},"id":"schema_532"},"schema_533":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["salon"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/salon"}}},"id":"schema_533"},"schema_534":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["staff"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/staff"}}},"id":"schema_534"},"schema_535":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["service"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/service"}}},"id":"schema_535"},"schema_536":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["service_category"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/service_category"}}},"id":"schema_536"},"schema_537":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["client"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/client"}}},"id":"schema_537"},"schema_538":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["record"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/record"}}},"id":"schema_538"},"schema_539":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["loyalty_card"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/loyalty_card"}}},"id":"schema_539"},"schema_540":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["schedule"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"type":"array","maxItems":0,"description":"Always empty for schedule events."}}},"id":"schema_540"},"schema_541":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["good"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/good"}}},"id":"schema_541"},"schema_542":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["goods_operations_sale","goods_operations_receipt","goods_operations_consumable","goods_operations_stolen","goods_operations_move"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/goods_operations"}}},"id":"schema_542"},"schema_543":{"kind":"json-schema","data":{"type":"object","required":["company_id","resource","resource_id","status","data"],"properties":{"company_id":{"type":"integer","description":"Location ID where the event occurred."},"resource":{"type":"string","description":"Resource type.","enum":["finances_operation"]},"resource_id":{"type":"integer","description":"ID of the resource that was created, updated, or deleted."},"status":{"type":"string","description":"Type of change that occurred.","enum":["create","update","delete"]},"data":{"$ref":"#/components/schemas/finances_operation"}}},"id":"schema_543"},"schema_544":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/voip_integration_enable_request_data_types"},{"$ref":"#/components/schemas/voip_integration_disable_request_data_types"},{"$ref":"#/components/schemas/voip_integration_history_request_data_types"},{"$ref":"#/components/schemas/voip_integration_notification_request_data_types"}]},"id":"schema_544"},"schema_545":{"kind":"json-schema","data":{"required":["salon_id","date_from","date_to"],"type":"object","properties":{"salon_id":{"type":"number","description":"Location ID.","example":615243},"date_from":{"type":"string","description":"Start date.","example":"2026-01-01"},"date_to":{"type":"string","description":"End date.","example":"2026-02-01"},"phone":{"type":"string","description":"Phone number.","example":"+13155550175"},"types":{"type":"array","description":"Call types list","items":{"type":"string","enum":["incoming","outgoing","internal"]},"example":["incoming","internal"]},"statuses":{"type":"array","description":"Call statuses list","items":{"type":"string","enum":["success","missed","cancel","busy","notallowed","notavailable","notfound"]},"example":["success","cancel"]},"page":{"type":"number","description":"Page number","example":1},"limit":{"type":"number","description":"Amount of elements on page","example":25,"maximum":1000}}},"id":"schema_545"},"schema_546":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","description":"Calls list","items":{"type":"object","properties":{"id":{"type":"integer","description":"Call ID"},"client_id":{"type":"integer","description":"Client ID (if there is a client in Clients Base)"},"caller_phone":{"type":"string","description":"Phone number"},"record_link":{"type":"string","description":"Link to call recording (if available)"},"duration":{"type":"integer","description":"Call duration in seconds"},"status":{"type":"string","enum":["success","missed","cancel","busy","notallowed","notavailable","notfound"],"description":"Call status"},"type":{"type":"string","description":"Call type","enum":["incoming","outgoing","internal"]},"call_date":{"type":"string","description":"Date and time of call"}}}},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}},"example":{"success":true,"data":[{"id":8923525,"client_id":51342134,"caller_phone":"+13155550175","record_link":"https://records.example.com/somelink.mp3","duration":244,"status":"success","type":"outgoing","call_date":"2026-01-17T23:52:21-05:00"},{"id":66795308,"client_id":0,"caller_phone":"+13155550175","record_link":"","duration":0,"status":"missed","type":"incoming","call_date":"2026-01-17T12:31:12-05:00"}]}},"id":"schema_546"}},"exampleStore":{"paths/~1hooks_settings~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"urls":["https://dev.tools.test.com/test/Hooks"],"active":0,"salon":1,"service_category":0,"service":1,"good":1,"master":1,"client":1,"record":1,"goods_operations_sale":1,"goods_operations_receipt":1,"goods_operations_consumable":1,"goods_operations_stolen":1,"goods_operations_move":1,"finances_operation":1},"meta":[]},"id":"paths/~1hooks_settings~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1hooks_settings~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"urls":["https://dev.tools.test.com/test/Hooks"],"active":0,"salon":1,"service_category":0,"service":1,"master":1,"client":1,"record":1,"goods_operations_sale":1,"goods_operations_receipt":1,"goods_operations_consumable":1,"goods_operations_stolen":1,"goods_operations_move":1,"finances_operation":1},"meta":[]},"id":"paths/~1hooks_settings~1{location_id}/post/responses/201/content/application~1json/example"},"paths/SalonEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"salon","resource_id":123456,"status":"update","data":{"id":123456,"title":"Beauty Studio","public_title":"Beauty Studio","active":1,"phone":"+1234567890","city":"New York","address":"123 Main St","timezone_name":"America/New_York"}},"id":"paths/SalonEvent/post/requestBody/content/application~1json/example"},"paths/StaffEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"staff","resource_id":101,"status":"create","data":{"id":101,"name":"John Smith","specialization":"Hairdresser","avatar":"https://cdn.example.com/avatar.jpg","rating":4.8,"fired":0,"hidden":0}},"id":"paths/StaffEvent/post/requestBody/content/application~1json/example"},"paths/ServiceEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"service","resource_id":201,"status":"update","data":{"id":201,"title":"Haircut","price_min":30,"price_max":50,"duration":60,"active":1,"category_id":10}},"id":"paths/ServiceEvent/post/requestBody/content/application~1json/example"},"paths/ServiceCategoryEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"service_category","resource_id":301,"status":"create","data":{"id":301,"title":"Hair Services","weight":1,"staff":[101,102,103]}},"id":"paths/ServiceCategoryEvent/post/requestBody/content/application~1json/example"},"paths/ClientEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"client","resource_id":401,"status":"create","data":{"id":401,"name":"Jane","surname":"Doe","display_name":"Jane Doe","phone":"+1234567890","email":"jane@example.com","discount":10,"visits":5,"sex_id":2,"importance_id":0,"national_id":"950315300129"}},"id":"paths/ClientEvent/post/requestBody/content/application~1json/example"},"paths/RecordEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"record","resource_id":501,"status":"create","data":{"id":501,"company_id":123456,"staff_id":101,"datetime":"2026-03-20T14:00:00+0300","create_date":"2026-03-19T10:30:00+0300","attendance":0,"confirmed":1,"online":true,"services":[{"id":201,"title":"Haircut","cost":50}],"client":{"id":401,"name":"Jane","surname":"Doe","phone":"+1234567890","national_id":"950315300129"}}},"id":"paths/RecordEvent/post/requestBody/content/application~1json/example"},"paths/LoyaltyCardEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"loyalty_card","resource_id":601,"status":"update","data":{"id":601,"balance":150,"number":"LC-00601","phone":"+1234567890"}},"id":"paths/LoyaltyCardEvent/post/requestBody/content/application~1json/example"},"paths/ScheduleEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"schedule","resource_id":101,"status":"update","data":[]},"id":"paths/ScheduleEvent/post/requestBody/content/application~1json/example"},"paths/GoodEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"good","resource_id":701,"status":"create","data":{"good_id":701,"title":"Shampoo Professional","cost":25,"article":"SH-001","barcode":"4607001234567","actual_cost":25,"category":"Hair Care"}},"id":"paths/GoodEvent/post/requestBody/content/application~1json/example"},"paths/GoodsOperationEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"goods_operations_sale","resource_id":801,"status":"create","data":{"id":801,"type_id":1,"type":"sale","amount":2,"cost_per_unit":25,"cost":50,"good":{"id":701,"title":"Shampoo Professional"}}},"id":"paths/GoodsOperationEvent/post/requestBody/content/application~1json/example"},"paths/FinancesOperationEvent/post/requestBody/content/application~1json/example":{"value":{"company_id":123456,"resource":"finances_operation","resource_id":901,"status":"create","data":{"id":901,"amount":50,"date":"2026-03-20T14:30:00+0300","comment":"Haircut payment","record_id":501,"expense":{"id":1,"title":"Services"}}},"id":"paths/FinancesOperationEvent/post/requestBody/content/application~1json/example"},"paths/~1voip~1integration/post/responses/202/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1voip~1integration/post/responses/202/content/application~1json/example"},"paths/~1countries/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":7,"title":"USA","full_title":"United States","iso_code":"US","phone_code":"1","phone_template":"+1 xxx-xxx-xxxx","phone_example":"+1 201-123-4567","currency":"$","exchange":32.99,"lang_id":2,"group_type":1},{"id":56,"title":"France","full_title":"France","iso_code":"FR","phone_code":"33","phone_template":"+33 x xx xx xx xx","phone_example":"+33 1 23 45 67 89","currency":"€","exchange":11.18,"lang_id":8,"group_type":1}],"meta":[]},"id":"paths/~1countries/get/responses/200/content/application~1json/example"},"paths/~1cities/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":2,"country_id":7,"title":"New York"},{"id":1040,"country_id":30,"title":"Belfast"},{"id":1201,"country_id":38,"title":"București"},{"id":1334,"country_id":31,"title":"Budapest"}],"meta":[]},"id":"paths/~1cities/get/responses/200/content/application~1json/example"},"paths/~1references~1business_groups_with_types/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":10,"title":"Domestic services","image":"https://app.alteg.io/images/business-groups/services.png","types":[{"id":31,"title":"Studio","business_group_id":10}]},{"id":1,"title":"beauty","image":"https://app.alteg.io/images/business-groups/beauty.png","types":[{"id":1,"title":"Beauty Salons","business_group_id":1},{"id":25,"title":"Spa","business_group_id":1}]}],"meta":{"count":10}},"id":"paths/~1references~1business_groups_with_types/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"BearerPartner":{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}","description":"Partner API token for accessing developer endpoints"},"BearerPartnerUser":{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}","description":"Combined partner and user tokens for authenticated user operations"}},"servers":[{"url":"/_mock/en/developers/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.alteg.io/api/v1","description":"Production"}]},"options":{"sortRequiredPropsFirst":true,"hideSidebar":true,"mockServer":{"url":"/_mock/en/developers/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/en/developers/openapi.json?download"},{"url":"/_bundle/en/developers/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Developer Tools","description":"APIs for partners building integrations with the Altegio platform.\n**Base URL:** `https://api.alteg.io/api`\n## Start here\nBuilding your first marketplace app? Follow [Install & test your app before moderation](marketplace-quickstart.md). It explains which IDs and tokens you need, how the two-step installation works, and how to verify your first authenticated call.\n## Available Methods\n**Marketplace** — Manage your marketplace applications: list connected locations, configure tariffs, handle billing, process installation/uninstallation callbacks.\n**Webhooks** — Configure event notifications for your integrations. Receive real-time updates when appointments, clients, or other entities change.\n**VoIP Integration** — Connect telephony systems to match incoming calls with client records and log call history.\n**Dictionaries** — Reference data for building forms and validations: countries, cities, business types."}},"baseSlug":"/en/developers/openapi","routesMapping":{}}