{"items":[{"type":"link","fsPath":"en/developers/marketplace-quickstart.md","metadata":{"type":"markdown"},"label":"Start Here — Install & Test Your App","link":"/en/developers/marketplace-quickstart","routeSlug":"/en/developers/marketplace-quickstart"},{"type":"link","label":"Developer Tools","link":"/en/developers/openapi","routeSlug":"/en/developers/openapi"},{"type":"link","label":"Start here","link":"/en/developers/openapi/section/start-here","routeSlug":"/en/developers/openapi/section/start-here"},{"type":"link","label":"Available Methods","link":"/en/developers/openapi/section/available-methods","routeSlug":"/en/developers/openapi/section/available-methods"},{"type":"separator","label":"Developers"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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"}},"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."}},"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."}},"httpPath":"/marketplace_webhook"}]},{"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"}},"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"}},"httpPath":"/hooks_settings/{location_id}"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"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."}},"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}."}},"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}."}},"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."}},"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."}},"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}."}},"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."}},"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."}},"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}."}},"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."}},"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."}},"httpPath":"FinancesOperationEvent"}]},{"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"}},"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"}},"httpPath":"/voip/integration/calls"}]},{"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"}},"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"}},"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"}},"httpPath":"/references/business_groups_with_types"}]}]}