{"items":[{"type":"link","label":"Business Management","link":"/en/b2b-v1/openapi","routeSlug":"/en/b2b-v1/openapi","content":{"contentType":"overview","meta":{"name":"Business Management"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/en/b2b-v1/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/en/b2b-v1/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/b2b-v1/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":"Business Management (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/en/b2b-v1/openapi"}],"sectionId":"/en/b2b-v1/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/start-here:-get-your-credentials"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start here: get your credentials"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business Management requests use a "},"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":" and, when business data"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is involved, a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://app.alteg.io/appstore/developers/1"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Altegio Marketplace"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developer account"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Complete the developer registration. Your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner Token then appears automatically under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account settings → Account"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Choose how you will obtain the User Token:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application system user:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" create an application in Developer Account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Under "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", enter the system user's "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", save it, copy the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"generated "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User Token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and configure the application's credentials,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access rights, and connection settings. Then "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/developers/marketplace-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"install and activate the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application on a test Location"},"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":"The token can access that Location only after the installation is active."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own Business User:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" call the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Authentication-B2B/operation/auth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user authorization"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with your Altegio login and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.user_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the response. No application installation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is needed, but that Business User must already have access to the Location."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send both values in the same header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <partner_token>, User <user_token>"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An application's system user and your own Business User can have different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations and permissions. A request that works with one token may therefore"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the other. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/get-api-key"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to Get API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete beginner walkthrough."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full-featured B2B API for business operations."},"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":"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/b2b-v1/openapi/section/start-here:-get-your-credentials"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/version-status"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ Version Status"},"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":"V1 will be gradually deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" We recommend using "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/en/b2b-v2/openapi"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"V2 API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only."},"children":[]}]}]}]}],"sectionId":"/en/b2b-v1/openapi/section/version-status"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/v1-and-v2-parameter-aliases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"V1 and V2 parameter aliases"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"V1 accepts the canonical V2 terminology for query-string and request-body parameters while continuing to support legacy V1 names. This makes it possible to share request-building code between API versions. Common alias families include:"},"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":"code","inline":true,"attributes":{"content":"location_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"salon_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_group_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"salon_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team_member_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"master_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good_id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Singular, plural, and camelCase variants are supported where applicable. Send only one name from each alias family. If multiple aliases are supplied, explicitly supplied values are preserved and are not overwritten."},"children":[]}]}]}]}],"sectionId":"/en/b2b-v1/openapi/section/v1-and-v2-parameter-aliases"}]}]}},{"type":"link","label":"Start here: get your credentials","link":"/en/b2b-v1/openapi/section/start-here:-get-your-credentials","routeSlug":"/en/b2b-v1/openapi/section/start-here:-get-your-credentials","content":null},{"type":"link","label":"⚠️ Version Status","link":"/en/b2b-v1/openapi/section/version-status","routeSlug":"/en/b2b-v1/openapi/section/version-status","content":null},{"type":"link","label":"V1 and V2 parameter aliases","link":"/en/b2b-v1/openapi/section/v1-and-v2-parameter-aliases","routeSlug":"/en/b2b-v1/openapi/section/v1-and-v2-parameter-aliases","content":null},{"type":"separator","label":"POS & Scheduling","content":null},{"type":"group","label":"Authentication B2B","link":"/en/b2b-v1/openapi/authentication-b2b","routeSlug":"/en/b2b-v1/openapi/authentication-b2b","items":[{"label":"Authorize User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/authentication-b2b/authorize_user","routeSlug":"/en/b2b-v1/openapi/authentication-b2b/authorize_user","metadata":{"seo":{"title":"Authorize User","description":"When a user changes their password, their API key is regenerated. As a result, reauthorization is required using the new API key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"authorize_user","name":"Authorize User","isWebhook":false,"pointer":"/paths/~1auth/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorize User","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":"When a user changes their password, their API key is regenerated. As a result, reauthorization is required using the new API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"login"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user's phone number in the format +13155550175, or their email address."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User password"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1auth/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/auth_request"}},"schemaId":"components/schemas/auth_request","pointer":"/paths/~1auth/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/auth","servers":[{"url":"/_mock/en/b2b-v1/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_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/auth_request"}},"responseCodes":["201","401","403","404"],"pointer":"/auth","href":"authentication-b2b/authorize_user","openApiOperationId":"authorize_user","summary":"Authorize User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/auth_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/auth_request"}},"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/auth_response","exampleIds":["paths/~1auth/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/auth_response","exampleIds":["paths/~1auth/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/~1auth/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/auth_response","exampleIds":["paths/~1auth/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/auth_response","exampleIds":["paths/~1auth/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":"/authentication-b2b/authorize_user"}],"panels":[]}]},"httpPath":"/auth"}],"content":{"contentType":"group","meta":{"name":"Authentication B2B"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication B2B","showPageActions":true},{"nodeType":"markdoc","content":"User authentication and session management for B2B integrations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/auth","summary":"Authorize User","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication-b2b/authorize_user","deprecated":false}]}]}]}]}},{"type":"group","label":"Locations","link":"/en/b2b-v1/openapi/locations","routeSlug":"/en/b2b-v1/openapi/locations","items":[{"label":"Get a list of locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/locations/get_location_list","routeSlug":"/en/b2b-v1/openapi/locations/get_location_list","metadata":{"seo":{"title":"Get a list of locations","description":"Get a list of locations with data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_list","name":"Get a list of locations","isWebhook":false,"pointer":"/paths/~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of locations with data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_280","description":"Filter by location ID","example":4564},{"name":"group_id","in":"query","schemaId":"schema_280","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by location chain ID "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default: 83"},"children":[]}]}]}]}],"example":83},{"name":"my","in":"query","schemaId":"schema_280","description":"For authorized user only. If you need locations that the user has rights to manage","example":1},{"name":"active","in":"query","schemaId":"schema_280","description":"If you need to get only locations with an active license and an available appointment","example":1},{"name":"forBooking","in":"query","schemaId":"schema_280","description":"Include date and time of the next free session in the location (ISO8601)","example":1},{"name":"show_groups","in":"query","schemaId":"schema_280","description":"Include in the location object a list of chains that this location belongs to","example":1},{"name":"city_id","in":"query","schemaId":"schema_280","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by city ID ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#cities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cities getting method"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":2},{"name":"showBookforms","in":"query","schemaId":"schema_280","description":"Include in the location object a list of location online booking forms","example":1},{"name":"min_id","in":"query","schemaId":"schema_280","description":"Filter by minimum location ID","example":1000},{"name":"show_deleted","in":"query","schemaId":"schema_280","description":"Include deleted locations","example":1},{"name":"hide_record_type_single","in":"query","schemaId":"schema_280","description":"Hide locations with individual appointment","example":1},{"name":"hide_record_type_activity","in":"query","schemaId":"schema_280","description":"Hide locations with group appointment","example":1},{"name":"hide_record_type_mixed","in":"query","schemaId":"schema_280","description":"Hide locations with mixed appointment","example":1},{"name":"business_group_id","in":"query","schemaId":"schema_280","description":"Filter by business group ID","example":1},{"name":"business_type_id","in":"query","schemaId":"schema_280","description":"Filter by business type ID","example":1},{"name":"include","in":"query","schemaId":"schema_281","description":"Include additional data in the location object","example":["staff","positions"]},{"name":"count","in":"query","schemaId":"schema_280","description":"Number of locations per page"},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number"}],"pointer":"/paths/~1companies/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/companies","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"id","in":"query","example":4564,"schemaId":"schema_280"},{"name":"group_id","in":"query","example":83,"schemaId":"schema_280"},{"name":"my","in":"query","example":1,"schemaId":"schema_280"},{"name":"active","in":"query","example":1,"schemaId":"schema_280"},{"name":"forBooking","in":"query","example":1,"schemaId":"schema_280"},{"name":"show_groups","in":"query","example":1,"schemaId":"schema_280"},{"name":"city_id","in":"query","example":2,"schemaId":"schema_280"},{"name":"showBookforms","in":"query","example":1,"schemaId":"schema_280"},{"name":"min_id","in":"query","example":1000,"schemaId":"schema_280"},{"name":"show_deleted","in":"query","example":1,"schemaId":"schema_280"},{"name":"hide_record_type_single","in":"query","example":1,"schemaId":"schema_280"},{"name":"hide_record_type_activity","in":"query","example":1,"schemaId":"schema_280"},{"name":"hide_record_type_mixed","in":"query","example":1,"schemaId":"schema_280"},{"name":"business_group_id","in":"query","example":1,"schemaId":"schema_280"},{"name":"business_type_id","in":"query","example":1,"schemaId":"schema_280"},{"name":"include","in":"query","example":["staff","positions"],"schemaId":"schema_281"},{"name":"count","in":"query","schemaId":"schema_280"},{"name":"page","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/companies","href":"locations/get_location_list","openApiOperationId":"get_location_list","summary":"Get a list of locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/companies_data_types"}},"schemaId":"components/schemas/companies_data_types"},{"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"}],"pointer":"/paths/~1companies/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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/get_location_list"}],"panels":[]}]},"httpPath":"/companies"},{"label":"Create a location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/locations/create_location","routeSlug":"/en/b2b-v1/openapi/locations/create_location","metadata":{"seo":{"title":"Create a location","description":"Create new location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_location","name":"Create a location","isWebhook":false,"pointer":"/paths/~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create new location"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_create_request_data_types"}},"schemaId":"components/schemas/company_create_request_data_types","pointer":"/paths/~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/companies","servers":[{"url":"/_mock/en/b2b-v1/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_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/company_create_request_data_types"}},"responseCodes":["201","401","404"],"pointer":"/companies","href":"locations/create_location","openApiOperationId":"create_location","summary":"Create a location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/company_create_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_create_request_data_types"}},"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/company_create_response_data_types"}},"schemaId":"components/schemas/company_create_response_data_types"},{"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":"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/~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/company_create_response_data_types","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_create_response_data_types"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_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":"/locations/create_location"}],"panels":[]}]},"httpPath":"/companies"},{"label":"Get location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/locations/get_location","routeSlug":"/en/b2b-v1/openapi/locations/get_location","metadata":{"seo":{"title":"Get location","description":"Getting information about the location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location","name":"Get location","isWebhook":false,"pointer":"/paths/~1company~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Getting information about the location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"The ID of the location to get information about.","required":true,"example":37532}],"pointer":"/paths/~1company~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"my","in":"query","schemaId":"schema_280","description":"For authorized user only. If you need additional data for the location that the user has rights to manage","example":1},{"name":"forBooking","in":"query","schemaId":"schema_280","description":"Date and time of the next free session in the location (ISO8601).","example":1},{"name":"show_groups","in":"query","schemaId":"schema_280","description":"Include in the location object a list of chains that this location belongs to","example":1},{"name":"showBookforms","in":"query","schemaId":"schema_280","description":"Show location online booking forms (widgets)","example":1},{"name":"bookform_id","in":"query","schemaId":"schema_280","description":"Show url of online booking form with specified ID","example":19203}],"pointer":"/paths/~1company~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":37532,"schemaId":"schema_280"}],"query":[{"name":"my","in":"query","example":1,"schemaId":"schema_280"},{"name":"forBooking","in":"query","example":1,"schemaId":"schema_280"},{"name":"show_groups","in":"query","example":1,"schemaId":"schema_280"},{"name":"showBookforms","in":"query","example":1,"schemaId":"schema_280"},{"name":"bookform_id","in":"query","example":19203,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/company/{location_id}","href":"locations/get_location","openApiOperationId":"get_location","summary":"Get location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_get_response_data_types"}},"schemaId":"components/schemas/company_get_response_data_types"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response_legacy"}},"schemaId":"components/schemas/401_unauthorized_response_legacy"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response_legacy"}},"schemaId":"components/schemas/404_not_found_response_legacy"}],"pointer":"/paths/~1company~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_get_response_data_types","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_response_data_types"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response_legacy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response_legacy"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response_legacy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response_legacy"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/get_location"}],"panels":[]}]},"httpPath":"/company/{location_id}"},{"label":"Change location","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/locations/update_location","routeSlug":"/en/b2b-v1/openapi/locations/update_location","metadata":{"seo":{"title":"Change location","description":"Change location data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_location","name":"Change location","isWebhook":false,"pointer":"/paths/~1company~1{location_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change location data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":37532}],"pointer":"/paths/~1company~1{location_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_put_request_data_types"}},"schemaId":"components/schemas/company_put_request_data_types","pointer":"/paths/~1company~1{location_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/company/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":37532,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/company_put_request_data_types"}},"responseCodes":["200","401","404"],"pointer":"/company/{location_id}","href":"locations/update_location","openApiOperationId":"update_location","summary":"Change location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/company_put_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_put_request_data_types"}},"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/company_put_response_data_types"}},"schemaId":"components/schemas/company_put_response_data_types"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response_legacy"}},"schemaId":"components/schemas/401_unauthorized_response_legacy"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response_legacy"}},"schemaId":"components/schemas/404_not_found_response_legacy"}],"pointer":"/paths/~1company~1{location_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_put_response_data_types","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_put_response_data_types"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response_legacy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response_legacy"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response_legacy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response_legacy"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/update_location"}],"panels":[]}]},"httpPath":"/company/{location_id}"},{"label":"Delete location","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/locations/delete_location","routeSlug":"/en/b2b-v1/openapi/locations/delete_location","metadata":{"seo":{"title":"Delete location","description":"Delete a location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_location","name":"Delete location","isWebhook":false,"pointer":"/paths/~1company~1{location_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":37532}],"pointer":"/paths/~1company~1{location_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":37532,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["202","401","404"],"pointer":"/company/{location_id}","href":"locations/delete_location","openApiOperationId":"delete_location","summary":"Delete location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"202","description":"Accepted"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response_legacy"}},"schemaId":"components/schemas/401_unauthorized_response_legacy"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response_legacy"}},"schemaId":"components/schemas/404_not_found_response_legacy"}],"pointer":"/paths/~1company~1{location_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/401_unauthorized_response_legacy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response_legacy"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response_legacy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_response_legacy"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/locations/delete_location"}],"panels":[]}]},"httpPath":"/company/{location_id}"}],"content":{"contentType":"group","meta":{"name":"Locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Locations","showPageActions":true},{"nodeType":"markdoc","content":"Manage business locations (salons, clinics, etc.)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/companies","summary":"Get a list of locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/get_location_list","deprecated":false},{"title":"/companies","summary":"Create a location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/locations/create_location","deprecated":false},{"title":"/company/{location_id}","summary":"Get location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/locations/get_location","deprecated":false},{"title":"/company/{location_id}","summary":"Change location","prefix":{"name":"put","color":"put"},"badges":[],"link":"/locations/update_location","deprecated":false},{"title":"/company/{location_id}","summary":"Delete location","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/locations/delete_location","deprecated":false}]}]}]}]}},{"type":"group","label":"Services","link":"/en/b2b-v1/openapi/services","routeSlug":"/en/b2b-v1/openapi/services","items":[{"label":"Create a service category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/create_service_category","routeSlug":"/en/b2b-v1/openapi/services/create_service_category","metadata":{"seo":{"title":"Create a service category","description":"Create a service category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_service_category","name":"Create a service category","isWebhook":false,"pointer":"/paths/~1service_categories~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a service category","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1service_categories~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1service_categories~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/service_categories_companyid_request_data_types"}},"schemaId":"components/schemas/service_categories_companyid_request_data_types","pointer":"/paths/~1service_categories~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/service_categories/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/service_categories_companyid_request_data_types"}},"responseCodes":["201","401","403","404"],"pointer":"/service_categories/{location_id}","href":"services/create_service_category","openApiOperationId":"create_service_category","summary":"Create a service category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/service_categories_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/service_categories_companyid_request_data_types"}},"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/service_categories_companyid_response_data_types","exampleIds":["paths/~1service_categories~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/service_categories_companyid_response_data_types","exampleIds":["paths/~1service_categories~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/~1service_categories~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/service_categories_companyid_response_data_types","exampleIds":["paths/~1service_categories~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/service_categories_companyid_response_data_types","exampleIds":["paths/~1service_categories~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":"/services/create_service_category"}],"panels":[]}]},"httpPath":"/service_categories/{location_id}"},{"label":"Get a list of services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/get_service_list","routeSlug":"/en/b2b-v1/openapi/services/get_service_list","metadata":{"seo":{"title":"Get a list of services","description":"Returns a list of all services for the specified location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_service_list","name":"Get a list of services","isWebhook":false,"pointer":"/paths/~1services~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all services for the specified location"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1services~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"staff_id","in":"query","schemaId":"schema_280","description":"Team member ID, if you want to filter by team member"},{"name":"category_id","in":"query","schemaId":"schema_280","description":"Category ID, if you want to filter by category"}],"pointer":"/paths/~1services~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":"Authorization","in":"header","schemaId":"schema_279","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/~1services~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"staff_id","in":"query","schemaId":"schema_280"},{"name":"category_id","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/services/{location_id}","href":"services/get_service_list","openApiOperationId":"get_service_list","summary":"Get a list of services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/services_list_response","exampleIds":["paths/~1services~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/services_list_response","exampleIds":["paths/~1services~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"}],"pointer":"/paths/~1services~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/services_list_response","exampleIds":["paths/~1services~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services_list_response","exampleIds":["paths/~1services~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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/get_service_list"}],"panels":[]}]},"httpPath":"/services/{location_id}"},{"label":"Create a service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/create_service","routeSlug":"/en/b2b-v1/openapi/services/create_service","metadata":{"seo":{"title":"Create a service","description":"Method to create a service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_service","name":"Create a service","isWebhook":false,"pointer":"/paths/~1services~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Method to create a service"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1services~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorizarion","in":"header","schemaId":"schema_279","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/~1services~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_companyid_request_data_types"}},"schemaId":"components/schemas/services_companyid_request_data_types","pointer":"/paths/~1services~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/services/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorizarion","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/services_companyid_request_data_types"}},"responseCodes":["201","401","403","404"],"pointer":"/services/{location_id}","href":"services/create_service","openApiOperationId":"create_service","summary":"Create a service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/services_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_companyid_request_data_types"}},"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/services_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/services_companyid_response_data_types","exampleIds":["paths/~1services~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/~1services~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/services_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services_companyid_response_data_types","exampleIds":["paths/~1services~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":"/services/create_service"}],"panels":[]}]},"httpPath":"/services/{location_id}"},{"label":"Update a service","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/deprecated_update_service_by_id","routeSlug":"/en/b2b-v1/openapi/services/deprecated_update_service_by_id","metadata":{"seo":{"title":"Update a service","description":"Method to update a service by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deprecated_update_service_by_id","name":"Update a service","isWebhook":false,"pointer":"/paths/~1services~1{location_id}~1{service_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Method to update a service by ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID","required":true}],"pointer":"/paths/~1services~1{location_id}~1{service_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1services~1{location_id}~1{service_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_companyid_request_data_types"}},"schemaId":"components/schemas/services_companyid_request_data_types","pointer":"/paths/~1services~1{location_id}~1{service_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/services/{location_id}/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/services_companyid_request_data_types"}},"responseCodes":["200","201","401","403","404"],"pointer":"/services/{location_id}/{service_id}","href":"services/deprecated_update_service_by_id","openApiOperationId":"deprecated_update_service_by_id","summary":"Update a service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/services_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_companyid_request_data_types"}},"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/services_companyid_response_data_types"}},"schemaId":"components/schemas/services_companyid_response_data_types"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/put/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/services_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/put/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/~1services~1{location_id}~1{service_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/services_companyid_response_data_types","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services_companyid_response_data_types"}}},{"code":"201","schemaId":"components/schemas/services_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/put/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/put/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":"/services/deprecated_update_service_by_id"}],"panels":[]}]},"httpPath":"/services/{location_id}/{service_id}"},{"label":"Update a service (partial)","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/patch_service","routeSlug":"/en/b2b-v1/openapi/services/patch_service","metadata":{"seo":{"title":"Update a service (partial)","description":"Method to partially update a service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch_service","name":"Update a service (partial)","isWebhook":false,"pointer":"/paths/~1services~1{location_id}~1{service_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a service (partial)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Method to partially update a service"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID","required":true}],"pointer":"/paths/~1services~1{location_id}~1{service_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1services~1{location_id}~1{service_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_change_companyid_request_data_types"}},"schemaId":"components/schemas/services_change_companyid_request_data_types","pointer":"/paths/~1services~1{location_id}~1{service_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/services/{location_id}/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/services_change_companyid_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/services/{location_id}/{service_id}","href":"services/patch_service","openApiOperationId":"patch_service","summary":"Update a service (partial)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/services_change_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/services_change_companyid_request_data_types"}},"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/services_change_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/services_change_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/patch/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/~1services~1{location_id}~1{service_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/services_change_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/services_change_companyid_response_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/patch/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":"/services/patch_service"}],"panels":[]}]},"httpPath":"/services/{location_id}/{service_id}"},{"label":"Delete a service","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/delete_service","routeSlug":"/en/b2b-v1/openapi/services/delete_service","metadata":{"seo":{"title":"Delete a service","description":"Method to remove a service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_service","name":"Delete a service","isWebhook":false,"pointer":"/paths/~1services~1{location_id}~1{service_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Method to remove a service"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID","required":true}],"pointer":"/paths/~1services~1{location_id}~1{service_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1services~1{location_id}~1{service_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/services/{location_id}/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/services/{location_id}/{service_id}","href":"services/delete_service","openApiOperationId":"delete_service","summary":"Delete a service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1services~1{location_id}~1{service_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/services/delete_service"}],"panels":[]}]},"httpPath":"/services/{location_id}/{service_id}"},{"label":"Get service category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/get_service_category","routeSlug":"/en/b2b-v1/openapi/services/get_service_category","metadata":{"seo":{"title":"Get service category","description":"Get service category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_service_category","name":"Get service category","isWebhook":false,"pointer":"/paths/~1service_category~1{location_id}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get service category","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Service Category ID","required":true}],"pointer":"/paths/~1service_category~1{location_id}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1service_category~1{location_id}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/service_category/{location_id}/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/service_category/{location_id}/{id}","href":"services/get_service_category","openApiOperationId":"get_service_category","summary":"Get service category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{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/~1service_category~1{location_id}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{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":"/services/get_service_category"}],"panels":[]}]},"httpPath":"/service_category/{location_id}/{id}"},{"label":"Change service category","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/update_service_category","routeSlug":"/en/b2b-v1/openapi/services/update_service_category","metadata":{"seo":{"title":"Change service category","description":"Change service category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_service_category","name":"Change service category","isWebhook":false,"pointer":"/paths/~1service_category~1{location_id}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change service category","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Service Category ID","required":true}],"pointer":"/paths/~1service_category~1{location_id}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1service_category~1{location_id}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/service_categories_companyid_request_data_types"}},"schemaId":"components/schemas/service_categories_companyid_request_data_types","pointer":"/paths/~1service_category~1{location_id}~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/service_category/{location_id}/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/service_categories_companyid_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/service_category/{location_id}/{id}","href":"services/update_service_category","openApiOperationId":"update_service_category","summary":"Change service category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/service_categories_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/service_categories_companyid_request_data_types"}},"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/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{id}/put/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/~1service_category~1{location_id}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_category~1{location_id}~1{id}/put/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":"/services/update_service_category"}],"panels":[]}]},"httpPath":"/service_category/{location_id}/{id}"},{"label":"Delete service category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/delete_service_category","routeSlug":"/en/b2b-v1/openapi/services/delete_service_category","metadata":{"seo":{"title":"Delete service category","description":"Delete service category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_service_category","name":"Delete service category","isWebhook":false,"pointer":"/paths/~1service_category~1{location_id}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete service category","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Service Category ID","required":true}],"pointer":"/paths/~1service_category~1{location_id}~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":"Conetnt-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1service_category~1{location_id}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/service_category/{location_id}/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Conetnt-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/service_category/{location_id}/{id}","href":"services/delete_service_category","openApiOperationId":"delete_service_category","summary":"Delete service category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1service_category~1{location_id}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/services/delete_service_category"}],"panels":[]}]},"httpPath":"/service_category/{location_id}/{id}"},{"label":"Get a list of service categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/get_service_category_list","routeSlug":"/en/b2b-v1/openapi/services/get_service_category_list","metadata":{"seo":{"title":"Get a list of service categories","description":"Optionscompany_id (required, number) - location IDid (optional, number) - service category ID (to work with a specific category)staff_id (optional, number) - team member ID (to get categories associated with a team member)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_service_category_list","name":"Get a list of service categories","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1service_categories~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of service categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$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":"Options"},"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":"company_id (required, number) - location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id (optional, number) - service category ID (to work with a specific category)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"staff_id (optional, number) - team member ID (to get categories associated with a team member)"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Service Category ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1service_categories~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"staff_id","in":"query","schemaId":"schema_280","description":"team member ID (to get categories associated with a team member)"}],"pointer":"/paths/~1company~1{location_id}~1service_categories~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1service_categories~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/service_categories/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"staff_id","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/company/{location_id}/service_categories/{id}","href":"services/get_service_category_list","openApiOperationId":"get_service_category_list","summary":"Get a list of service categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1company~1{location_id}~1service_categories~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/get_service_category_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/service_categories/{id}"},{"label":"Get a list of services / specific service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/get_service","routeSlug":"/en/b2b-v1/openapi/services/get_service","metadata":{"seo":{"title":"Get a list of services / specific service","description":"Parametercompany_id (required, number, 1) - location IDservice_id (optional, number, 1) - service ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_service","name":"Get a list of services / specific service","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of services / specific service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$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":"Parameter"},"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":"company_id (required, number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"service_id (optional, number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - service ID"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID, if you need to work with a specific service.","required":true}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"staff_id","in":"query","schemaId":"schema_280","description":"team member ID, if you want to filter by team member"},{"name":"category_id","in":"query","schemaId":"schema_280","description":"Category ID, if you want to filter by category"}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1services~1{service_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/services/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"staff_id","in":"query","schemaId":"schema_280"},{"name":"category_id","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/company/{location_id}/services/{service_id}","href":"services/get_service","openApiOperationId":"get_service","summary":"Get a list of services / specific service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1services~1{service_id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/get_service"}],"panels":[]}]},"httpPath":"/company/{location_id}/services/{service_id}"},{"label":"Linking a Team Member to a Provided Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/assign_service_to_team_member","routeSlug":"/en/b2b-v1/openapi/services/assign_service_to_team_member","metadata":{"seo":{"title":"Linking a Team Member to a Provided Service","description":"Creates a team member service link with provided duration and bill of materials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assign_service_to_team_member","name":"Linking a Team Member to a Provided Service","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Linking a Team Member to a Provided Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a team member service link with provided duration and bill of materials.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"service_id","in":"path","schemaId":"schema_280","description":"ID of service.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"schemaId":"schema_283","pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/services/{service_id}/staff","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"service_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_283"}},"responseCodes":["201","401","403","404","422"],"pointer":"/company/{location_id}/services/{service_id}/staff","href":"services/assign_service_to_team_member","openApiOperationId":"assign_service_to_team_member","summary":"Linking a Team Member to a Provided Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_283","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"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":"schema_284"}},"schemaId":"schema_284"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1services~1{service_id}~1staff/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_284","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}}},{"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"}}},{"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":"/services/assign_service_to_team_member"}],"panels":[]}]},"httpPath":"/company/{location_id}/services/{service_id}/staff"},{"label":"Updating Team Member Service Link Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/update_service_team_member_assignment","routeSlug":"/en/b2b-v1/openapi/services/update_service_team_member_assignment","metadata":{"seo":{"title":"Updating Team Member Service Link Settings","description":"Updates a team member service link with provided duration and bill of materials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_service_team_member_assignment","name":"Updating Team Member Service Link Settings","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating Team Member Service Link Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a team member service link with provided duration and bill of materials.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"service_id","in":"path","schemaId":"schema_280","description":"ID of service.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"ID of team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"schemaId":"schema_285","pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/company/{location_id}/services/{service_id}/staff/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"service_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_285"}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/services/{service_id}/staff/{team_member_id}","href":"services/update_service_team_member_assignment","openApiOperationId":"update_service_team_member_assignment","summary":"Updating Team Member Service Link Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_285","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"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":"schema_284"}},"schemaId":"schema_284"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}}},{"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"}}},{"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":"/services/update_service_team_member_assignment"}],"panels":[]}]},"httpPath":"/company/{location_id}/services/{service_id}/staff/{team_member_id}"},{"label":"Deleting a Team Member Service Link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/remove_service_from_team_member","routeSlug":"/en/b2b-v1/openapi/services/remove_service_from_team_member","metadata":{"seo":{"title":"Deleting a Team Member Service Link","description":"Deletes a team member service link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove_service_from_team_member","name":"Deleting a Team Member Service Link","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting a Team Member Service Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a team member service link.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"service_id","in":"path","schemaId":"schema_280","description":"ID of service.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"ID of team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/services/{service_id}/staff/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"service_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/company/{location_id}/services/{service_id}/staff/{team_member_id}","href":"services/remove_service_from_team_member","openApiOperationId":"remove_service_from_team_member","summary":"Deleting a Team Member Service Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"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/~1company~1{location_id}~1services~1{service_id}~1staff~1{team_member_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","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":"/services/remove_service_from_team_member"}],"panels":[]}]},"httpPath":"/company/{location_id}/services/{service_id}/staff/{team_member_id}"},{"label":"Update service links","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/update_service_links","routeSlug":"/en/b2b-v1/openapi/services/update_service_links","metadata":{"seo":{"title":"Update service links","description":"Updates service configuration including:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_service_links","name":"Update service links","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1services~1links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update service links","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 service configuration including:"},"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":"Team member assignments with custom duration and pricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tech cards (technological cards) for each team member"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required resources for the service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service name translations for different languages"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows bulk updating of service-team member relationships"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without affecting other service properties."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true,"example":720441}],"pointer":"/paths/~1company~1{location_id}~1services~1links/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1services~1links/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_288","exampleIds":["paths/~1company~1{location_id}~1services~1links/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_288","exampleIds":["paths/~1company~1{location_id}~1services~1links/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1company~1{location_id}~1services~1links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/services/links","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":720441,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_288","exampleIds":["paths/~1company~1{location_id}~1services~1links/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/company/{location_id}/services/links","href":"services/update_service_links","openApiOperationId":"update_service_links","summary":"Update service links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_288","exampleIds":["paths/~1company~1{location_id}~1services~1links/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_288","exampleIds":["paths/~1company~1{location_id}~1services~1links/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":"Service links updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289"}},"schemaId":"schema_289"},{"code":"400","description":"Bad request - invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Service or location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291"}],"pointer":"/paths/~1company~1{location_id}~1services~1links/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_289","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_289"}}},{"code":"400","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/update_service_links"}],"panels":[]}]},"httpPath":"/company/{location_id}/services/links"},{"label":"Get a list of chain service categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/get_chain_service_category_list","routeSlug":"/en/b2b-v1/openapi/services/get_chain_service_category_list","metadata":{"seo":{"title":"Get a list of chain service categories","description":"Get a list of chain service categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_service_category_list","name":"Get a list of chain service categories","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1service_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of chain service categories","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1service_categories/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_292","description":"Include additional resources in response"}],"pointer":"/paths/~1chain~1{chain_id}~1service_categories/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1service_categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/service_categories","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[{"name":"include","in":"query","schemaId":"schema_292"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/chain/{chain_id}/service_categories","href":"services/get_chain_service_category_list","openApiOperationId":"get_chain_service_category_list","summary":"Get a list of chain service categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_293"}},"schemaId":"schema_293"},{"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/~1chain~1{chain_id}~1service_categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_293","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_293"}}},{"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":"/services/get_chain_service_category_list"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/service_categories"},{"label":"Deprecated. Get a list of service categories","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/deprecated_get_service_category_list","routeSlug":"/en/b2b-v1/openapi/services/deprecated_get_service_category_list","metadata":{"seo":{"title":"Deprecated. Get a list of service categories","description":"Get a list of service categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deprecated_get_service_category_list","name":"Deprecated. Get a list of service categories","deprecated":true,"isWebhook":false,"pointer":"/paths/~1service_categories~1{location_id}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Get a list of service categories","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of service categories"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Service category identifier","required":true}],"pointer":"/paths/~1service_categories~1{location_id}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1service_categories~1{location_id}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/service_categories/{location_id}/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/service_categories/{location_id}/{id}","href":"services/deprecated_get_service_category_list","openApiOperationId":"deprecated_get_service_category_list","summary":"Deprecated. Get a list of service categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_categories~1{location_id}~1{id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_categories~1{location_id}~1{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/~1service_categories~1{location_id}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_categories~1{location_id}~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_service_categories_response200_data_types","exampleIds":["paths/~1service_categories~1{location_id}~1{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":"/services/deprecated_get_service_category_list"}],"panels":[]}]},"httpPath":"/service_categories/{location_id}/{id}"},{"label":"Deprecated. Get a list of services / specific service","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/services/deprecated_get_service_list_by_id","routeSlug":"/en/b2b-v1/openapi/services/deprecated_get_service_list_by_id","metadata":{"seo":{"title":"Deprecated. Get a list of services / specific service","description":"Deprecated. Get a list of services / specific service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deprecated_get_service_list_by_id","name":"Deprecated. Get a list of services / specific service","deprecated":true,"isWebhook":false,"pointer":"/paths/~1services~1{location_id}~1{service_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Get a list of services / specific service","isWebhook":false,"deprecated":true,"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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID, if you need to work with a specific service.","required":true}],"pointer":"/paths/~1services~1{location_id}~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"staff_id","in":"query","schemaId":"schema_280","description":"team member ID, if you want to filter by team member"},{"name":"category_id","in":"query","schemaId":"schema_280","description":"Category ID, if you want to filter by category"}],"pointer":"/paths/~1services~1{location_id}~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1services~1{location_id}~1{service_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/services/{location_id}/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"staff_id","in":"query","schemaId":"schema_280"},{"name":"category_id","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/services/{location_id}/{service_id}","href":"services/deprecated_get_service_list_by_id","openApiOperationId":"deprecated_get_service_list_by_id","summary":"Deprecated. Get a list of services / specific service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_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/~1services~1{location_id}~1{service_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_services_serviceid_response200_data_types","exampleIds":["paths/~1services~1{location_id}~1{service_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":"/services/deprecated_get_service_list_by_id"}],"panels":[]}]},"httpPath":"/services/{location_id}/{service_id}"}],"content":{"contentType":"group","meta":{"name":"Services"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Services","showPageActions":true},{"nodeType":"markdoc","content":"Service catalog management including categories and team member assignments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/service_categories/{location_id}","summary":"Create a service category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/services/create_service_category","deprecated":false},{"title":"/services/{location_id}","summary":"Get a list of services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/get_service_list","deprecated":false},{"title":"/services/{location_id}","summary":"Create a service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/services/create_service","deprecated":false},{"title":"/services/{location_id}/{service_id}","summary":"Update a service","prefix":{"name":"put","color":"put"},"badges":[],"link":"/services/deprecated_update_service_by_id","deprecated":false},{"title":"/services/{location_id}/{service_id}","summary":"Update a service (partial)","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/services/patch_service","deprecated":false},{"title":"/services/{location_id}/{service_id}","summary":"Delete a service","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/services/delete_service","deprecated":false},{"title":"/service_category/{location_id}/{id}","summary":"Get service category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/get_service_category","deprecated":false},{"title":"/service_category/{location_id}/{id}","summary":"Change service category","prefix":{"name":"put","color":"put"},"badges":[],"link":"/services/update_service_category","deprecated":false},{"title":"/service_category/{location_id}/{id}","summary":"Delete service category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/services/delete_service_category","deprecated":false},{"title":"/company/{location_id}/service_categories/{id}","summary":"Get a list of service categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/get_service_category_list","deprecated":false},{"title":"/company/{location_id}/services/{service_id}","summary":"Get a list of services / specific service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/get_service","deprecated":false},{"title":"/company/{location_id}/services/{service_id}/staff","summary":"Linking a Team Member to a Provided Service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/services/assign_service_to_team_member","deprecated":false},{"title":"/company/{location_id}/services/{service_id}/staff/{team_member_id}","summary":"Updating Team Member Service Link Settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/services/update_service_team_member_assignment","deprecated":false},{"title":"/company/{location_id}/services/{service_id}/staff/{team_member_id}","summary":"Deleting a Team Member Service Link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/services/remove_service_from_team_member","deprecated":false},{"title":"/company/{location_id}/services/links","summary":"Update service links","prefix":{"name":"post","color":"post"},"badges":[],"link":"/services/update_service_links","deprecated":false},{"title":"/chain/{chain_id}/service_categories","summary":"Get a list of chain service categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/get_chain_service_category_list","deprecated":false},{"title":"/service_categories/{location_id}/{id}","summary":"Deprecated. Get a list of service categories","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/services/deprecated_get_service_category_list","deprecated":true},{"title":"/services/{location_id}/{service_id}","summary":"Deprecated. Get a list of services / specific service","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/services/deprecated_get_service_list_by_id","deprecated":true}]}]}]}]}},{"type":"group","label":"Team Members","link":"/en/b2b-v1/openapi/team-members","routeSlug":"/en/b2b-v1/openapi/team-members","items":[{"label":"Get list of team members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/get_team_member_list","routeSlug":"/en/b2b-v1/openapi/team-members/get_team_member_list","metadata":{"seo":{"title":"Get list of team members","description":"Returns all team members for the specified location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_list","name":"Get list of team members","isWebhook":false,"pointer":"/paths/~1staff~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of team members","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 all team members for the specified location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each team member includes:"},"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":"Basic info (name, specialization, avatar)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rating and reviews data"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schedule availability"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position and status"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true}],"pointer":"/paths/~1staff~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":"API version header","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1staff~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/staff/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/staff/{location_id}","href":"team-members/get_team_member_list","openApiOperationId":"get_team_member_list","summary":"Get list of team members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/staff_list_response"}},"schemaId":"components/schemas/staff_list_response"},{"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"}],"pointer":"/paths/~1staff~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/staff_list_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/staff_list_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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/get_team_member_list"}],"panels":[]}]},"httpPath":"/staff/{location_id}"},{"label":"Add new team member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/deprecated_create_team_member","routeSlug":"/en/b2b-v1/openapi/team-members/deprecated_create_team_member","metadata":{"seo":{"title":"Add new team member","description":"Add new team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deprecated_create_team_member","name":"Add new team member","isWebhook":false,"pointer":"/paths/~1staff~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add new team member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1staff~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1staff~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/staff_companyid_request_data_types"}},"schemaId":"components/schemas/staff_companyid_request_data_types","pointer":"/paths/~1staff~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/staff/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/staff_companyid_request_data_types"}},"responseCodes":["201","401","403","404"],"pointer":"/staff/{location_id}","href":"team-members/deprecated_create_team_member","openApiOperationId":"deprecated_create_team_member","summary":"Add new team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/staff_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/staff_companyid_request_data_types"}},"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/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~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/~1staff~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~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":"/team-members/deprecated_create_team_member"}],"panels":[]}]},"httpPath":"/staff/{location_id}"},{"label":"Get a specific team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/get_team_member_by_id","routeSlug":"/en/b2b-v1/openapi/team-members/get_team_member_by_id","metadata":{"seo":{"title":"Get a specific team member","description":"Get a specific team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_by_id","name":"Get a specific team member","isWebhook":false,"pointer":"/paths/~1staff~1{location_id}~1{team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific team member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID, if you need to work with a specific team member.","required":true}],"pointer":"/paths/~1staff~1{location_id}~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1staff~1{location_id}~1{team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/staff/{location_id}/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/staff/{location_id}/{team_member_id}","href":"team-members/get_team_member_by_id","openApiOperationId":"get_team_member_by_id","summary":"Get a specific team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_companyid_staff_staffid_response_data_types_deprecated","exampleIds":["paths/~1staff~1{location_id}~1{team_member_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types_deprecated","exampleIds":["paths/~1staff~1{location_id}~1{team_member_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/~1staff~1{location_id}~1{team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types_deprecated","exampleIds":["paths/~1staff~1{location_id}~1{team_member_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types_deprecated","exampleIds":["paths/~1staff~1{location_id}~1{team_member_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":"/team-members/get_team_member_by_id"}],"panels":[]}]},"httpPath":"/staff/{location_id}/{team_member_id}"},{"label":"Edit Team Member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/update_team_member","routeSlug":"/en/b2b-v1/openapi/team-members/update_team_member","metadata":{"seo":{"title":"Edit Team Member","description":"Edit Team Member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_team_member","name":"Edit Team Member","isWebhook":false,"pointer":"/paths/~1staff~1{location_id}~1{team_member_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Team Member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID","required":true}],"pointer":"/paths/~1staff~1{location_id}~1{team_member_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1staff~1{location_id}~1{team_member_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/staff_companyid_request_data_types"}},"schemaId":"components/schemas/staff_companyid_request_data_types","pointer":"/paths/~1staff~1{location_id}~1{team_member_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/staff/{location_id}/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/staff_companyid_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/staff/{location_id}/{team_member_id}","href":"team-members/update_team_member","openApiOperationId":"update_team_member","summary":"Edit Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/staff_companyid_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/staff_companyid_request_data_types"}},"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/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~1{location_id}~1{team_member_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~1{location_id}~1{team_member_id}/put/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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden. Returned when the user lacks permission for the requested change, for example when modifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_included_in_payment_policy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_policy_update_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"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":"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/~1staff~1{location_id}~1{team_member_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~1{location_id}~1{team_member_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1staff~1{location_id}~1{team_member_id}/put/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":"/team-members/update_team_member"}],"panels":[]}]},"httpPath":"/staff/{location_id}/{team_member_id}"},{"label":"Delete team member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/delete_team_member","routeSlug":"/en/b2b-v1/openapi/team-members/delete_team_member","metadata":{"seo":{"title":"Delete team member","description":"Delete team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_team_member","name":"Delete team member","isWebhook":false,"pointer":"/paths/~1staff~1{location_id}~1{team_member_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete team member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID","required":true}],"pointer":"/paths/~1staff~1{location_id}~1{team_member_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1staff~1{location_id}~1{team_member_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/staff/{location_id}/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/staff/{location_id}/{team_member_id}","href":"team-members/delete_team_member","openApiOperationId":"delete_team_member","summary":"Delete team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1staff~1{location_id}~1{team_member_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/team-members/delete_team_member"}],"panels":[]}]},"httpPath":"/staff/{location_id}/{team_member_id}"},{"label":"Quick create a team member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/create_team_member_quick","routeSlug":"/en/b2b-v1/openapi/team-members/create_team_member_quick","metadata":{"seo":{"title":"Quick create a team member","description":"Creates a new team member with a minimal set of parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_team_member_quick","name":"Quick create a team member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1staff~1quick/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Quick create a team member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new team member with a minimal set of parameters.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1staff~1quick/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1staff~1quick/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_294"}},"schemaId":"schema_294","pointer":"/paths/~1company~1{location_id}~1staff~1quick/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/staff/quick","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_294"}},"responseCodes":["201","401","403","404","422"],"pointer":"/company/{location_id}/staff/quick","href":"team-members/create_team_member_quick","openApiOperationId":"create_team_member_quick","summary":"Quick create a team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_294","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_294"}},"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":"schema_295"}},"schemaId":"schema_295"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1staff~1quick/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_295","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_295"}}},{"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"}}},{"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":"/team-members/create_team_member_quick"}],"panels":[]}]},"httpPath":"/company/{location_id}/staff/quick"},{"label":"Get Team Members / Specific Team Member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/get_team_member","routeSlug":"/en/b2b-v1/openapi/team-members/get_team_member","metadata":{"seo":{"title":"Get Team Members / Specific Team Member","description":"Get Team Members / Specific Team Member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member","name":"Get Team Members / Specific Team Member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1staff~1{team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Team Members / Specific Team Member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID, if you need to work with a specific team member.","required":true}],"pointer":"/paths/~1company~1{location_id}~1staff~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1staff~1{team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/staff/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/company/{location_id}/staff/{team_member_id}","href":"team-members/get_team_member","openApiOperationId":"get_team_member","summary":"Get Team Members / Specific Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_staff_staffid_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_staff_staffid_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/company_companyid_staff_staffid_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response403_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/company_companyid_staff_staffid_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_staff_staffid_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/get_team_member"}],"panels":[]}]},"httpPath":"/company/{location_id}/staff/{team_member_id}"},{"label":"Deprecated. Get a list of location positions","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/get_position_list","routeSlug":"/en/b2b-v1/openapi/team-members/get_position_list","metadata":{"seo":{"title":"Deprecated. Get a list of location positions","description":"This endpoint is deprecated. Use GET /v2/companies/{company_id}/positions instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_position_list","name":"Deprecated. Get a list of location positions","deprecated":true,"isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1staff~1positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Get a list of location positions","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/companies/{company_id}/positions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method allows you to get a list of current positions in the location."},"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":"Migration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The V2 Positions API provides enhanced functionality with full CRUD operations, pagination, and JSON:API format responses. See operation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_positions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1staff~1positions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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{location_id}~1staff~1positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/staff/positions","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/staff/positions","href":"team-members/get_position_list","openApiOperationId":"get_position_list","summary":"Deprecated. Get a list of location positions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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 location positions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_staff_position_list_data_type"}},"schemaId":"components/schemas/company_staff_position_list_data_type"},{"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/~1company~1{location_id}~1staff~1positions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_staff_position_list_data_type","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_staff_position_list_data_type"}}},{"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":"/team-members/get_position_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/staff/positions"},{"label":"Deprecated. Quick create a position","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/team-members/create_position_quick","routeSlug":"/en/b2b-v1/openapi/team-members/create_position_quick","metadata":{"seo":{"title":"Deprecated. Quick create a position","description":"This endpoint is deprecated. Use POST /v2/companies/{company_id}/positions instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_position_quick","name":"Deprecated. Quick create a position","deprecated":true,"isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1positions~1quick/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Quick create a position","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/companies/{company_id}/positions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new position in a location; position is created as a chain entity and at the same time linked to a location initiated its creation."},"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":"Migration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The V2 Positions API provides full CRUD operations with enhanced validation and JSON:API format responses. See operation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create_position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1positions~1quick/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1positions~1quick/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296"}},"schemaId":"schema_296","pointer":"/paths/~1company~1{location_id}~1positions~1quick/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/positions/quick","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_296"}},"responseCodes":["201","401","403","404","422"],"pointer":"/company/{location_id}/positions/quick","href":"team-members/create_position_quick","openApiOperationId":"create_position_quick","summary":"Deprecated. Quick create a position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_296","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296"}},"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":"schema_297"}},"schemaId":"schema_297"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1positions~1quick/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_297","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_297"}}},{"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"}}},{"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":"/team-members/create_position_quick"}],"panels":[]}]},"httpPath":"/company/{location_id}/positions/quick"}],"content":{"contentType":"group","meta":{"name":"Team Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Members","showPageActions":true},{"nodeType":"markdoc","content":"Staff management including positions and scheduling"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/staff/{location_id}","summary":"Get list of team members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-members/get_team_member_list","deprecated":false},{"title":"/staff/{location_id}","summary":"Add new team member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/team-members/deprecated_create_team_member","deprecated":false},{"title":"/staff/{location_id}/{team_member_id}","summary":"Get a specific team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-members/get_team_member_by_id","deprecated":false},{"title":"/staff/{location_id}/{team_member_id}","summary":"Edit Team Member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/team-members/update_team_member","deprecated":false},{"title":"/staff/{location_id}/{team_member_id}","summary":"Delete team member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/team-members/delete_team_member","deprecated":false},{"title":"/company/{location_id}/staff/quick","summary":"Quick create a team member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/team-members/create_team_member_quick","deprecated":false},{"title":"/company/{location_id}/staff/{team_member_id}","summary":"Get Team Members / Specific Team Member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-members/get_team_member","deprecated":false},{"title":"/company/{location_id}/staff/positions","summary":"Deprecated. Get a list of location positions","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/team-members/get_position_list","deprecated":true},{"title":"/company/{location_id}/positions/quick","summary":"Deprecated. Quick create a position","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/team-members/create_position_quick","deprecated":true}]}]}]}]}},{"type":"group","label":"Clients","link":"/en/b2b-v1/openapi/clients","routeSlug":"/en/b2b-v1/openapi/clients","items":[{"label":"Adding a Client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/create_client","routeSlug":"/en/b2b-v1/openapi/clients/create_client","metadata":{"seo":{"title":"Adding a Client","description":"Adding a Client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_client","name":"Adding a Client","isWebhook":false,"pointer":"/paths/~1clients~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adding a Client","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1clients~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1clients~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_298"}},"schemaId":"schema_298","pointer":"/paths/~1clients~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/clients/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_298"}},"responseCodes":["201","401","403","404"],"pointer":"/clients/{location_id}","href":"clients/create_client","openApiOperationId":"create_client","summary":"Adding a Client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_298","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_298"}},"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":{"exampleIds":["paths/~1clients~1{location_id}/post/responses/201/content/application~1json/example"]}},"exampleIds":["paths/~1clients~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/~1clients~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","exampleIds":["paths/~1clients~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1clients~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":"/clients/create_client"}],"panels":[]}]},"httpPath":"/clients/{location_id}"},{"label":"Get a list of clients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/get_client_list","routeSlug":"/en/b2b-v1/openapi/clients/get_client_list","metadata":{"seo":{"title":"Get a list of clients","description":"Get a list of clients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client_list","name":"Get a list of clients","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1clients~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of clients","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1clients~1search/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1clients~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_request_data_types"}},"schemaId":"components/schemas/company_companyid_clients_search_request_data_types","pointer":"/paths/~1company~1{location_id}~1clients~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/clients/search","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_request_data_types"}},"responseCodes":["200","400","402","404"],"pointer":"/company/{location_id}/clients/search","href":"clients/get_client_list","openApiOperationId":"get_client_list","summary":"Get a list of clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/company_companyid_clients_search_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_request_data_types"}},"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/company_companyid_clients_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_clients_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_response400_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_clients_search_response400_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/400/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_response402_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_clients_search_response402_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/402/content/application~1json/example"]},{"code":"404","description":"When a location is specified not as an integer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/company_companyid_clients_search_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1company~1{location_id}~1clients~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_companyid_clients_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/company_companyid_clients_search_response400_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_response400_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/400/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/company_companyid_clients_search_response402_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_response402_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/402/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/company_companyid_clients_search_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_companyid_clients_search_response404_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1search/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clients/get_client_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/clients/search"},{"label":"Get a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/get_client","routeSlug":"/en/b2b-v1/openapi/clients/get_client","metadata":{"seo":{"title":"Get a client","description":"Get a client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client","name":"Get a client","isWebhook":false,"pointer":"/paths/~1client~1{location_id}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a client","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Client ID","required":true}],"pointer":"/paths/~1client~1{location_id}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1client~1{location_id}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/client/{location_id}/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/client/{location_id}/{id}","href":"clients/get_client","openApiOperationId":"get_client","summary":"Get a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1client~1{location_id}~1{id}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1client~1{location_id}~1{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/~1client~1{location_id}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1client~1{location_id}~1{id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1client~1{location_id}~1{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":"/clients/get_client"}],"panels":[]}]},"httpPath":"/client/{location_id}/{id}"},{"label":"Edit client","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/update_client","routeSlug":"/en/b2b-v1/openapi/clients/update_client","metadata":{"seo":{"title":"Edit client","description":"Edit client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_client","name":"Edit client","isWebhook":false,"pointer":"/paths/~1client~1{location_id}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit client","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Client ID","required":true}],"pointer":"/paths/~1client~1{location_id}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1client~1{location_id}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_299"}},"schemaId":"schema_299","pointer":"/paths/~1client~1{location_id}~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/client/{location_id}/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_299"}},"responseCodes":["200","401","403","404"],"pointer":"/client/{location_id}/{id}","href":"clients/update_client","openApiOperationId":"update_client","summary":"Edit client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_299","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_299"}},"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":{"exampleIds":["paths/~1client~1{location_id}~1{id}/put/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1client~1{location_id}~1{id}/put/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/~1client~1{location_id}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1client~1{location_id}~1{id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1client~1{location_id}~1{id}/put/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":"/clients/update_client"}],"panels":[]}]},"httpPath":"/client/{location_id}/{id}"},{"label":"Delete client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/delete_client","routeSlug":"/en/b2b-v1/openapi/clients/delete_client","metadata":{"seo":{"title":"Delete client","description":"Delete client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_client","name":"Delete client","isWebhook":false,"pointer":"/paths/~1client~1{location_id}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete client","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"id","in":"path","schemaId":"schema_280","description":"Client ID","required":true}],"pointer":"/paths/~1client~1{location_id}~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1client~1{location_id}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/client/{location_id}/{id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/client/{location_id}/{id}","href":"clients/delete_client","openApiOperationId":"delete_client","summary":"Delete client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1client~1{location_id}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/clients/delete_client"}],"panels":[]}]},"httpPath":"/client/{location_id}/{id}"},{"label":"Bulk adding clients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/bulk_create_clients","routeSlug":"/en/b2b-v1/openapi/clients/bulk_create_clients","metadata":{"seo":{"title":"Bulk adding clients","description":"Bulk adding clients"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulk_create_clients","name":"Bulk adding clients","isWebhook":false,"pointer":"/paths/~1clients~1{location_id}~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk adding clients","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1clients~1{location_id}~1bulk/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1clients~1{location_id}~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_300"}},"schemaId":"schema_300","pointer":"/paths/~1clients~1{location_id}~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/clients/{location_id}/bulk","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_300"}},"responseCodes":["200","401","403","404"],"pointer":"/clients/{location_id}/bulk","href":"clients/bulk_create_clients","openApiOperationId":"bulk_create_clients","summary":"Bulk adding clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_300","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_300"}},"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":{"exampleIds":["paths/~1clients~1{location_id}~1bulk/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1clients~1{location_id}~1bulk/post/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/~1clients~1{location_id}~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1clients~1{location_id}~1bulk/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1clients~1{location_id}~1bulk/post/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":"/clients/bulk_create_clients"}],"panels":[]}]},"httpPath":"/clients/{location_id}/bulk"},{"label":"List of a comments for a client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/list_client_comments","routeSlug":"/en/b2b-v1/openapi/clients/list_client_comments","metadata":{"seo":{"title":"List of a comments for a client","description":"Returns a list of a comments for a client and a files in a client details uploads history."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_client_comments","name":"List of a comments for a client","isWebhook":false,"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List of a comments for a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of a comments for a client and a files in a client details uploads history.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"client_id","in":"path","schemaId":"schema_280","description":"ID of a location client.","required":true,"example":123}],"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/clients/{location_id}/clients/{client_id}/comments","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/clients/{location_id}/clients/{client_id}/comments","href":"clients/list_client_comments","openApiOperationId":"list_client_comments","summary":"List of a comments for a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_301"}},"schemaId":"schema_301"},{"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/~1clients~1{location_id}~1clients~1{client_id}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_301","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_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":"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":"/clients/list_client_comments"}],"panels":[]}]},"httpPath":"/clients/{location_id}/clients/{client_id}/comments"},{"label":"Add a comment for a client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/create_client_comment","routeSlug":"/en/b2b-v1/openapi/clients/create_client_comment","metadata":{"seo":{"title":"Add a comment for a client","description":"Creates a new text comment for a client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_client_comment","name":"Add a comment for a client","isWebhook":false,"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a comment for a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new text comment for a client.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"client_id","in":"path","schemaId":"schema_280","description":"ID of a location client.","required":true,"example":123}],"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302"}},"schemaId":"schema_302","pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/clients/{location_id}/clients/{client_id}/comments","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_302"}},"responseCodes":["201","401","403","404","422"],"pointer":"/clients/{location_id}/clients/{client_id}/comments","href":"clients/create_client_comment","openApiOperationId":"create_client_comment","summary":"Add a comment for a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_302","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302"}},"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":"schema_303"}},"schemaId":"schema_303"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1clients~1{location_id}~1clients~1{client_id}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_303","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_303"}}},{"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"}}},{"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":"/clients/create_client_comment"}],"panels":[]}]},"httpPath":"/clients/{location_id}/clients/{client_id}/comments"},{"label":"Delete a comment for a client","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/delete_client_comment","routeSlug":"/en/b2b-v1/openapi/clients/delete_client_comment","metadata":{"seo":{"title":"Delete a comment for a client","description":"Deletes a comment for a client; does not delete files uploaded that triggered creation of a comment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_client_comment","name":"Delete a comment for a client","isWebhook":false,"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments~1{comment_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a comment for a client","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a comment for a client; does not delete files uploaded that triggered creation of a comment.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"client_id","in":"path","schemaId":"schema_280","description":"ID of a location client.","required":true,"example":123},{"name":"comment_id","in":"path","schemaId":"schema_280","description":"ID of a comment for client.","required":true,"example":123}],"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments~1{comment_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1clients~1{location_id}~1clients~1{client_id}~1comments~1{comment_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/clients/{location_id}/clients/{client_id}/comments/{comment_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"comment_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/clients/{location_id}/clients/{client_id}/comments/{comment_id}","href":"clients/delete_client_comment","openApiOperationId":"delete_client_comment","summary":"Delete a comment for a client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"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/~1clients~1{location_id}~1clients~1{client_id}~1comments~1{comment_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","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":"/clients/delete_client_comment"}],"panels":[]}]},"httpPath":"/clients/{location_id}/clients/{client_id}/comments/{comment_id}"},{"label":"Sample Request to Get a List of Client Files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/get_client_file_list","routeSlug":"/en/b2b-v1/openapi/clients/get_client_file_list","metadata":{"seo":{"title":"Sample Request to Get a List of Client Files","description":"A list of uploaded client files can be retrieved by providing both the location ID and the client ID in the request.The client ID can be obtained from the client collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client_file_list","name":"Sample Request to Get a List of Client Files","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1clients~1files~1{client_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sample Request to Get a List of Client Files","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 list of uploaded client files can be retrieved by providing both the location ID and the client ID in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client ID can be obtained from the client collection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response returns an array of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#client-file"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client files"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"client-file"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each client file has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Field | Type | Description |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":"| id | number | File ID |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| client_id | number | Client ID |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| name | string | Filename with extension |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| description | string | File description |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| extension | string | File name extension |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| mime | string | MIME file type |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| link | string | File download link |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| date_create | string | File upload date in ISO8601 format |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| size | string | Formatted file size string |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| username | string | The name of the user who uploaded the file |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| user_avatar | string | Avatar of the user who uploaded the file |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| can_edit | boolean | Is there a right to change and delete the file? true - there is a right, false - there is no right |"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"client_id","in":"path","schemaId":"schema_280","description":"Client ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1clients~1files~1{client_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1clients~1files~1{client_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/clients/files/{client_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"client_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/clients/files/{client_id}","href":"clients/get_client_file_list","openApiOperationId":"get_client_file_list","summary":"Sample Request to Get a List of Client Files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/clients_files_clientid_reaponse_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/clients_files_clientid_reaponse_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_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/~1company~1{location_id}~1clients~1files~1{client_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clients_files_clientid_reaponse_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clients_files_clientid_reaponse_data_types","exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_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":"/clients/get_client_file_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/clients/files/{client_id}"},{"label":"Delete request example","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/delete_client_file","routeSlug":"/en/b2b-v1/openapi/clients/delete_client_file","metadata":{"seo":{"title":"Delete request example","description":"Delete request example"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_client_file","name":"Delete request example","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete request example","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"client_id","in":"path","schemaId":"schema_280","description":"Client ID","required":true},{"name":"file_id","in":"path","schemaId":"schema_280","description":"File ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":[]}]}]}],"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/clients/files/{client_id}/{file_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"client_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"file_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["202","401","403","404"],"pointer":"/company/{location_id}/clients/files/{client_id}/{file_id}","href":"clients/delete_client_file","openApiOperationId":"delete_client_file","summary":"Delete request example"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/responses/202/content/application~1json/example"]}},"exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/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/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/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":"/clients/delete_client_file"}],"panels":[]}]},"httpPath":"/company/{location_id}/clients/files/{client_id}/{file_id}"},{"label":"Search by customer history","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/search_client_visits","routeSlug":"/en/b2b-v1/openapi/clients/search_client_visits","metadata":{"seo":{"title":"Search by customer history","description":"Displays the client’s visit history.This method returns the client’s appointment and product purchase history, grouped by visit. Data is filtered based on visit status and paid status.The client is identified using either the client_id or client_phone parameter. All other parameters are optional.Results are sorted by visit date and paginated in batches of 25 items. If multiple visits share the same date as the last item on the page, they will be included on the current page to ensure complete grouping.To retrieve the next page, use the from and to values provided in the meta field of the current response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_client_visits","name":"Search by customer history","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1clients~1visits~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search by customer history","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":"Displays the client’s visit history.This method returns the client’s appointment and product purchase history, grouped by visit. Data is filtered based on visit status and paid status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client is identified using either the client_id or client_phone parameter. All other parameters are optional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are sorted by visit date and paginated in batches of 25 items. If multiple visits share the same date as the last item on the page, they will be included on the current page to ensure complete grouping."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the next page, use the from and to values provided in the meta field of the current response."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1clients~1visits~1search/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1clients~1visits~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304","pointer":"/paths/~1company~1{location_id}~1clients~1visits~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/clients/visits/search","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_304"}},"responseCodes":["200","401","404","422"],"pointer":"/company/{location_id}/clients/visits/search","href":"clients/search_client_visits","openApiOperationId":"search_client_visits","summary":"Search by customer history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"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":"schema_305"}},"schemaId":"schema_305"},{"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":"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1clients~1visits~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_305","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_305"}}},{"code":"401","schemaId":"components/schemas/401_unauthorized_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/401_unauthorized_response"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_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":"/clients/search_client_visits"}],"panels":[]}]},"httpPath":"/company/{location_id}/clients/visits/search"},{"label":"Deprecated. Get a list of clients","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/clients/deprecated_get_client_list","routeSlug":"/en/b2b-v1/openapi/clients/deprecated_get_client_list","metadata":{"seo":{"title":"Deprecated. Get a list of clients","description":"Parametercompany_id (required, number, 1) - location IDpage (number, 1) - Page numbercount (number, 20) - Number of clients per page"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deprecated_get_client_list","name":"Deprecated. Get a list of clients","deprecated":true,"isWebhook":false,"pointer":"/paths/~1clients~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Get a list of clients","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$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":"Parameter"},"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":"company_id (required, number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"page (number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - Page number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"count (number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - Number of clients per page"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"clients/deprecated_get_client_list/request/client-filtering","deepLinkHash":"/clients/deprecated_get_client_list#clients/deprecated_get_client_list/request/client-filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client filtering"},"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":"fullname:Joh (optional, string) - Name (part of name) to filter clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone:1315 (optional, string) - Phone (part of the number) for filtering clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email:test@ (optional, string) - Email (part) for client filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card:5663rt (optional, string) - Card (part) for filtering customers by loyalty card number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid_min:100 (optional, number) - Minimum amount paid, to filter customers by the amount of payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid_max:0 (optional, number) - Maximum amount paid, to filter customers by the amount of payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid_max:0 (optional, number) - Maximum amount paid, to filter customers by the amount of payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id:66 (optional, number) - ID of one client for filtering clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id[]: 66 (optional, array) - IDs of multiple clients to filter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changed_after: '2000-01-01T00:00:00' (optional, string) - Filtering clients changed/created since a specific date and time"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changed_before: '2020-12-31T23:59:59' (optional, string) - Filtering clients changed/created before a specific date and time"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1clients~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fullname","in":"query","schemaId":"schema_279","description":"Name (part of the name) for client filtering","example":"Joh"},{"name":"phone","in":"query","schemaId":"schema_279","description":"Phone (part of the number) for customer filtering","example":"1315"},{"name":"email","in":"query","schemaId":"schema_279","description":"Email (part) for customer filtering","example":"test@"},{"name":"paid_min","in":"query","schemaId":"schema_280","description":"Minimum amount paid, to filter customers by the amount of payments","example":1},{"name":"paid_max","in":"query","schemaId":"schema_280","description":"Maximum amount paid, to filter customers by the amount of payments","example":1},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"Number of customers per page","example":20},{"name":"location_id","in":"query","schemaId":"schema_280","description":"ID of one or more clients to filter clients","example":66}],"pointer":"/paths/~1clients~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1clients~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/clients/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"fullname","in":"query","example":"Joh","schemaId":"schema_279"},{"name":"phone","in":"query","example":"1315","schemaId":"schema_279"},{"name":"email","in":"query","example":"test@","schemaId":"schema_279"},{"name":"paid_min","in":"query","example":1,"schemaId":"schema_280"},{"name":"paid_max","in":"query","example":1,"schemaId":"schema_280"},{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":20,"schemaId":"schema_280"},{"name":"location_id","in":"query","example":66,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/clients/{location_id}","href":"clients/deprecated_get_client_list","openApiOperationId":"deprecated_get_client_list","summary":"Deprecated. Get a list of clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/clients_companyid_response_deprecated_data_types","exampleIds":["paths/~1clients~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/clients_companyid_response_deprecated_data_types","exampleIds":["paths/~1clients~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/~1clients~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/clients_companyid_response_deprecated_data_types","exampleIds":["paths/~1clients~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/clients_companyid_response_deprecated_data_types","exampleIds":["paths/~1clients~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":"/clients/deprecated_get_client_list"}],"panels":[]}]},"httpPath":"/clients/{location_id}"}],"content":{"contentType":"group","meta":{"name":"Clients"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clients","showPageActions":true},{"nodeType":"markdoc","content":"Client database management with comments, files, and visit history"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/clients/{location_id}","summary":"Adding a Client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/create_client","deprecated":false},{"title":"/company/{location_id}/clients/search","summary":"Get a list of clients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/get_client_list","deprecated":false},{"title":"/client/{location_id}/{id}","summary":"Get a client","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/get_client","deprecated":false},{"title":"/client/{location_id}/{id}","summary":"Edit client","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clients/update_client","deprecated":false},{"title":"/client/{location_id}/{id}","summary":"Delete client","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clients/delete_client","deprecated":false},{"title":"/clients/{location_id}/bulk","summary":"Bulk adding clients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/bulk_create_clients","deprecated":false},{"title":"/clients/{location_id}/clients/{client_id}/comments","summary":"List of a comments for a client","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/list_client_comments","deprecated":false},{"title":"/clients/{location_id}/clients/{client_id}/comments","summary":"Add a comment for a client","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/create_client_comment","deprecated":false},{"title":"/clients/{location_id}/clients/{client_id}/comments/{comment_id}","summary":"Delete a comment for a client","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clients/delete_client_comment","deprecated":false},{"title":"/company/{location_id}/clients/files/{client_id}","summary":"Sample Request to Get a List of Client Files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clients/get_client_file_list","deprecated":false},{"title":"/company/{location_id}/clients/files/{client_id}/{file_id}","summary":"Delete request example","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/clients/delete_client_file","deprecated":false},{"title":"/company/{location_id}/clients/visits/search","summary":"Search by customer history","prefix":{"name":"post","color":"post"},"badges":[],"link":"/clients/search_client_visits","deprecated":false},{"title":"/clients/{location_id}","summary":"Deprecated. Get a list of clients","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/clients/deprecated_get_client_list","deprecated":true}]}]}]}]}},{"type":"group","label":"Users & Permissions","link":"/en/b2b-v1/openapi/users-and-permissions","routeSlug":"/en/b2b-v1/openapi/users-and-permissions","items":[{"label":"Get location users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/get_location_users","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/get_location_users","metadata":{"seo":{"title":"Get location users","description":"The method allows you to get users of the location.location User object:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_users","name":"Get location users","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location users","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":"The method allows you to get users of the location."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location User object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User phone"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User email"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User information"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user accepted the invitation to manage the location"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_non_deletable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user is non-deletable"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1users/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[is_approved]","in":"query","schemaId":"schema_280","description":"Whether the user accepted the invitation to manage the location. 1 - accepted, 0 - not accepted","example":1}],"pointer":"/paths/~1company~1{location_id}~1users/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/users","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"filter[is_approved]","in":"query","required":false,"example":1,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/users","href":"users-and-permissions/get_location_users","openApiOperationId":"get_location_users","summary":"Get location users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_company_id_users_response_data_types","exampleIds":["paths/~1company~1{location_id}~1users/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_company_id_users_response_data_types","exampleIds":["paths/~1company~1{location_id}~1users/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/~1company~1{location_id}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_company_id_users_response_data_types","exampleIds":["paths/~1company~1{location_id}~1users/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_company_id_users_response_data_types","exampleIds":["paths/~1company~1{location_id}~1users/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":"/users-and-permissions/get_location_users"}],"panels":[]}]},"httpPath":"/company/{location_id}/users"},{"label":"Remove the user from the location","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/remove_user_from_location","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/remove_user_from_location","metadata":{"seo":{"title":"Remove the user from the location","description":"Remove the user from the location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove_user_from_location","name":"Remove the user from the location","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove the user from the location","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"user_id","in":"path","schemaId":"schema_280","description":"User ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/users/{user_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/company/{location_id}/users/{user_id}","href":"users-and-permissions/remove_user_from_location","openApiOperationId":"remove_user_from_location","summary":"Remove the user from the location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1company~1{location_id}~1users~1{user_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/users-and-permissions/remove_user_from_location"}],"panels":[]}]},"httpPath":"/company/{location_id}/users/{user_id}"},{"label":"Get a list of rights","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/get_permission_list","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/get_permission_list","metadata":{"seo":{"title":"Get a list of rights","description":"Parametercompany_id (required, number, 1) - location ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_permission_list","name":"Get a list of rights","isWebhook":false,"pointer":"/paths/~1user~1permissions~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of rights","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$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":"Parameter"},"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":"company_id (required, number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - location ID"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1user~1permissions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1user~1permissions~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/permissions/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/user/permissions/{location_id}","href":"users-and-permissions/get_permission_list","openApiOperationId":"get_permission_list","summary":"Get a list of rights"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/user_permissions_response_data_types","exampleIds":["paths/~1user~1permissions~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/user_permissions_response_data_types","exampleIds":["paths/~1user~1permissions~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/~1user~1permissions~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/user_permissions_response_data_types","exampleIds":["paths/~1user~1permissions~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user_permissions_response_data_types","exampleIds":["paths/~1user~1permissions~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":"/users-and-permissions/get_permission_list"}],"panels":[]}]},"httpPath":"/user/permissions/{location_id}"},{"label":"Getting a list of user roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/list_roles","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/list_roles","metadata":{"seo":{"title":"Getting a list of user roles","description":"Returns a list of user roles along with permissions for each role."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_roles","name":"Getting a list of user roles","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting a list of user roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of user roles along with permissions for each role.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1users~1roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_306","description":"Requested set of an included models."}],"pointer":"/paths/~1company~1{location_id}~1users~1roles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1users~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/users/roles","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"include","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/users/roles","href":"users-and-permissions/list_roles","openApiOperationId":"list_roles","summary":"Getting a list of user roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_307"}},"schemaId":"schema_307"},{"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/~1company~1{location_id}~1users~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307"}}},{"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":"/users-and-permissions/list_roles"}],"panels":[]}]},"httpPath":"/company/{location_id}/users/roles"},{"label":"Getting a list of user roles in the context of a location user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/get_user_roles","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/get_user_roles","metadata":{"seo":{"title":"Getting a list of user roles in the context of a location user","description":"Returns a list of user roles along with permissions for each role. Allows to get the editable status for each permission of a location user (is_editable field). This status depends on the current user's permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_user_roles","name":"Getting a list of user roles in the context of a location user","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting a list of user roles in the context of a location user","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 a list of user roles along with permissions for each role. Allows to get the editable status for each permission of a location user ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_editable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field). This status depends on the current user's permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"user_id","in":"path","schemaId":"schema_280","description":"ID of a user.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_306","description":"Requested set of an included models."}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1roles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/users/{user_id}/roles","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"user_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"include","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/users/{user_id}/roles","href":"users-and-permissions/get_user_roles","openApiOperationId":"get_user_roles","summary":"Getting a list of user roles in the context of a location user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_307"}},"schemaId":"schema_307"},{"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/~1company~1{location_id}~1users~1{user_id}~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307"}}},{"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":"/users-and-permissions/get_user_roles"}],"panels":[]}]},"httpPath":"/company/{location_id}/users/{user_id}/roles"},{"label":"Getting permission values and user role","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/get_user_permissions","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/get_user_permissions","metadata":{"seo":{"title":"Getting permission values and user role","description":"Return user role and list of permissions values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_user_permissions","name":"Getting permission values and user role","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1permissions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting permission values and user role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return user role and list of permissions values.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"user_id","in":"path","schemaId":"schema_280","description":"ID of a user.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1permissions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1permissions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/users/{user_id}/permissions","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"user_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/users/{user_id}/permissions","href":"users-and-permissions/get_user_permissions","openApiOperationId":"get_user_permissions","summary":"Getting permission values and user role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_308"}},"schemaId":"schema_308"},{"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/~1company~1{location_id}~1users~1{user_id}~1permissions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_308","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308"}}},{"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":"/users-and-permissions/get_user_permissions"}],"panels":[]}]},"httpPath":"/company/{location_id}/users/{user_id}/permissions"},{"label":"Updating permission values and user role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/update_user_permissions","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/update_user_permissions","metadata":{"seo":{"title":"Updating permission values and user role","description":"Updates the role and permissions of the user, as well as the team member who is attached to this user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_user_permissions","name":"Updating permission values and user role","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1permissions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updating permission values and user role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the role and permissions of the user, as well as the team member who is attached to this user.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"user_id","in":"path","schemaId":"schema_280","description":"ID of a user.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1permissions/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1permissions/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309","pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1permissions/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/company/{location_id}/users/{user_id}/permissions","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"user_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_309"}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/users/{user_id}/permissions","href":"users-and-permissions/update_user_permissions","openApiOperationId":"update_user_permissions","summary":"Updating permission values and user role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_309"}},"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":"schema_308"}},"schemaId":"schema_308"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1users~1{user_id}~1permissions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_308","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_308"}}},{"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"}}},{"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":"/users-and-permissions/update_user_permissions"}],"panels":[]}]},"httpPath":"/company/{location_id}/users/{user_id}/permissions"},{"label":"Create and Send an Invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/create_user_invitation","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/create_user_invitation","metadata":{"seo":{"title":"Create and Send an Invitation","description":"An invitation to manage a location is sent via email or phone as a link. By following the link and completing registration, the user gains access to manage the location according to the permissions assigned. Permission assignment is performed in a separate request after the invitation is sent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_user_invitation","name":"Create and Send an Invitation","isWebhook":false,"pointer":"/paths/~1user~1invite~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create and Send an Invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An invitation to manage a location is sent via email or phone as a link. By following the link and completing registration, the user gains access to manage the location according to the permissions assigned.\nPermission assignment is performed in a separate request after the invitation is sent.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1user~1invite~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1user~1invite~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"schemaId":"schema_310","pointer":"/paths/~1user~1invite~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user/invite/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_310"}},"responseCodes":["202","401","403","404","422"],"pointer":"/user/invite/{location_id}","href":"users-and-permissions/create_user_invitation","openApiOperationId":"create_user_invitation","summary":"Create and Send an Invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_310","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"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/user_invite_response_data_types"}},"schemaId":"components/schemas/user_invite_response_data_types"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1user~1invite~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/user_invite_response_data_types","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user_invite_response_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"}}},{"code":"404","schemaId":"components/schemas/404_not_found_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/404_not_found_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":"/users-and-permissions/create_user_invitation"}],"panels":[]}]},"httpPath":"/user/invite/{location_id}"},{"label":"Copy a User to Companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/copy_user_permissions_to_locations","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/copy_user_permissions_to_locations","metadata":{"seo":{"title":"Copy a User to Companies","description":"Copies an active user and their permissions to multiple locations at once. If the user does not yet exist in a location, they will be added as an active user. If the user has already been invited to the location, only their permissions will be updated — however, they will still need to accept the invitation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"copy_user_permissions_to_locations","name":"Copy a User to Companies","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1copy_to_companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a User to Companies","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":"Copies an active user and their permissions to multiple locations at once. If the user does not yet exist in a location, they will be added as an active user. If the user has already been invited to the location, only their permissions will be updated — however, they will still need to accept the invitation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"user_id","in":"path","schemaId":"schema_280","description":"ID of a user.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1copy_to_companies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1copy_to_companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_311"}},"schemaId":"schema_311","pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1copy_to_companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/users/{user_id}/copy_to_companies","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"user_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_311"}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/users/{user_id}/copy_to_companies","href":"users-and-permissions/copy_user_permissions_to_locations","openApiOperationId":"copy_user_permissions_to_locations","summary":"Copy a User to Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_311","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_311"}},"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/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1users~1{user_id}~1copy_to_companies/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"}}},{"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":"/users-and-permissions/copy_user_permissions_to_locations"}],"panels":[]}]},"httpPath":"/company/{location_id}/users/{user_id}/copy_to_companies"},{"label":"Removing a User from Companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/remove_user_from_locations","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/remove_user_from_locations","metadata":{"seo":{"title":"Removing a User from Companies","description":"Removes an active user from multiple companies at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove_user_from_locations","name":"Removing a User from Companies","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1remove_from_companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removing a User from Companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes an active user from multiple companies at once.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"user_id","in":"path","schemaId":"schema_280","description":"ID of a user.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1remove_from_companies/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1remove_from_companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_312"}},"schemaId":"schema_312","pointer":"/paths/~1company~1{location_id}~1users~1{user_id}~1remove_from_companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/users/{user_id}/remove_from_companies","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"user_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_312"}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/users/{user_id}/remove_from_companies","href":"users-and-permissions/remove_user_from_locations","openApiOperationId":"remove_user_from_locations","summary":"Removing a User from Companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_312","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_312"}},"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/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1users~1{user_id}~1remove_from_companies/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"}}},{"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":"/users-and-permissions/remove_user_from_locations"}],"panels":[]}]},"httpPath":"/company/{location_id}/users/{user_id}/remove_from_companies"},{"label":"Deprecated. Get location users","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/users-and-permissions/deprecated_get_location_users","routeSlug":"/en/b2b-v1/openapi/users-and-permissions/deprecated_get_location_users","metadata":{"seo":{"title":"Deprecated. Get location users","description":"location User object"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deprecated_get_location_users","name":"Deprecated. Get location users","deprecated":true,"isWebhook":false,"pointer":"/paths/~1company_users~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Get location users","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"location User object"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company_users~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company_users~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company_users/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company_users/{location_id}","href":"users-and-permissions/deprecated_get_location_users","openApiOperationId":"deprecated_get_location_users","summary":"Deprecated. Get location users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_users_deprecated_response_data_types","exampleIds":["paths/~1company_users~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_users_deprecated_response_data_types","exampleIds":["paths/~1company_users~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/~1company_users~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_users_deprecated_response_data_types","exampleIds":["paths/~1company_users~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_users_deprecated_response_data_types","exampleIds":["paths/~1company_users~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":"/users-and-permissions/deprecated_get_location_users"}],"panels":[]}]},"httpPath":"/company_users/{location_id}"}],"content":{"contentType":"group","meta":{"name":"Users & Permissions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users & Permissions","showPageActions":true},{"nodeType":"markdoc","content":"User account management and role-based access control"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company/{location_id}/users","summary":"Get location users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users-and-permissions/get_location_users","deprecated":false},{"title":"/company/{location_id}/users/{user_id}","summary":"Remove the user from the location","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users-and-permissions/remove_user_from_location","deprecated":false},{"title":"/user/permissions/{location_id}","summary":"Get a list of rights","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users-and-permissions/get_permission_list","deprecated":false},{"title":"/company/{location_id}/users/roles","summary":"Getting a list of user roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users-and-permissions/list_roles","deprecated":false},{"title":"/company/{location_id}/users/{user_id}/roles","summary":"Getting a list of user roles in the context of a location user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users-and-permissions/get_user_roles","deprecated":false},{"title":"/company/{location_id}/users/{user_id}/permissions","summary":"Getting permission values and user role","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users-and-permissions/get_user_permissions","deprecated":false},{"title":"/company/{location_id}/users/{user_id}/permissions","summary":"Updating permission values and user role","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users-and-permissions/update_user_permissions","deprecated":false},{"title":"/user/invite/{location_id}","summary":"Create and Send an Invitation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users-and-permissions/create_user_invitation","deprecated":false},{"title":"/company/{location_id}/users/{user_id}/copy_to_companies","summary":"Copy a User to Companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users-and-permissions/copy_user_permissions_to_locations","deprecated":false},{"title":"/company/{location_id}/users/{user_id}/remove_from_companies","summary":"Removing a User from Companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users-and-permissions/remove_user_from_locations","deprecated":false},{"title":"/company_users/{location_id}","summary":"Deprecated. Get location users","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/users-and-permissions/deprecated_get_location_users","deprecated":true}]}]}]}]}},{"type":"group","label":"Appointments","link":"/en/b2b-v1/openapi/appointments","routeSlug":"/en/b2b-v1/openapi/appointments","items":[{"label":"Get list of appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/get_appointment_list","routeSlug":"/en/b2b-v1/openapi/appointments/get_appointment_list","metadata":{"seo":{"title":"Get list of appointments","description":"Filtering Appointments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment_list","name":"Get list of appointments","isWebhook":false,"pointer":"/paths/~1records~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of appointments","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":"appointments/get_appointment_list/request/filtering-appointments","deepLinkHash":"/appointments/get_appointment_list#appointments/get_appointment_list/request/filtering-appointments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering Appointments"},"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":"staff_id: team member ID."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to retrieve appointments for a specific team member"},"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":"client_id: Client ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to retrieve appointments for a specific client"},"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":"created_user_id: User ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User who created the appointment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to filter appointments created by a specific user"},"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":"start_date: Session start date (inclusive)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointments with a session starting on or after this date"},"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":"end_date: Session end date (inclusive)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointments with a session ending on or before this date"},"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":"c_start_date: Appointment creation date from"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointments created on or after this date"},"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":"c_end_date: Appointment creation date until"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointments created on or before this date"},"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":"changed_after: Modified or created after this datetime"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointments created or modified after the specified date and time"},"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":"changed_before: Modified or created before this datetime"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointments created or modified before the specified date and time"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1records~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_280","description":"Page number","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"Number of appointments per page","example":50},{"name":"team_member_id","in":"query","schemaId":"schema_280","description":"team member ID, if you only need appointments for a specific team member","example":7572},{"name":"client_id","in":"query","schemaId":"schema_280","description":"Client ID. If you need appointments for a specific client","example":572},{"name":"created_user_id","in":"query","schemaId":"schema_280","description":"The ID of the user who created the appointment. If you need appointments created by a specific user","example":7572},{"name":"start_date","in":"query","schemaId":"schema_279","description":"Session date starting at (filter by session date). If you need appointments for a session starting from a specific date","example":"2026-01-21"},{"name":"end_date","in":"query","schemaId":"schema_279","description":"Session date to. If you need appointments for a session before a specific date","example":"2026-01-21"},{"name":"c_start_date","in":"query","schemaId":"schema_279","description":"Appointment creation date starting from(filter by appointment creation date). If you need appointments created since a specific date","example":"2026-01-21"},{"name":"c_end_date","in":"query","schemaId":"schema_279","description":"Appointment creation date by (filter by appointment creation date).","example":"2026-01-21"},{"name":"changed_after","in":"query","schemaId":"schema_279","description":"The date the appointment was modified/created. If you need appointments created/modified starting from a specific date and time","example":"2026-01-21T23:00:00"},{"name":"changed_before","in":"query","schemaId":"schema_279","description":"The date the appointment was modified/created. If you need appointments created/modified before a specific date and time","example":"2026-01-21T23:00:00"},{"name":"include_consumables","in":"query","schemaId":"schema_280","description":"Flag for including a list of consumables by appointments in the response","example":0},{"name":"include_finance_transactions","in":"query","schemaId":"schema_280","description":"Flag to include in the response financial transactions by appointments","example":0},{"name":"with_deleted","in":"query","schemaId":"schema_313","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include deleted appointments in output (with_deleted=1 will return deleted appointments as well)"},"children":[]}]}]}]}],"pointer":"/paths/~1records~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1records~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/records/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":50,"schemaId":"schema_280"},{"name":"team_member_id","in":"query","example":7572,"schemaId":"schema_280"},{"name":"client_id","in":"query","example":572,"schemaId":"schema_280"},{"name":"created_user_id","in":"query","example":7572,"schemaId":"schema_280"},{"name":"start_date","in":"query","example":"2026-01-21","schemaId":"schema_279"},{"name":"end_date","in":"query","example":"2026-01-21","schemaId":"schema_279"},{"name":"c_start_date","in":"query","example":"2026-01-21","schemaId":"schema_279"},{"name":"c_end_date","in":"query","example":"2026-01-21","schemaId":"schema_279"},{"name":"changed_after","in":"query","example":"2026-01-21T23:00:00","schemaId":"schema_279"},{"name":"changed_before","in":"query","example":"2026-01-21T23:00:00","schemaId":"schema_279"},{"name":"include_consumables","in":"query","example":0,"schemaId":"schema_280"},{"name":"include_finance_transactions","in":"query","example":0,"schemaId":"schema_280"},{"name":"with_deleted","in":"query","schemaId":"schema_313"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/records/{location_id}","href":"appointments/get_appointment_list","openApiOperationId":"get_appointment_list","summary":"Get list of appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/records_companyid_response_data-types","exampleIds":["paths/~1records~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/records_companyid_response_data-types","exampleIds":["paths/~1records~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/~1records~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/records_companyid_response_data-types","exampleIds":["paths/~1records~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/records_companyid_response_data-types","exampleIds":["paths/~1records~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":"/appointments/get_appointment_list"}],"panels":[]}]},"httpPath":"/records/{location_id}"},{"label":"Create a New Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/create_appointment","routeSlug":"/en/b2b-v1/openapi/appointments/create_appointment","metadata":{"seo":{"title":"Create a New Appointment","description":"Creates a standard Appointment or an Appointment in a Group Event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_appointment","name":"Create a New Appointment","isWebhook":false,"pointer":"/paths/~1records~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a New Appointment","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":"Creates a standard Appointment or an Appointment in a Group Event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a standard Appointment, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seance_length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a Group Event Appointment, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required. The API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"obtains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seance_length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the Group Event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To set custom Appointment Fields, pass an object in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with each key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"matching a field code configured for the Location. The Business User must have both"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields_record_values_read_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields_record_values_edit_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":24699}],"pointer":"/paths/~1records~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1records~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/records_companyid_request_data_types"}},"schemaId":"components/schemas/records_companyid_request_data_types","pointer":"/paths/~1records~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/records/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":24699,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/records_companyid_request_data_types"}},"responseCodes":["201","401","403","404","422"],"pointer":"/records/{location_id}","href":"appointments/create_appointment","openApiOperationId":"create_appointment","summary":"Create a New Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/records_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/records_companyid_request_data_types"}},"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/records_companyid_response_data-types","exampleIds":["paths/~1records~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/records_companyid_response_data-types","exampleIds":["paths/~1records~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"},{"code":"422","description":"Required request data is missing or invalid","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/~1records~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/records_companyid_response_data-types","exampleIds":["paths/~1records~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/records_companyid_response_data-types","exampleIds":["paths/~1records~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"}}},{"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":"/appointments/create_appointment"}],"panels":[]}]},"httpPath":"/records/{location_id}"},{"label":"Get an Appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/get_appointment","routeSlug":"/en/b2b-v1/openapi/appointments/get_appointment","metadata":{"seo":{"title":"Get an Appointment","description":"Get an Appointment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment","name":"Get an Appointment","isWebhook":false,"pointer":"/paths/~1record~1{location_id}~1{record_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an Appointment","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_280","description":"Appointment ID","required":true}],"pointer":"/paths/~1record~1{location_id}~1{record_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_consumables","in":"query","schemaId":"schema_280","example":0},{"name":"include_finance_transactions","in":"query","schemaId":"schema_280","example":0}],"pointer":"/paths/~1record~1{location_id}~1{record_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1record~1{location_id}~1{record_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/record/{location_id}/{record_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"include_consumables","in":"query","example":0,"schemaId":"schema_280"},{"name":"include_finance_transactions","in":"query","example":0,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/record/{location_id}/{record_id}","href":"appointments/get_appointment","openApiOperationId":"get_appointment","summary":"Get an Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/record_companyid_response_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/record_companyid_response_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_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/~1record~1{location_id}~1{record_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/record_companyid_response_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/record_companyid_response_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_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":"/appointments/get_appointment"}],"panels":[]}]},"httpPath":"/record/{location_id}/{record_id}"},{"label":"Edit Appointment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/update_appointment","routeSlug":"/en/b2b-v1/openapi/appointments/update_appointment","metadata":{"seo":{"title":"Edit Appointment","description":"Fully updates an Appointment. This is not a partial update: for a standard Appointment,resend staff_id, services, client, datetime, and seance_length, including whenonly custom_fields needs to change. A missing required field returns 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_appointment","name":"Edit Appointment","isWebhook":false,"pointer":"/paths/~1record~1{location_id}~1{record_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Appointment","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":"Fully updates an Appointment. This is not a partial update: for a standard Appointment,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resend "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seance_length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to change. A missing required field returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"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 a Group Event Appointment, send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"match the Appointment's current Group Event. The API obtains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"datetime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seance_length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from that Group Event."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"appointments/update_appointment/request/updating-only-custom-fields","deepLinkHash":"/appointments/update_appointment#appointments/update_appointment/request/updating-only-custom-fields"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating only custom fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the current Appointment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the required main fields into this request without changing them."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add the new values to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", using each configured field code as a key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Business User must have both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields_record_values_read_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields_record_values_edit_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Without both permissions, custom Appointment"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field values are not updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"appointments/update_appointment/request/editing-restrictions","deepLinkHash":"/appointments/update_appointment#appointments/update_appointment/request/editing-restrictions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Editing restrictions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request can be rejected when the Appointment is waiting for online payment, lies"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"outside the Business User's allowed editing period, is fully paid, or has an arrived"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client and the Business User lacks the corresponding edit permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_sale_bill_printed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", keep the resent date, time, client, attendance status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member, and Services unchanged when updating only custom fields. Changes covered by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the printed receipt can require reversing the receipt first."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_280","description":"Appointment ID","required":true}],"pointer":"/paths/~1record~1{location_id}~1{record_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_consumables","in":"query","schemaId":"schema_280","example":0},{"name":"include_finance_transactions","in":"query","schemaId":"schema_280","example":0}],"pointer":"/paths/~1record~1{location_id}~1{record_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1record~1{location_id}~1{record_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/records_companyid_request_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_custom_fields","paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_group_event_custom_fields"]}},"schemaId":"components/schemas/records_companyid_request_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_custom_fields","paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_group_event_custom_fields"],"pointer":"/paths/~1record~1{location_id}~1{record_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/record/{location_id}/{record_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"include_consumables","in":"query","example":0,"schemaId":"schema_280"},{"name":"include_finance_transactions","in":"query","example":0,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/records_companyid_request_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_custom_fields","paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_group_event_custom_fields"]}},"responseCodes":["201","400","401","403","404","422"],"pointer":"/record/{location_id}/{record_id}","href":"appointments/update_appointment","openApiOperationId":"update_appointment","summary":"Edit Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/records_companyid_request_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_custom_fields","paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_group_event_custom_fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/records_companyid_request_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_custom_fields","paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_group_event_custom_fields"]}},"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/record_companyid_response201_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/record_companyid_response201_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/responses/201/content/application~1json/example"]},{"code":"400","description":"Appointment is waiting for online payment or the request format is invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"},{"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":"Business User does not have permission to edit this Appointment","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"},{"code":"422","description":"Required request data is missing or invalid, or the requested change is not allowed","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/~1record~1{location_id}~1{record_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/record_companyid_response201_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/record_companyid_response201_data_types","exampleIds":["paths/~1record~1{location_id}~1{record_id}/put/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_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"}}},{"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":"/appointments/update_appointment"}],"panels":[]}]},"httpPath":"/record/{location_id}/{record_id}"},{"label":"Delete Appointment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/delete_appointment","routeSlug":"/en/b2b-v1/openapi/appointments/delete_appointment","metadata":{"seo":{"title":"Delete Appointment","description":"Delete Appointment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_appointment","name":"Delete Appointment","isWebhook":false,"pointer":"/paths/~1record~1{location_id}~1{record_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Appointment","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_280","description":"Appointment ID","required":true}],"pointer":"/paths/~1record~1{location_id}~1{record_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_consumables","in":"query","schemaId":"schema_280","example":0},{"name":"include_finance_transactions","in":"query","schemaId":"schema_280","example":0}],"pointer":"/paths/~1record~1{location_id}~1{record_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1record~1{location_id}~1{record_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/record/{location_id}/{record_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"include_consumables","in":"query","example":0,"schemaId":"schema_280"},{"name":"include_finance_transactions","in":"query","example":0,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/record/{location_id}/{record_id}","href":"appointments/delete_appointment","openApiOperationId":"delete_appointment","summary":"Delete Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1record~1{location_id}~1{record_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/appointments/delete_appointment"}],"panels":[]}]},"httpPath":"/record/{location_id}/{record_id}"},{"label":"Get a List of Partner Appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/get_partner_appointment_list","routeSlug":"/en/b2b-v1/openapi/appointments/get_partner_appointment_list","metadata":{"seo":{"title":"Get a List of Partner Appointments","description":"Filtering appointments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_partner_appointment_list","name":"Get a List of Partner Appointments","isWebhook":false,"pointer":"/paths/~1records~1partner/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Partner Appointments","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":"appointments/get_partner_appointment_list/request/filtering-appointments","deepLinkHash":"/appointments/get_partner_appointment_list#appointments/get_partner_appointment_list/request/filtering-appointments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering appointments"},"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":"salon_id: Location ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this to filter appointments for a specific location"},"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":"start_date: Visit date from"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters appointments with a visit date starting from the specified date (inclusive)"},"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":"end_date: Visit date until"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters appointments with a visit date up to the specified date (inclusive)"},"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":"created_start_date: Appointment creation date from"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters appointments created on or after this date"},"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":"created_end_date: Appointment creation date until"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointments created on or before this date"},"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":"user_id: User ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters appointments created by a specific user"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_280","description":"Page number","example":1},{"name":"editable_length","in":"query","schemaId":"schema_280","description":"Number of appointments per page, maximum 100","example":50},{"name":"salon_id","in":"query","schemaId":"schema_280","description":"Location ID","example":1},{"name":"start_date","in":"query","schemaId":"schema_279","description":"Filter by visit date from","example":"'17.01.2025'"},{"name":"end_date","in":"query","schemaId":"schema_279","description":"Filter by visit date by","example":"'17.01.2025'"},{"name":"created_start_date","in":"query","schemaId":"schema_279","description":"Filter by appointment creation date from","example":"'17.01.2025'"},{"name":"created_end_date","in":"query","schemaId":"schema_279","description":"Filter by appointment creation date by","example":"'17.01.2025'"},{"name":"user_id","in":"query","schemaId":"schema_280","description":"User ID","example":1}],"pointer":"/paths/~1records~1partner/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1records~1partner/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/records/partner","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"editable_length","in":"query","example":50,"schemaId":"schema_280"},{"name":"salon_id","in":"query","example":1,"schemaId":"schema_280"},{"name":"start_date","in":"query","example":"'17.01.2025'","schemaId":"schema_279"},{"name":"end_date","in":"query","example":"'17.01.2025'","schemaId":"schema_279"},{"name":"created_start_date","in":"query","example":"'17.01.2025'","schemaId":"schema_279"},{"name":"created_end_date","in":"query","example":"'17.01.2025'","schemaId":"schema_279"},{"name":"user_id","in":"query","example":1,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/records/partner","href":"appointments/get_partner_appointment_list","openApiOperationId":"get_partner_appointment_list","summary":"Get a List of Partner Appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1records~1partner/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1records~1partner/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/~1records~1partner/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1records~1partner/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1records~1partner/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":"/appointments/get_partner_appointment_list"}],"panels":[]}]},"httpPath":"/records/partner"},{"label":"Get a visit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/get_visit","routeSlug":"/en/b2b-v1/openapi/appointments/get_visit","metadata":{"seo":{"title":"Get a visit","description":"Get a visit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_visit","name":"Get a visit","isWebhook":false,"pointer":"/paths/~1visits~1{visit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a visit","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"visit_id","in":"path","schemaId":"schema_280","required":true,"example":12345}],"pointer":"/paths/~1visits~1{visit_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visits~1{visit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/visits/{visit_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"visit_id","in":"path","required":true,"example":12345,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/visits/{visit_id}","href":"appointments/get_visit","openApiOperationId":"get_visit","summary":"Get a visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/visits_visitid_data_types","exampleIds":["paths/~1visits~1{visit_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visits_visitid_data_types","exampleIds":["paths/~1visits~1{visit_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/~1visits~1{visit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visits_visitid_data_types","exampleIds":["paths/~1visits~1{visit_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visits_visitid_data_types","exampleIds":["paths/~1visits~1{visit_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":"/appointments/get_visit"}],"panels":[]}]},"httpPath":"/visits/{visit_id}"},{"label":"Get Visit Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/get_visit_details","routeSlug":"/en/b2b-v1/openapi/appointments/get_visit_details","metadata":{"seo":{"title":"Get Visit Details","description":"Block \"kkm_transaction_details_container\""}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_visit_details","name":"Get Visit Details","isWebhook":false,"pointer":"/paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Visit Details","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":"Block \"kkm_transaction_details_container\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flag \"last_operation_type\""},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Print return receipt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Print sales receipt"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of all transactions with location account"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales operation – Active for documents of type Visit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale return operation – Active for documents of type Visit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correction operation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift opening operation – Opens a new POS shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift closing operation – Closes the current POS shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get POS status – Retrieves the current status of the POS device"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get POS team status – Retrieves the status of all POS devices connected to the team"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correction operation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Print X-report – Prints a non-fiscal summary report of the current shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash deposit – Registers a cash-in transaction in the POS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash withdrawal – Registers a cash-out transaction in the POS"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statuses of All POS Operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection error with POS – Unable to establish a connection with the POS device"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success – Operation completed successfully"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent for printing – The request has been sent to the POS and is waiting for print completion"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runtime error – An error occurred while processing the operation on the POS device"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status check error – Failed to retrieve the current status of the POS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Waiting for POS readiness – Operation is pending until the POS device becomes ready"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provision of services"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Arrival of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products write-off"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inventory"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consumables write-off"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","required":true,"example":12345},{"name":"record_id","in":"path","schemaId":"schema_280","required":true,"example":67890},{"name":"visit_id","in":"path","schemaId":"schema_280","required":true,"example":11111}],"pointer":"/paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer access_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/visit/details/{location_id}/{record_id}/{visit_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":12345,"schemaId":"schema_280"},{"name":"record_id","in":"path","required":true,"example":67890,"schemaId":"schema_280"},{"name":"visit_id","in":"path","required":true,"example":11111,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/visit/details/{location_id}/{record_id}/{visit_id}","href":"appointments/get_visit_details","openApiOperationId":"get_visit_details","summary":"Get Visit Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/visit_details_data_types","exampleIds":["paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visit_details_data_types","exampleIds":["paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_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/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visit_details_data_types","exampleIds":["paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visit_details_data_types","exampleIds":["paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_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":"/appointments/get_visit_details"}],"panels":[]}]},"httpPath":"/visit/details/{location_id}/{record_id}/{visit_id}"},{"label":"Edit Visit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/update_visit","routeSlug":"/en/b2b-v1/openapi/appointments/update_visit","metadata":{"seo":{"title":"Edit Visit","description":"Edit Visit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_visit","name":"Edit Visit","isWebhook":false,"pointer":"/paths/~1visits~1{visit_id}~1{record_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Visit","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"visit_id","in":"path","schemaId":"schema_280","required":true,"example":12345},{"name":"record_id","in":"path","schemaId":"schema_280","required":true,"example":67890}],"pointer":"/paths/~1visits~1{visit_id}~1{record_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visits~1{visit_id}~1{record_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visits_visitid_recordid_request_data_types"}},"schemaId":"components/schemas/visits_visitid_recordid_request_data_types","pointer":"/paths/~1visits~1{visit_id}~1{record_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/visits/{visit_id}/{record_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"visit_id","in":"path","required":true,"example":12345,"schemaId":"schema_280"},{"name":"record_id","in":"path","required":true,"example":67890,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/visits_visitid_recordid_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/visits/{visit_id}/{record_id}","href":"appointments/update_visit","openApiOperationId":"update_visit","summary":"Edit Visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/visits_visitid_recordid_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visits_visitid_recordid_request_data_types"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","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":"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/~1visits~1{visit_id}~1{record_id}/put/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":"/appointments/update_visit"}],"panels":[]}]},"httpPath":"/visits/{visit_id}/{record_id}"},{"label":"Receipt PDF for the visit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/get_visit_receipt_pdf","routeSlug":"/en/b2b-v1/openapi/appointments/get_visit_receipt_pdf","metadata":{"seo":{"title":"Receipt PDF for the visit","description":"Receipt PDF for the visit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_visit_receipt_pdf","name":"Receipt PDF for the visit","isWebhook":false,"pointer":"/paths/~1attendance~1receipt_print~1{visit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receipt PDF for the visit","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"visit_id","in":"path","schemaId":"schema_280","required":true,"example":12345}],"pointer":"/paths/~1attendance~1receipt_print~1{visit_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1attendance~1receipt_print~1{visit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/attendance/receipt_print/{visit_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"visit_id","in":"path","required":true,"example":12345,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/attendance/receipt_print/{visit_id}","href":"appointments/get_visit_receipt_pdf","openApiOperationId":"get_visit_receipt_pdf","summary":"Receipt PDF for the visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"exampleIds":["paths/~1attendance~1receipt_print~1{visit_id}/get/responses/200/content/application~1pdf/example"]}},"exampleIds":["paths/~1attendance~1receipt_print~1{visit_id}/get/responses/200/content/application~1pdf/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/~1attendance~1receipt_print~1{visit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1attendance~1receipt_print~1{visit_id}/get/responses/200/content/application~1pdf/example"],"mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"exampleIds":["paths/~1attendance~1receipt_print~1{visit_id}/get/responses/200/content/application~1pdf/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":"/appointments/get_visit_receipt_pdf"}],"panels":[]}]},"httpPath":"/attendance/receipt_print/{visit_id}"},{"label":"Get comments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/get_comments","routeSlug":"/en/b2b-v1/openapi/appointments/get_comments","metadata":{"seo":{"title":"Get comments","description":"The comment object has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_comments","name":"Get comments","isWebhook":false,"pointer":"/paths/~1comments~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get comments","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":"The comment object has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comment ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salon_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"location ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - comment to the team member, 0 - to the location"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"master_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member ID if type = 1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comment text"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date when the comment was left"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rating"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rating (from 1 to 5)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Id of the user who left the comment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"username"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the user who left the comment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_avatar"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Avatar of the user who left the comment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"record_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the post after which the review was left (the value will be non-zero if the review was left through a link asking for a review after the visit)"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1comments~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_279","description":"date in iso8601 format.\nFilter by date since (for example '2026-09-30')\n"},{"name":"end_date","in":"query","schemaId":"schema_279","description":"date in iso8601 format.\nFilter by date by (for example '2026-09-30')\n"},{"name":"team_member_id","in":"query","schemaId":"schema_280","description":"team member ID"},{"name":"rating","in":"query","schemaId":"schema_280","description":"Rating score. Filter by reviews with a specific rating."},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number"},{"name":"count","in":"query","schemaId":"schema_280","description":"Number of reviews per page"}],"pointer":"/paths/~1comments~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1comments~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/comments/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"start_date","in":"query","schemaId":"schema_279"},{"name":"end_date","in":"query","schemaId":"schema_279"},{"name":"team_member_id","in":"query","schemaId":"schema_280"},{"name":"rating","in":"query","schemaId":"schema_280"},{"name":"page","in":"query","schemaId":"schema_280"},{"name":"count","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/comments/{location_id}","href":"appointments/get_comments","openApiOperationId":"get_comments","summary":"Get comments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~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/~1comments~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~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":"/appointments/get_comments"}],"panels":[]}]},"httpPath":"/comments/{location_id}"},{"label":"Leave a Comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/leave_comment","routeSlug":"/en/b2b-v1/openapi/appointments/leave_comment","metadata":{"seo":{"title":"Leave a Comment","description":"Leave a Comment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"leave_comment","name":"Leave a Comment","isWebhook":false,"pointer":"/paths/~1comments~1{location_id}~1{team_member_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Leave a Comment","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID, specify when creating a review for a team member","required":true}],"pointer":"/paths/~1comments~1{location_id}~1{team_member_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1comments~1{location_id}~1{team_member_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/comments_companyid_request_data_types"}},"schemaId":"components/schemas/comments_companyid_request_data_types","pointer":"/paths/~1comments~1{location_id}~1{team_member_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/comments/{location_id}/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/comments_companyid_request_data_types"}},"responseCodes":["201","401","403","404"],"pointer":"/comments/{location_id}/{team_member_id}","href":"appointments/leave_comment","openApiOperationId":"leave_comment","summary":"Leave a Comment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/comments_companyid_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/comments_companyid_request_data_types"}},"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/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~1{location_id}~1{team_member_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~1{location_id}~1{team_member_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/~1comments~1{location_id}~1{team_member_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~1{location_id}~1{team_member_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/comments_companyid_ressponse200_data_types","exampleIds":["paths/~1comments~1{location_id}~1{team_member_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":"/appointments/leave_comment"}],"panels":[]}]},"httpPath":"/comments/{location_id}/{team_member_id}"},{"label":"Create Recurring Appointments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/create_timetable_client_schedule","routeSlug":"/en/b2b-v1/openapi/appointments/create_timetable_client_schedule","metadata":{"seo":{"title":"Create Recurring Appointments","description":"Creates a recurring appointment series for a client based on an event schedule. Automatically generates future appointments according to the schedule pattern."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_timetable_client_schedule","name":"Create Recurring Appointments","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Recurring Appointments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a recurring appointment series for a client based on an event schedule. Automatically generates future appointments according to the schedule pattern.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314","pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/schedules/{schedule_id}/client_schedules","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_314"}},"responseCodes":["201","401","403","404","422"],"pointer":"/company/{location_id}/schedules/{schedule_id}/client_schedules","href":"appointments/create_timetable_client_schedule","openApiOperationId":"create_timetable_client_schedule","summary":"Create Recurring Appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_314"}},"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":"schema_315"}},"schemaId":"schema_315"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_315","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}}},{"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"}}},{"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":"/appointments/create_timetable_client_schedule"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}/client_schedules"},{"label":"Update Recurring Appointments","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/update_timetable_client_schedule","routeSlug":"/en/b2b-v1/openapi/appointments/update_timetable_client_schedule","metadata":{"seo":{"title":"Update Recurring Appointments","description":"Updates a recurring appointment series by attaching or detaching schedule days. This creates or removes future appointments accordingly."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_timetable_client_schedule","name":"Update Recurring Appointments","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Recurring Appointments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates a recurring appointment series by attaching or detaching schedule days. This creates or removes future appointments accordingly.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123},{"name":"client_schedule_id","in":"path","schemaId":"schema_280","description":"ID of a client schedule.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_316"}},"schemaId":"schema_316","pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"},{"name":"client_schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_316"}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}","href":"appointments/update_timetable_client_schedule","openApiOperationId":"update_timetable_client_schedule","summary":"Update Recurring Appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_316","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_316"}},"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":"schema_315"}},"schemaId":"schema_315"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_315","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}}},{"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"}}},{"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":"/appointments/update_timetable_client_schedule"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}"},{"label":"Delete Recurring Appointments","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/appointments/delete_timetable_client_schedule","routeSlug":"/en/b2b-v1/openapi/appointments/delete_timetable_client_schedule","metadata":{"seo":{"title":"Delete Recurring Appointments","description":"Deletes a recurring appointment series and all associated future appointments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_timetable_client_schedule","name":"Delete Recurring Appointments","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Recurring Appointments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a recurring appointment series and all associated future appointments.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123},{"name":"client_schedule_id","in":"path","schemaId":"schema_280","description":"ID of a client schedule.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"},{"name":"client_schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}","href":"appointments/delete_timetable_client_schedule","openApiOperationId":"delete_timetable_client_schedule","summary":"Delete Recurring Appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"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/~1company~1{location_id}~1schedules~1{schedule_id}~1client_schedules~1{client_schedule_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","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":"/appointments/delete_timetable_client_schedule"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}"}],"content":{"contentType":"group","meta":{"name":"Appointments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appointments","showPageActions":true},{"nodeType":"markdoc","content":"Booking records and visit management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/records/{location_id}","summary":"Get list of appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get_appointment_list","deprecated":false},{"title":"/records/{location_id}","summary":"Create a New Appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/create_appointment","deprecated":false},{"title":"/record/{location_id}/{record_id}","summary":"Get an Appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get_appointment","deprecated":false},{"title":"/record/{location_id}/{record_id}","summary":"Edit Appointment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/update_appointment","deprecated":false},{"title":"/record/{location_id}/{record_id}","summary":"Delete Appointment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appointments/delete_appointment","deprecated":false},{"title":"/records/partner","summary":"Get a List of Partner Appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get_partner_appointment_list","deprecated":false},{"title":"/visits/{visit_id}","summary":"Get a visit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get_visit","deprecated":false},{"title":"/visit/details/{location_id}/{record_id}/{visit_id}","summary":"Get Visit Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get_visit_details","deprecated":false},{"title":"/visits/{visit_id}/{record_id}","summary":"Edit Visit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/update_visit","deprecated":false},{"title":"/attendance/receipt_print/{visit_id}","summary":"Receipt PDF for the visit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get_visit_receipt_pdf","deprecated":false},{"title":"/comments/{location_id}","summary":"Get comments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/get_comments","deprecated":false},{"title":"/comments/{location_id}/{team_member_id}","summary":"Leave a Comment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/leave_comment","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}/client_schedules","summary":"Create Recurring Appointments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/create_timetable_client_schedule","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}","summary":"Update Recurring Appointments","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/appointments/update_timetable_client_schedule","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}/client_schedules/{client_schedule_id}","summary":"Delete Recurring Appointments","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appointments/delete_timetable_client_schedule","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/en/b2b-v1/openapi/events","routeSlug":"/en/b2b-v1/openapi/events","items":[{"label":"Search Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/search_events","routeSlug":"/en/b2b-v1/openapi/events/search_events","metadata":{"seo":{"title":"Search Events","description":"Search Events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_events","name":"Search Events","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Events","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1activity~1{location_id}~1search/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_279","description":"Search start date (YYYY-MM-DD format).","required":true,"example":"2026-06-01"},{"name":"till","in":"query","schemaId":"schema_279","description":"Search end date (YYYY-MM-DD format).","required":true,"example":"2026-07-15"},{"name":"service_ids","in":"query","schemaId":"schema_317","description":"Filter by services IDs.","example":[123]},{"name":"staff_ids","in":"query","schemaId":"schema_317","description":"Filter by team member IDs.","example":[456]},{"name":"resource_ids","in":"query","schemaId":"schema_317","description":"Filter by resources IDs.","example":[789]},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number (default 1).","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"Page size (default 25).","example":25}],"pointer":"/paths/~1activity~1{location_id}~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1activity~1{location_id}~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity/{location_id}/search","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"from","in":"query","required":true,"example":"2026-06-01","schemaId":"schema_279"},{"name":"till","in":"query","required":true,"example":"2026-07-15","schemaId":"schema_279"},{"name":"service_ids","in":"query","example":[123],"schemaId":"schema_317"},{"name":"staff_ids","in":"query","example":[456],"schemaId":"schema_317"},{"name":"resource_ids","in":"query","example":[789],"schemaId":"schema_317"},{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":25,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/search","href":"events/search_events","openApiOperationId":"search_events","summary":"Search Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/event_search_response","exampleIds":["paths/~1activity~1{location_id}~1search/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/event_search_response","exampleIds":["paths/~1activity~1{location_id}~1search/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/~1activity~1{location_id}~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_search_response","exampleIds":["paths/~1activity~1{location_id}~1search/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_search_response","exampleIds":["paths/~1activity~1{location_id}~1search/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":"/events/search_events"}],"panels":[]}]},"httpPath":"/activity/{location_id}/search"},{"label":"Search Event Dates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/search_event_dates","routeSlug":"/en/b2b-v1/openapi/events/search_event_dates","metadata":{"seo":{"title":"Search Event Dates","description":"Search Event Dates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_event_dates","name":"Search Event Dates","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1search_dates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Event Dates","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1activity~1{location_id}~1search_dates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_279","description":"Search start date (YYYY-MM-DD format).","required":true,"example":"2026-06-01"},{"name":"till","in":"query","schemaId":"schema_279","description":"Search end date (YYYY-MM-DD format).","required":true,"example":"2026-07-15"},{"name":"service_ids","in":"query","schemaId":"schema_317","description":"Filter by services IDs.","example":[123]},{"name":"staff_ids","in":"query","schemaId":"schema_317","description":"Filter by team member IDs.","example":[456]},{"name":"resource_ids","in":"query","schemaId":"schema_317","description":"Filter by resources IDs.","example":[789]}],"pointer":"/paths/~1activity~1{location_id}~1search_dates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1activity~1{location_id}~1search_dates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity/{location_id}/search_dates","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"from","in":"query","required":true,"example":"2026-06-01","schemaId":"schema_279"},{"name":"till","in":"query","required":true,"example":"2026-07-15","schemaId":"schema_279"},{"name":"service_ids","in":"query","example":[123],"schemaId":"schema_317"},{"name":"staff_ids","in":"query","example":[456],"schemaId":"schema_317"},{"name":"resource_ids","in":"query","example":[789],"schemaId":"schema_317"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/search_dates","href":"events/search_event_dates","openApiOperationId":"search_event_dates","summary":"Search Event Dates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1activity~1{location_id}~1search_dates/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1activity~1{location_id}~1search_dates/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/~1activity~1{location_id}~1search_dates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1activity~1{location_id}~1search_dates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1search_dates/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":"/events/search_event_dates"}],"panels":[]}]},"httpPath":"/activity/{location_id}/search_dates"},{"label":"Get Event Date Range","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/get_event_date_range","routeSlug":"/en/b2b-v1/openapi/events/get_event_date_range","metadata":{"seo":{"title":"Get Event Date Range","description":"Get Event Date Range"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_event_date_range","name":"Get Event Date Range","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1search_dates_range/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Event Date Range","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1activity~1{location_id}~1search_dates_range/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"service_ids","in":"query","schemaId":"schema_317","description":"Filter by services IDs.","example":[123]},{"name":"staff_ids","in":"query","schemaId":"schema_317","description":"Filter by team member IDs.","example":[456]},{"name":"resource_ids","in":"query","schemaId":"schema_317","description":"Filter by resources IDs.","example":[789]}],"pointer":"/paths/~1activity~1{location_id}~1search_dates_range/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1activity~1{location_id}~1search_dates_range/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity/{location_id}/search_dates_range","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"service_ids","in":"query","example":[123],"schemaId":"schema_317"},{"name":"staff_ids","in":"query","example":[456],"schemaId":"schema_317"},{"name":"resource_ids","in":"query","example":[789],"schemaId":"schema_317"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/search_dates_range","href":"events/get_event_date_range","openApiOperationId":"get_event_date_range","summary":"Get Event Date Range"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_318","exampleIds":["paths/~1activity~1{location_id}~1search_dates_range/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_318","exampleIds":["paths/~1activity~1{location_id}~1search_dates_range/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/~1activity~1{location_id}~1search_dates_range/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_318","exampleIds":["paths/~1activity~1{location_id}~1search_dates_range/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_318","exampleIds":["paths/~1activity~1{location_id}~1search_dates_range/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":"/events/get_event_date_range"}],"panels":[]}]},"httpPath":"/activity/{location_id}/search_dates_range"},{"label":"Get Event Search Filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/get_event_search_filters","routeSlug":"/en/b2b-v1/openapi/events/get_event_search_filters","metadata":{"seo":{"title":"Get Event Search Filters","description":"Get Event Search Filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_event_search_filters","name":"Get Event Search Filters","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Event Search Filters","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1activity~1{location_id}~1filters/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"service_ids","in":"query","schemaId":"schema_317","description":"Filter by services IDs.","example":[123]},{"name":"staff_ids","in":"query","schemaId":"schema_317","description":"Filter by team member IDs.","example":[456]},{"name":"resource_ids","in":"query","schemaId":"schema_317","description":"Filter by resources IDs.","example":[789]}],"pointer":"/paths/~1activity~1{location_id}~1filters/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1activity~1{location_id}~1filters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity/{location_id}/filters","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"service_ids","in":"query","example":[123],"schemaId":"schema_317"},{"name":"staff_ids","in":"query","example":[456],"schemaId":"schema_317"},{"name":"resource_ids","in":"query","example":[789],"schemaId":"schema_317"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/filters","href":"events/get_event_search_filters","openApiOperationId":"get_event_search_filters","summary":"Get Event Search Filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_319","exampleIds":["paths/~1activity~1{location_id}~1filters/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_319","exampleIds":["paths/~1activity~1{location_id}~1filters/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/~1activity~1{location_id}~1filters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_319","exampleIds":["paths/~1activity~1{location_id}~1filters/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_319","exampleIds":["paths/~1activity~1{location_id}~1filters/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":"/events/get_event_search_filters"}],"panels":[]}]},"httpPath":"/activity/{location_id}/filters"},{"label":"Duplicate Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/duplicate_event","routeSlug":"/en/b2b-v1/openapi/events/duplicate_event","metadata":{"seo":{"title":"Duplicate Event","description":"A request for duplication can be made in 3 ways:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"duplicate_event","name":"Duplicate Event","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1{event_id}~1duplicate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Duplicate Event","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 request for duplication can be made in 3 ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifying a list of dates and times to duplicate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifying the ID of the repetition strategy"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By specifying all repetition parameters"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","required":true,"example":1},{"name":"event_id","in":"path","schemaId":"schema_286","required":true,"example":2}],"pointer":"/paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1{event_id}~1duplicate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"schemaId":"schema_320","pointer":"/paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activity/{location_id}/{event_id}/duplicate","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":1,"schemaId":"schema_280"},{"name":"event_id","in":"path","required":true,"example":2,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_320"}},"responseCodes":["200","400","401","403","404","409","422"],"pointer":"/activity/{location_id}/{event_id}/duplicate","href":"events/duplicate_event","openApiOperationId":"duplicate_event","summary":"Duplicate Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_320","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"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":{"exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"},{"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"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/409/content/application~1json/example"]}},"exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","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/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_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"}}},{"code":"409","exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/409/content/application~1json/example"]}}},{"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":"/events/duplicate_event"}],"panels":[]}]},"httpPath":"/activity/{location_id}/{event_id}/duplicate"},{"label":"Search Event Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/search_event_services","routeSlug":"/en/b2b-v1/openapi/events/search_event_services","metadata":{"seo":{"title":"Search Event Services","description":"Search Event Services"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_event_services","name":"Search Event Services","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Event Services","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":4564}],"pointer":"/paths/~1activity~1{location_id}~1services/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"staff_id","in":"query","schemaId":"schema_280","description":"team member ID to filter"},{"name":"term","in":"query","schemaId":"schema_279","description":"Search by name or part of the service name"}],"pointer":"/paths/~1activity~1{location_id}~1services/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity/{location_id}/services","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":4564,"schemaId":"schema_280"}],"query":[{"name":"staff_id","in":"query","schemaId":"schema_280"},{"name":"term","in":"query","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/services","href":"events/search_event_services","openApiOperationId":"search_event_services","summary":"Search Event Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/event_services_response","exampleIds":["paths/~1activity~1{location_id}~1services/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/event_services_response","exampleIds":["paths/~1activity~1{location_id}~1services/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/~1activity~1{location_id}~1services/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_services_response","exampleIds":["paths/~1activity~1{location_id}~1services/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_services_response","exampleIds":["paths/~1activity~1{location_id}~1services/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":"/events/search_event_services"}],"panels":[]}]},"httpPath":"/activity/{location_id}/services"},{"label":"List Event Duplication Strategies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/list_event_duplication_strategies","routeSlug":"/en/b2b-v1/openapi/events/list_event_duplication_strategies","metadata":{"seo":{"title":"List Event Duplication Strategies","description":"Duplication of Events occurs based on a set of parameters combined in the \"duplication strategy\" entity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_duplication_strategies","name":"List Event Duplication Strategies","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1duplication_strategy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Event Duplication Strategies","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":"Duplication of Events occurs based on a set of parameters combined in the \"duplication strategy\" entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strategy name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeat_mode_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repeat mode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"days"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer[]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of days of the week: 0 Sun, 6 Fri"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interval"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Break in searching for dates, in units of type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"content_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate appointments? 1 - no, 2 - yes"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The repeat mode can take the values"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Break unit"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Weekdays"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mon Wed Fri"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tue Thu"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every week"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every month"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every year"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Year"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The days field is relevant only for mode 5 - week, for specifying specific days of repetition"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify repeat_mode = 5, days = [1,4], interval = 2, then the Event will be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"repeat every 3rd week on Mon and Thu"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":4564}],"pointer":"/paths/~1activity~1{location_id}~1duplication_strategy/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1duplication_strategy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity/{location_id}/duplication_strategy","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":4564,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/duplication_strategy","href":"events/list_event_duplication_strategies","openApiOperationId":"list_event_duplication_strategies","summary":"List Event Duplication Strategies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/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/~1activity~1{location_id}~1duplication_strategy/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/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":"/events/list_event_duplication_strategies"}],"panels":[]}]},"httpPath":"/activity/{location_id}/duplication_strategy"},{"label":"Create Event Duplication Strategy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/create_event_duplication_strategy","routeSlug":"/en/b2b-v1/openapi/events/create_event_duplication_strategy","metadata":{"seo":{"title":"Create Event Duplication Strategy","description":"Create Event Duplication Strategy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_event_duplication_strategy","name":"Create Event Duplication Strategy","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1duplication_strategy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Event Duplication Strategy","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1activity~1{location_id}~1duplication_strategy/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1duplication_strategy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_321"}},"schemaId":"schema_321","pointer":"/paths/~1activity~1{location_id}~1duplication_strategy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activity/{location_id}/duplication_strategy","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_321"}},"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/duplication_strategy","href":"events/create_event_duplication_strategy","openApiOperationId":"create_event_duplication_strategy","summary":"Create Event Duplication Strategy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_321","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_321"}},"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":{"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/post/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/~1activity~1{location_id}~1duplication_strategy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy/post/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":"/events/create_event_duplication_strategy"}],"panels":[]}]},"httpPath":"/activity/{location_id}/duplication_strategy"},{"label":"Update Event Duplication Strategy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/update_event_duplication_strategy","routeSlug":"/en/b2b-v1/openapi/events/update_event_duplication_strategy","metadata":{"seo":{"title":"Update Event Duplication Strategy","description":"Update Event Duplication Strategy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_event_duplication_strategy","name":"Update Event Duplication Strategy","isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Event Duplication Strategy","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":4564},{"name":"strategy_id","in":"path","schemaId":"schema_280","description":"Replication strategy ID","required":true,"example":3}],"pointer":"/paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_321"}},"schemaId":"schema_321","pointer":"/paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activity/{location_id}/duplication_strategy/{strategy_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":4564,"schemaId":"schema_280"},{"name":"strategy_id","in":"path","required":true,"example":3,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_321"}},"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/duplication_strategy/{strategy_id}","href":"events/update_event_duplication_strategy","openApiOperationId":"update_event_duplication_strategy","summary":"Update Event Duplication Strategy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_321","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_321"}},"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":{"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/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/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/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":"/events/update_event_duplication_strategy"}],"panels":[]}]},"httpPath":"/activity/{location_id}/duplication_strategy/{strategy_id}"},{"label":"Deprecated. Get Event","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/get_event","routeSlug":"/en/b2b-v1/openapi/events/get_event","metadata":{"seo":{"title":"Deprecated. Get Event","description":"This endpoint is deprecated. Use GET /v2/locations/{location_id}/events/{event_id} instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_event","name":"Deprecated. Get Event","deprecated":true,"isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1{event_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Get Event","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/locations/{location_id}/events/{event_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"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":"Migration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The V2 Events API provides JSON:API formatted responses. See operation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get_event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_286","description":"Event ID","required":true}],"pointer":"/paths/~1activity~1{location_id}~1{event_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1{event_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activity/{location_id}/{event_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/activity/{location_id}/{event_id}","href":"events/get_event","openApiOperationId":"get_event","summary":"Deprecated. Get Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_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/~1activity~1{location_id}~1{event_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_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":"/events/get_event"}],"panels":[]}]},"httpPath":"/activity/{location_id}/{event_id}"},{"label":"Deprecated. Update Event","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/update_event","routeSlug":"/en/b2b-v1/openapi/events/update_event","metadata":{"seo":{"title":"Deprecated. Update Event","description":"This endpoint is deprecated. Use PUT /v2/locations/{location_id}/events/{event_id} instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_event","name":"Deprecated. Update Event","deprecated":true,"isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1{event_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Update Event","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /v2/locations/{location_id}/events/{event_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"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":"Migration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The V2 Events API provides enhanced validation and JSON:API formatted responses. See operation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_286","description":"Event ID","required":true}],"pointer":"/paths/~1activity~1{location_id}~1{event_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1{event_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_request"}},"schemaId":"components/schemas/event_request","pointer":"/paths/~1activity~1{location_id}~1{event_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/activity/{location_id}/{event_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/event_request"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/activity/{location_id}/{event_id}","href":"events/update_event","openApiOperationId":"update_event","summary":"Deprecated. Update Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/event_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_request"}},"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/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_id}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1activity~1{location_id}~1{event_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}~1{event_id}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_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"}}},{"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":"/events/update_event"}],"panels":[]}]},"httpPath":"/activity/{location_id}/{event_id}"},{"label":"Deprecated. Delete Event","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/delete_event","routeSlug":"/en/b2b-v1/openapi/events/delete_event","metadata":{"seo":{"title":"Deprecated. Delete Event","description":"This endpoint is deprecated. Use DELETE /v2/locations/{location_id}/events/{event_id} instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_event","name":"Deprecated. Delete Event","deprecated":true,"isWebhook":false,"pointer":"/paths/~1activity~1{location_id}~1{event_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Delete Event","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/locations/{location_id}/events/{event_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"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":"Migration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The V2 Events API provides JSON:API formatted responses. See operation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete_event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_286","description":"Event ID","required":true}],"pointer":"/paths/~1activity~1{location_id}~1{event_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}~1{event_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/activity/{location_id}/{event_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["202","401","403","404"],"pointer":"/activity/{location_id}/{event_id}","href":"events/delete_event","openApiOperationId":"delete_event","summary":"Deprecated. Delete Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1{event_id}/delete/responses/202/content/application~1json/example"]}},"exampleIds":["paths/~1activity~1{location_id}~1{event_id}/delete/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/~1activity~1{location_id}~1{event_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","exampleIds":["paths/~1activity~1{location_id}~1{event_id}/delete/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1activity~1{location_id}~1{event_id}/delete/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":"/events/delete_event"}],"panels":[]}]},"httpPath":"/activity/{location_id}/{event_id}"},{"label":"Deprecated. Create Event","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/events/create_event","routeSlug":"/en/b2b-v1/openapi/events/create_event","metadata":{"seo":{"title":"Deprecated. Create Event","description":"This endpoint is deprecated. Use POST /v2/locations/{location_id}/events instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_event","name":"Deprecated. Create Event","deprecated":true,"isWebhook":false,"pointer":"/paths/~1activity~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated. Create Event","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/locations/{location_id}/events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"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":"Migration:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The V2 Events API provides enhanced validation, better error handling, and JSON:API format responses. See operation "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"create_event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1activity~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1activity~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_request"}},"schemaId":"components/schemas/event_request","pointer":"/paths/~1activity~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activity/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/event_request"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/activity/{location_id}","href":"events/create_event","openApiOperationId":"create_event","summary":"Deprecated. Create Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/event_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_request"}},"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/event_response","exampleIds":["paths/~1activity~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1activity~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_response","exampleIds":["paths/~1activity~1{location_id}/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_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"}}},{"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":"/events/create_event"}],"panels":[]}]},"httpPath":"/activity/{location_id}"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":"Group events and class management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/activity/{location_id}/search","summary":"Search Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/search_events","deprecated":false},{"title":"/activity/{location_id}/search_dates","summary":"Search Event Dates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/search_event_dates","deprecated":false},{"title":"/activity/{location_id}/search_dates_range","summary":"Get Event Date Range","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/get_event_date_range","deprecated":false},{"title":"/activity/{location_id}/filters","summary":"Get Event Search Filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/get_event_search_filters","deprecated":false},{"title":"/activity/{location_id}/{event_id}/duplicate","summary":"Duplicate Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/duplicate_event","deprecated":false},{"title":"/activity/{location_id}/services","summary":"Search Event Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/search_event_services","deprecated":false},{"title":"/activity/{location_id}/duplication_strategy","summary":"List Event Duplication Strategies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/list_event_duplication_strategies","deprecated":false},{"title":"/activity/{location_id}/duplication_strategy","summary":"Create Event Duplication Strategy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/create_event_duplication_strategy","deprecated":false},{"title":"/activity/{location_id}/duplication_strategy/{strategy_id}","summary":"Update Event Duplication Strategy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/update_event_duplication_strategy","deprecated":false},{"title":"/activity/{location_id}/{event_id}","summary":"Deprecated. Get Event","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/events/get_event","deprecated":true},{"title":"/activity/{location_id}/{event_id}","summary":"Deprecated. Update Event","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/events/update_event","deprecated":true},{"title":"/activity/{location_id}/{event_id}","summary":"Deprecated. Delete Event","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/events/delete_event","deprecated":true},{"title":"/activity/{location_id}","summary":"Deprecated. Create Event","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/events/create_event","deprecated":true}]}]}]}]}},{"type":"group","label":"Schedule & Resources","link":"/en/b2b-v1/openapi/schedule-and-resources","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources","items":[{"label":"Get schedule of a specific team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/get_team_member_schedule","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/get_team_member_schedule","metadata":{"seo":{"title":"Get schedule of a specific team member","description":"Get schedule of a specific team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_schedule","name":"Get schedule of a specific team member","isWebhook":false,"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get schedule of a specific team member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID.","required":true},{"name":"start_date","in":"path","schemaId":"schema_280","description":"Period start date","required":true,"example":20251201},{"name":"end_date","in":"path","schemaId":"schema_280","description":"Period end date","required":true,"example":20251231}],"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"start_date","in":"path","required":true,"example":20251201,"schemaId":"schema_280"},{"name":"end_date","in":"path","required":true,"example":20251231,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}","href":"schedule-and-resources/get_team_member_schedule","openApiOperationId":"get_team_member_schedule","summary":"Get schedule of a specific team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_322","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_322","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/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/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_322","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/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":"/schedule-and-resources/get_team_member_schedule"}],"panels":[]}]},"httpPath":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}"},{"label":"Change schedule of a specific team member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/update_team_member_schedule","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/update_team_member_schedule","metadata":{"seo":{"title":"Change schedule of a specific team member","description":"Change schedule of a specific team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_team_member_schedule","name":"Change schedule of a specific team member","isWebhook":false,"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change schedule of a specific team member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID","required":true},{"name":"start_date","in":"path","schemaId":"schema_323","description":"Start date (YYYY-MM-DD)","required":true},{"name":"end_date","in":"path","schemaId":"schema_323","description":"End date (YYYY-MM-DD)","required":true}],"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_324"}},"schemaId":"schema_324","pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"start_date","in":"path","required":true,"schemaId":"schema_323"},{"name":"end_date","in":"path","required":true,"schemaId":"schema_323"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_324"}},"responseCodes":["201","401","403","404"],"pointer":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}","href":"schedule-and-resources/update_team_member_schedule","openApiOperationId":"update_team_member_schedule","summary":"Change schedule of a specific team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_324","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_324"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created"},{"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/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/put/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":"/schedule-and-resources/update_team_member_schedule"}],"panels":[]}]},"httpPath":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}"},{"label":"Get a list of dates for Appointment Calendar","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/get_appointment_calendar_dates","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/get_appointment_calendar_dates","metadata":{"seo":{"title":"Get a list of dates for Appointment Calendar","description":"The Appointment Calendar dates are returned as an array of date strings, for example: [\"2026-10-26\", \"2026-10-30\"]. To retrieve this list, you must provide a reference date. The response will return the available working dates of the specified location or team member relative to that date"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment_calendar_dates","name":"Get a list of dates for Appointment Calendar","isWebhook":false,"pointer":"/paths/~1timetable~1dates~1{location_id}~1{date}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of dates for Appointment Calendar","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":"The Appointment Calendar dates are returned as an array of date strings, for example: [\"2026-10-26\", \"2026-10-30\"]. To retrieve this list, you must provide a reference date. The response will return the available working dates of the specified location or team member relative to that date"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"date","in":"path","schemaId":"schema_279","description":"date in iso8601 format.\nFilter by appointment date (eg '2026-09-30')\n","required":true}],"pointer":"/paths/~1timetable~1dates~1{location_id}~1{date}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"staff_id","in":"query","schemaId":"schema_280","description":"team member ID."}],"pointer":"/paths/~1timetable~1dates~1{location_id}~1{date}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1timetable~1dates~1{location_id}~1{date}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/timetable/dates/{location_id}/{date}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"date","in":"path","required":true,"schemaId":"schema_279"}],"query":[{"name":"staff_id","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/timetable/dates/{location_id}/{date}","href":"schedule-and-resources/get_appointment_calendar_dates","openApiOperationId":"get_appointment_calendar_dates","summary":"Get a list of dates for Appointment Calendar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1timetable~1dates~1{location_id}~1{date}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1timetable~1dates~1{location_id}~1{date}/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/~1timetable~1dates~1{location_id}~1{date}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1timetable~1dates~1{location_id}~1{date}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1timetable~1dates~1{location_id}~1{date}/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":"/schedule-and-resources/get_appointment_calendar_dates"}],"panels":[]}]},"httpPath":"/timetable/dates/{location_id}/{date}"},{"label":"Get a list of sessions for the Appointment Calendar","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/get_appointment_calendar_sessions","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/get_appointment_calendar_sessions","metadata":{"seo":{"title":"Get a list of sessions for the Appointment Calendar","description":"The sessions object for the log has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment_calendar_sessions","name":"Get a list of sessions for the Appointment Calendar","isWebhook":false,"pointer":"/paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of sessions for the Appointment Calendar","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":"The sessions object for the log has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Session time (17:30 for example)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"free"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free time or busy"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"date","in":"path","schemaId":"schema_279","description":"date in iso8601 format.\nFilter by appointment date (eg '2026-09-30')\n","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID.","required":true}],"pointer":"/paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/timetable/seances/{location_id}/{team_member_id}/{date}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"date","in":"path","required":true,"schemaId":"schema_279"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/timetable/seances/{location_id}/{team_member_id}/{date}","href":"schedule-and-resources/get_appointment_calendar_sessions","openApiOperationId":"get_appointment_calendar_sessions","summary":"Get a list of sessions for the Appointment Calendar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_325","exampleIds":["paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_325","exampleIds":["paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/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/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_325","exampleIds":["paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_325","exampleIds":["paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/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":"/schedule-and-resources/get_appointment_calendar_sessions"}],"panels":[]}]},"httpPath":"/timetable/seances/{location_id}/{team_member_id}/{date}"},{"label":"Getting Resources at a Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/get_resource_list","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/get_resource_list","metadata":{"seo":{"title":"Getting Resources at a Location","description":"Getting Resources at a Location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_resource_list","name":"Getting Resources at a Location","isWebhook":false,"pointer":"/paths/~1resources~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting Resources at a Location","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1resources~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Accept","in":"query","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"query","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"query","schemaId":"schema_279","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/~1resources~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/resources/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"Accept","in":"query","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"query","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"query","required":true,"schemaId":"schema_279"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/resources/{location_id}","href":"schedule-and-resources/get_resource_list","openApiOperationId":"get_resource_list","summary":"Getting Resources at a Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/resources_companyid_data_types","exampleIds":["paths/~1resources~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/resources_companyid_data_types","exampleIds":["paths/~1resources~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/~1resources~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/resources_companyid_data_types","exampleIds":["paths/~1resources~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resources_companyid_data_types","exampleIds":["paths/~1resources~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":"/schedule-and-resources/get_resource_list"}],"panels":[]}]},"httpPath":"/resources/{location_id}"},{"label":"Search a Schedule by Event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/search_timetable_event_schedules_by_event","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/search_timetable_event_schedules_by_event","metadata":{"seo":{"title":"Search a Schedule by Event","description":"Search for a schedule based on the appointment or event linked to it, or based on the associated appointment or event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_timetable_event_schedules_by_event","name":"Search a Schedule by Event","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1search~1{entity_type}~1{entity_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search a Schedule by Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for a schedule based on the appointment or event linked to it, or based on the associated appointment or event.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"entity_type","in":"path","schemaId":"schema_326","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of an entity schedule is searched by:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - individual appointment, currently not supported;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - group event."},"children":[]}]}]}],"required":true,"example":"activity"},{"name":"entity_id","in":"path","schemaId":"schema_280","description":"ID of an entity schedule is searched by.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1search~1{entity_type}~1{entity_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_327","description":"Requested set of an included models."}],"pointer":"/paths/~1company~1{location_id}~1schedules~1search~1{entity_type}~1{entity_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1search~1{entity_type}~1{entity_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/schedules/search/{entity_type}/{entity_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"entity_type","in":"path","required":true,"example":"activity","schemaId":"schema_326"},{"name":"entity_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"include","in":"query","schemaId":"schema_327"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/schedules/search/{entity_type}/{entity_id}","href":"schedule-and-resources/search_timetable_event_schedules_by_event","openApiOperationId":"search_timetable_event_schedules_by_event","summary":"Search a Schedule by Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_328"}},"schemaId":"schema_328"},{"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/~1company~1{location_id}~1schedules~1search~1{entity_type}~1{entity_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"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":"/schedule-and-resources/search_timetable_event_schedules_by_event"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/search/{entity_type}/{entity_id}"},{"label":"Create a Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/create_timetable_event_schedule","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/create_timetable_event_schedule","metadata":{"seo":{"title":"Create a Schedule","description":"Creates a schedule for appointments or events based on the original associated entity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_timetable_event_schedule","name":"Create a Schedule","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a schedule for appointments or events based on the original associated entity.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_329","description":"Requested set of an included models."}],"pointer":"/paths/~1company~1{location_id}~1schedules/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"schemaId":"schema_330","pointer":"/paths/~1company~1{location_id}~1schedules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/schedules","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"include","in":"query","schemaId":"schema_329"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_330"}},"responseCodes":["201","401","403","404","422"],"pointer":"/company/{location_id}/schedules","href":"schedule-and-resources/create_timetable_event_schedule","openApiOperationId":"create_timetable_event_schedule","summary":"Create a Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_330","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"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":"schema_328"}},"schemaId":"schema_328"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1schedules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"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"}}},{"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":"/schedule-and-resources/create_timetable_event_schedule"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules"},{"label":"Update a Schedule","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/update_timetable_event_schedule","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/update_timetable_event_schedule","metadata":{"seo":{"title":"Update a Schedule","description":"Updates the settings of a schedule containing appointments or events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_timetable_event_schedule","name":"Update a Schedule","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the settings of a schedule containing appointments or events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331","pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/company/{location_id}/schedules/{schedule_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_331"}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/schedules/{schedule_id}","href":"schedule-and-resources/update_timetable_event_schedule","openApiOperationId":"update_timetable_event_schedule","summary":"Update a Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"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":"schema_328"}},"schemaId":"schema_328"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1schedules~1{schedule_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"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"}}},{"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":"/schedule-and-resources/update_timetable_event_schedule"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}"},{"label":"Delete a Schedule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/delete_timetable_event_schedule","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/delete_timetable_event_schedule","metadata":{"seo":{"title":"Delete a Schedule","description":"Completely deletes a schedule along with all its series and the linked appointments or events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_timetable_event_schedule","name":"Delete a Schedule","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Completely deletes a schedule along with all its series and the linked appointments or events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/schedules/{schedule_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/company/{location_id}/schedules/{schedule_id}","href":"schedule-and-resources/delete_timetable_event_schedule","openApiOperationId":"delete_timetable_event_schedule","summary":"Delete a Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"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/~1company~1{location_id}~1schedules~1{schedule_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","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":"/schedule-and-resources/delete_timetable_event_schedule"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}"},{"label":"Create a Schedule Series","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/create_timetable_schedule_day","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/create_timetable_schedule_day","metadata":{"seo":{"title":"Create a Schedule Series","description":"Adds a new series to an existing schedule of appointments or events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_timetable_schedule_day","name":"Create a Schedule Series","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Schedule Series","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Adds a new series to an existing schedule of appointments or events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_332","description":"Requested set of an included models."}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"schemaId":"schema_333","pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/schedules/{schedule_id}/days","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"include","in":"query","schemaId":"schema_332"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_333"}},"responseCodes":["201","401","403","404","422"],"pointer":"/company/{location_id}/schedules/{schedule_id}/days","href":"schedule-and-resources/create_timetable_schedule_day","openApiOperationId":"create_timetable_schedule_day","summary":"Create a Schedule Series"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_333","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"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":"schema_334"}},"schemaId":"schema_334"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1schedules~1{schedule_id}~1days/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_334","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334"}}},{"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"}}},{"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":"/schedule-and-resources/create_timetable_schedule_day"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}/days"},{"label":"Update a schedule series","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/update_timetable_schedule_day","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/update_timetable_schedule_day","metadata":{"seo":{"title":"Update a schedule series","description":"Updates the settings of a schedule series for appointments or events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_timetable_schedule_day","name":"Update a schedule series","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a schedule series","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the settings of a schedule series for appointments or events.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123},{"name":"day_id","in":"path","schemaId":"schema_280","description":"ID of a schedule series.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_332","description":"Requested set of an included models."}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335","pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"},{"name":"day_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"include","in":"query","schemaId":"schema_332"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_335"}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}","href":"schedule-and-resources/update_timetable_schedule_day","openApiOperationId":"update_timetable_schedule_day","summary":"Update a schedule series"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_335"}},"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":"schema_334"}},"schemaId":"schema_334"},{"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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_334","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_334"}}},{"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"}}},{"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":"/schedule-and-resources/update_timetable_schedule_day"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}"},{"label":"Delete a schedule series","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/delete_timetable_schedule_day","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/delete_timetable_schedule_day","metadata":{"seo":{"title":"Delete a schedule series","description":"Deletes a schedule series and all appointments or events linked to it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_timetable_schedule_day","name":"Delete a schedule series","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a schedule series","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a schedule series and all appointments or events linked to it.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123},{"name":"day_id","in":"path","schemaId":"schema_280","description":"ID of a schedule series.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"},{"name":"day_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}","href":"schedule-and-resources/delete_timetable_schedule_day","openApiOperationId":"delete_timetable_schedule_day","summary":"Delete a schedule series"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/200_success_response"}},"schemaId":"components/schemas/200_success_response"},{"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/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","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":"/schedule-and-resources/delete_timetable_schedule_day"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}"},{"label":"Get a List of Scheduled Appointments and Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/list_timetable_schedule_day_events","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/list_timetable_schedule_day_events","metadata":{"seo":{"title":"Get a List of Scheduled Appointments and Events","description":"Prints a list of events of scheduled records/activities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_timetable_schedule_day_events","name":"Get a List of Scheduled Appointments and Events","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Scheduled Appointments and Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Prints  a list of events of scheduled records/activities.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"schedule_id","in":"path","schemaId":"schema_286","description":"ID of a schedule.","required":true,"example":123},{"name":"day_id","in":"path","schemaId":"schema_280","description":"ID of a schedule series.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}~1events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}/events","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"schedule_id","in":"path","required":true,"example":123,"schemaId":"schema_286"},{"name":"day_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}/events","href":"schedule-and-resources/list_timetable_schedule_day_events","openApiOperationId":"list_timetable_schedule_day_events","summary":"Get a List of Scheduled Appointments and Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_336"}},"schemaId":"schema_336"},{"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/~1company~1{location_id}~1schedules~1{schedule_id}~1days~1{day_id}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}}},{"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":"/schedule-and-resources/list_timetable_schedule_day_events"}],"panels":[]}]},"httpPath":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}/events"},{"label":"Retrieving Appointment Calendar Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/get_appointment_calendar_settings","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/get_appointment_calendar_settings","metadata":{"seo":{"title":"Retrieving Appointment Calendar Settings","description":"Retrieving Appointment Calendar Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment_calendar_settings","name":"Retrieving Appointment Calendar Settings","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1settings~1timetable/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieving Appointment Calendar 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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1timetable/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1timetable/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/settings/timetable","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/settings/timetable","href":"schedule-and-resources/get_appointment_calendar_settings","openApiOperationId":"get_appointment_calendar_settings","summary":"Retrieving Appointment Calendar Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Appointment calendar settings data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/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/~1company~1{location_id}~1settings~1timetable/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/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":"/schedule-and-resources/get_appointment_calendar_settings"}],"panels":[]}]},"httpPath":"/company/{location_id}/settings/timetable"},{"label":"Update Appointment Calendar settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/update_appointment_calendar_settings","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/update_appointment_calendar_settings","metadata":{"seo":{"title":"Update Appointment Calendar settings","description":"Update Appointment Calendar settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_appointment_calendar_settings","name":"Update Appointment Calendar settings","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1settings~1timetable/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Appointment Calendar 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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1timetable/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1timetable/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_update_timetable_settings_data_types"}},"schemaId":"components/schemas/company_update_timetable_settings_data_types","pointer":"/paths/~1company~1{location_id}~1settings~1timetable/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/company/{location_id}/settings/timetable","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/company_update_timetable_settings_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/settings/timetable","href":"schedule-and-resources/update_appointment_calendar_settings","openApiOperationId":"update_appointment_calendar_settings","summary":"Update Appointment Calendar settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/company_update_timetable_settings_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_update_timetable_settings_data_types"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated appointment calendar settings data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/patch/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/~1company~1{location_id}~1settings~1timetable/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_timetable_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1timetable/patch/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":"/schedule-and-resources/update_appointment_calendar_settings"}],"panels":[]}]},"httpPath":"/company/{location_id}/settings/timetable"},{"label":"Get team member schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/get_team_member_schedule_list","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/get_team_member_schedule_list","metadata":{"seo":{"title":"Get team member schedules","description":"Retrieves work schedules for team members as working intervals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_schedule_list","name":"Get team member schedules","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get team member schedules","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 work schedules for team members as working intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally includes:"},"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":"Busy intervals (appointments and events)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Off-day type identifiers"},"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":"Query Parameters:"},"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":"code","inline":true,"attributes":{"content":"start_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Date range for schedule search"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_ids[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Filter by specific team members"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Include additional data (busy_intervals, off_day_type)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true,"example":720441}],"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_323","description":"Start date for schedule search (YYYY-MM-DD)","example":"2026-01-31"},{"name":"end_date","in":"query","schemaId":"schema_323","description":"End date for schedule search (YYYY-MM-DD)","example":"2026-03-31"},{"name":"staff_ids","in":"query","schemaId":"schema_317","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team member IDs to filter by."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_ids[]=123&staff_ids[]=234"},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_337","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data to include in response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=busy_intervals&include[]=off_day_type"},"children":[]}]}]}]}],"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1staff~1schedule/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/staff/schedule","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":720441,"schemaId":"schema_286"}],"query":[{"name":"start_date","in":"query","example":"2026-01-31","schemaId":"schema_323"},{"name":"end_date","in":"query","example":"2026-03-31","schemaId":"schema_323"},{"name":"staff_ids","in":"query","schemaId":"schema_317","style":"form","explode":true},{"name":"include","in":"query","schemaId":"schema_337","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/staff/schedule","href":"schedule-and-resources/get_team_member_schedule_list","openApiOperationId":"get_team_member_schedule_list","summary":"Get team member schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Schedules retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_338","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_338","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule-and-resources/get_team_member_schedule_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/staff/schedule"},{"label":"Set team member schedules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/set_team_member_schedule","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/set_team_member_schedule","metadata":{"seo":{"title":"Set team member schedules","description":"Sets work schedules for team members by date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"set_team_member_schedule","name":"Set team member schedules","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set team member schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sets work schedules for team members by date.\n\nSupports both setting new schedules and deleting existing ones in a single request.\n\nReturns the resulting schedules for affected team members within the date range\nfrom minimum to maximum modified date.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true,"example":720441}],"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1staff~1schedule/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_339","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/company/{location_id}/staff/schedule","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":720441,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_339","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/staff/schedule","href":"schedule-and-resources/set_team_member_schedule","openApiOperationId":"set_team_member_schedule","summary":"Set team member schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_339","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_339","exampleIds":["paths/~1company~1{location_id}~1staff~1schedule/put/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":"Schedules updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Location or team member not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error (e.g., overlapping intervals)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291"}],"pointer":"/paths/~1company~1{location_id}~1staff~1schedule/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule-and-resources/set_team_member_schedule"}],"panels":[]}]},"httpPath":"/company/{location_id}/staff/schedule"},{"label":"Update team member schedule (deprecated)","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/schedule-and-resources/schedule_team_member_update_deprecated","routeSlug":"/en/b2b-v1/openapi/schedule-and-resources/schedule_team_member_update_deprecated","metadata":{"seo":{"title":"Update team member schedule (deprecated)","description":"DEPRECATED: Use PUT /location/{location_id}/staff/schedule instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"schedule_team_member_update_deprecated","name":"Update team member schedule (deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update team member schedule (deprecated)","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEPRECATED:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /location/{location_id}/staff/schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the work schedule for a specific team member."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true,"example":720441},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"Team member ID","required":true,"example":12345}],"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1schedule~1{location_id}~1{team_member_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_341","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_341","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/schedule/{location_id}/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":720441,"schemaId":"schema_286"},{"name":"team_member_id","in":"path","required":true,"example":12345,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_341","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["201","401","403","404"],"pointer":"/schedule/{location_id}/{team_member_id}","href":"schedule-and-resources/schedule_team_member_update_deprecated","openApiOperationId":"schedule_team_member_update_deprecated","summary":"Update team member schedule (deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_341","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_341","exampleIds":["paths/~1schedule~1{location_id}~1{team_member_id}/put/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":"201","description":"Schedule updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Team member not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1schedule~1{location_id}~1{team_member_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedule-and-resources/schedule_team_member_update_deprecated"}],"panels":[]}]},"httpPath":"/schedule/{location_id}/{team_member_id}"}],"content":{"contentType":"group","meta":{"name":"Schedule & Resources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule & Resources","showPageActions":true},{"nodeType":"markdoc","content":"Timetables, schedules, and resource allocation"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}","summary":"Get schedule of a specific team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/get_team_member_schedule","deprecated":false},{"title":"/schedule/{location_id}/{team_member_id}/{start_date}/{end_date}","summary":"Change schedule of a specific team member","prefix":{"name":"put","color":"put"},"badges":[],"link":"/schedule-and-resources/update_team_member_schedule","deprecated":false},{"title":"/timetable/dates/{location_id}/{date}","summary":"Get a list of dates for Appointment Calendar","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/get_appointment_calendar_dates","deprecated":false},{"title":"/timetable/seances/{location_id}/{team_member_id}/{date}","summary":"Get a list of sessions for the Appointment Calendar","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/get_appointment_calendar_sessions","deprecated":false},{"title":"/resources/{location_id}","summary":"Getting Resources at a Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/get_resource_list","deprecated":false},{"title":"/company/{location_id}/schedules/search/{entity_type}/{entity_id}","summary":"Search a Schedule by Event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/search_timetable_event_schedules_by_event","deprecated":false},{"title":"/company/{location_id}/schedules","summary":"Create a Schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedule-and-resources/create_timetable_event_schedule","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}","summary":"Update a Schedule","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/schedule-and-resources/update_timetable_event_schedule","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}","summary":"Delete a Schedule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/schedule-and-resources/delete_timetable_event_schedule","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}/days","summary":"Create a Schedule Series","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedule-and-resources/create_timetable_schedule_day","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}","summary":"Update a schedule series","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/schedule-and-resources/update_timetable_schedule_day","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}","summary":"Delete a schedule series","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/schedule-and-resources/delete_timetable_schedule_day","deprecated":false},{"title":"/company/{location_id}/schedules/{schedule_id}/days/{day_id}/events","summary":"Get a List of Scheduled Appointments and Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/list_timetable_schedule_day_events","deprecated":false},{"title":"/company/{location_id}/settings/timetable","summary":"Retrieving Appointment Calendar Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/get_appointment_calendar_settings","deprecated":false},{"title":"/company/{location_id}/settings/timetable","summary":"Update Appointment Calendar settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/schedule-and-resources/update_appointment_calendar_settings","deprecated":false},{"title":"/company/{location_id}/staff/schedule","summary":"Get team member schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedule-and-resources/get_team_member_schedule_list","deprecated":false},{"title":"/company/{location_id}/staff/schedule","summary":"Set team member schedules","prefix":{"name":"put","color":"put"},"badges":[],"link":"/schedule-and-resources/set_team_member_schedule","deprecated":false},{"title":"/schedule/{location_id}/{team_member_id}","summary":"Update team member schedule (deprecated)","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/schedule-and-resources/schedule_team_member_update_deprecated","deprecated":true}]}]}]}]}},{"type":"group","label":"Products","link":"/en/b2b-v1/openapi/products","routeSlug":"/en/b2b-v1/openapi/products","items":[{"label":"Search products and categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/search_product","routeSlug":"/en/b2b-v1/openapi/products/search_product","metadata":{"seo":{"title":"Search products and categories","description":"List of products and product categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_product","name":"Search products and categories","isWebhook":false,"pointer":"/paths/~1goods~1search~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search products and categories","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":3,"id":"products/search_product/request/list-of-products-and-product-categories","deepLinkHash":"/products/search_product#products/search_product/request/list-of-products-and-product-categories"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of products and product categories"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can retrieve a list of products and product categories by providing the location ID. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search_term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to filter:"},"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":"Product categories by name or article"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products by name, article, or barcode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit the number of results using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search_term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, the response will return a list of root categories for the specified location. In this case, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter is ignored. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"search_term"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the system will first search among categories. If fewer than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" results are found, the search will continue among products to fill the remaining count."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result is returned as an array of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#product-category-tree-node"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"products tree elements"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"product-category-tree-node"}},"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":"Product tree element"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Field | Type | Description |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":"| parent_id | number | Parent element ID (0 for root elements) |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| item_id | number | Item ID (0 if item is a category) |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| category_id | number | Product category ID (0 if the item is a product) |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| title | string | Product name or product category |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| is_chain | boolean | Is the element chain-bound? true - the element is connected to the chain, false - not connected |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| is_category | boolean | Is the element a category? true - category, false - product |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| is_item | boolean | Is the item a product? true - product, false - category |"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1goods~1search~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"term","in":"query","schemaId":"schema_279","description":"Search query by name, article number or barcode"},{"name":"count","in":"query","schemaId":"schema_280","description":"The number of output lines per page. Maximum 100"}],"pointer":"/paths/~1goods~1search~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods~1search~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/goods/search/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"term","in":"query","schemaId":"schema_279"},{"name":"count","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/goods/search/{location_id}","href":"products/search_product","openApiOperationId":"search_product","summary":"Search products and categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/goods_search_response200_data_types","exampleIds":["paths/~1goods~1search~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_search_response200_data_types","exampleIds":["paths/~1goods~1search~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/~1goods~1search~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_search_response200_data_types","exampleIds":["paths/~1goods~1search~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_search_response200_data_types","exampleIds":["paths/~1goods~1search~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":"/products/search_product"}],"panels":[]}]},"httpPath":"/goods/search/{location_id}"},{"label":"Get Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/get_product","routeSlug":"/en/b2b-v1/openapi/products/get_product","metadata":{"seo":{"title":"Get Products","description":"term: Name, article or barcodepage (number, 1) - Page number (not used if product_id is passed)count (number, 25) - Number of products on the page (not used if product_id is passed)category_id (number, 777) - Id of the product category (not used if product_id is passed)changed_after (string) - filtering products changed/created since a specific date and time (not used if product_id is passed)changed_before (string) - filtering products changed/created before a specific date and time (not used if product_id is passed)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_product","name":"Get Products","isWebhook":false,"pointer":"/paths/~1goods~1{location_id}~1{product_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"+"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"term: Name, article or barcode"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"page (number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - Page number (not used if product_id is passed)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"count (number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - Number of products on the page (not used if product_id is passed)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category_id (number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"777"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - Id of the product category (not used if product_id is passed)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changed_after (string) - filtering products changed/created since a specific date and time (not used if product_id is passed)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"changed_before (string) - filtering products changed/created before a specific date and time (not used if product_id is passed)"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"product_id","in":"path","schemaId":"schema_280","description":"Product ID (if you need to get a specific product)","required":true}],"pointer":"/paths/~1goods~1{location_id}~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"term","in":"query","schemaId":"schema_279","description":"name, article number or barcode"},{"name":"page","in":"query","schemaId":"schema_280","description":"page number","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"number of products per page","example":25},{"name":"category_id","in":"query","schemaId":"schema_280","description":"Product category ID"},{"name":"changed_after","in":"query","schemaId":"schema_279","description":"filtering products modified/created since a specific date and time","example":"2026-09-21T23:00:00.000-05:00"},{"name":"changed_before","in":"query","schemaId":"schema_279","description":"filtering products modified/created before a specific date and time","example":"2026-01-01T12:00:00-0500"}],"pointer":"/paths/~1goods~1{location_id}~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods~1{location_id}~1{product_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/goods/{location_id}/{product_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"term","in":"query","schemaId":"schema_279"},{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":25,"schemaId":"schema_280"},{"name":"category_id","in":"query","schemaId":"schema_280"},{"name":"changed_after","in":"query","example":"2026-09-21T23:00:00.000-05:00","schemaId":"schema_279"},{"name":"changed_before","in":"query","example":"2026-01-01T12:00:00-0500","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/goods/{location_id}/{product_id}","href":"products/get_product","openApiOperationId":"get_product","summary":"Get Products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_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/~1goods~1{location_id}~1{product_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_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":"/products/get_product"}],"panels":[]}]},"httpPath":"/goods/{location_id}/{product_id}"},{"label":"Edit Products","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/update_product","routeSlug":"/en/b2b-v1/openapi/products/update_product","metadata":{"seo":{"title":"Edit Products","description":"The method allows you to change the product parameters.When editing units of measure for a product that already has inventory operations, you must add an array of rules for recalculating units of measure - correction_rules. Otherwise, the array is optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_product","name":"Edit Products","isWebhook":false,"pointer":"/paths/~1goods~1{location_id}~1{product_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Products","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":"The method allows you to change the product parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When editing units of measure for a product that already has inventory operations, you must add an array of rules for recalculating units of measure - correction_rules. Otherwise, the array is optional."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"product_id","in":"path","schemaId":"schema_280","description":"Product ID","required":true}],"pointer":"/paths/~1goods~1{location_id}~1{product_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods~1{location_id}~1{product_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_company_request_with_rules_data_type"}},"schemaId":"components/schemas/goods_company_request_with_rules_data_type","pointer":"/paths/~1goods~1{location_id}~1{product_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/goods/{location_id}/{product_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/goods_company_request_with_rules_data_type"}},"responseCodes":["200","401","403","404","409","422"],"pointer":"/goods/{location_id}/{product_id}","href":"products/update_product","openApiOperationId":"update_product","summary":"Edit Products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/goods_company_request_with_rules_data_type","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_company_request_with_rules_data_type"}},"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/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/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"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_response409_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/goods_company_response409_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/409/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1goods~1{location_id}~1{product_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/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"}}},{"code":"409","schemaId":"components/schemas/goods_company_response409_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_response409_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}~1{product_id}/put/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/update_product"}],"panels":[]}]},"httpPath":"/goods/{location_id}/{product_id}"},{"label":"Delete Items","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/delete_product","routeSlug":"/en/b2b-v1/openapi/products/delete_product","metadata":{"seo":{"title":"Delete Items","description":"The method allows you to remove the product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_product","name":"Delete Items","isWebhook":false,"pointer":"/paths/~1goods~1{location_id}~1{product_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to remove the product"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"product_id","in":"path","schemaId":"schema_280","description":"Product ID","required":true}],"pointer":"/paths/~1goods~1{location_id}~1{product_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods~1{location_id}~1{product_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/goods/{location_id}/{product_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/goods/{location_id}/{product_id}","href":"products/delete_product","openApiOperationId":"delete_product","summary":"Delete Items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1goods~1{location_id}~1{product_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/products/delete_product"}],"panels":[]}]},"httpPath":"/goods/{location_id}/{product_id}"},{"label":"Get a list of products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/get_products_list","routeSlug":"/en/b2b-v1/openapi/products/get_products_list","metadata":{"seo":{"title":"Get a list of products","description":"Returns a list of all products for the specified location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_products_list","name":"Get a list of products","isWebhook":false,"pointer":"/paths/~1goods~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of products","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all products for the specified location"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1goods~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/goods/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/goods/{location_id}","href":"products/get_products_list","openApiOperationId":"get_products_list","summary":"Get a list of products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/goods_list_response","exampleIds":["paths/~1goods~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_list_response","exampleIds":["paths/~1goods~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"}],"pointer":"/paths/~1goods~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_list_response","exampleIds":["paths/~1goods~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_list_response","exampleIds":["paths/~1goods~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"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/get_products_list"}],"panels":[]}]},"httpPath":"/goods/{location_id}"},{"label":"Create product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/create_product","routeSlug":"/en/b2b-v1/openapi/products/create_product","metadata":{"seo":{"title":"Create product","description":"The method allows you to create a product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_product","name":"Create product","isWebhook":false,"pointer":"/paths/~1goods~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create product","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to create a product"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1goods~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_company_request_data_type"}},"schemaId":"components/schemas/goods_company_request_data_type","pointer":"/paths/~1goods~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/goods/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/goods_company_request_data_type"}},"responseCodes":["201","422"],"pointer":"/goods/{location_id}","href":"products/create_product","openApiOperationId":"create_product","summary":"Create product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/goods_company_request_data_type","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_company_request_data_type"}},"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/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}/post/responses/201/content/application~1json/example"]},{"code":"422","description":"Unprocessable Entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}/post/responses/422/content/application~1json/example"]}],"pointer":"/paths/~1goods~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_goods_id_response200_data_types","exampleIds":["paths/~1goods~1{location_id}/post/responses/201/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}/post/responses/422/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_company_response422_data_type","exampleIds":["paths/~1goods~1{location_id}/post/responses/422/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/create_product"}],"panels":[]}]},"httpPath":"/goods/{location_id}"},{"label":"Example of a request to get categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/get_product_category_list","routeSlug":"/en/b2b-v1/openapi/products/get_product_category_list","metadata":{"seo":{"title":"Example of a request to get categories","description":"Example of a request to get categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_product_category_list","name":"Example of a request to get categories","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Example of a request to get categories","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"parent_category_id","in":"path","schemaId":"schema_280","description":"ID of the parent product category","required":true}],"pointer":"/paths/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Accept","in":"query","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"query","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"query","schemaId":"schema_279","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/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/goods_categories/{parent_category_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"parent_category_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"Accept","in":"query","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"query","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"query","required":true,"schemaId":"schema_279"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/goods_categories/{parent_category_id}","href":"products/get_product_category_list","openApiOperationId":"get_product_category_list","summary":"Example of a request to get categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/goods_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1goods_categories~1{parent_category_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/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1company~1{location_id}~1goods_categories~1{parent_category_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":"/products/get_product_category_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/goods_categories/{parent_category_id}"},{"label":"Example of a request to get the composition of a category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/get_product_category_composition","routeSlug":"/en/b2b-v1/openapi/products/get_product_category_composition","metadata":{"seo":{"title":"Example of a request to get the composition of a category","description":"##№ Composition of the product category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_product_category_composition","name":"Example of a request to get the composition of a category","isWebhook":false,"pointer":"/paths/~1goods~1category_node~1{location_id}~1{category_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Example of a request to get the composition of a category","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":"##№ Composition of the product category"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information on a product category and its descendants can be obtained by making a request specifying the location ID and product category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination is supported, specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters."},"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":"Composition of a product category"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parent_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parent element ID (0 for root elements)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item ID (always 0)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"category_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product category ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product category name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_chain"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is the element chain-bound? true - the element is connected to the chain, false - not connected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is the element a category? always true"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_item"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is the item a product? always false"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"children"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of objects ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#good-category-tree-node"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product tree element"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Child elements of a product category"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"children_count"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of child products and categories (no recursion)"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"category_id","in":"path","schemaId":"schema_280","description":"Product Category ID","required":true}],"pointer":"/paths/~1goods~1category_node~1{location_id}~1{category_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_280","description":"Page number"},{"name":"count","in":"query","schemaId":"schema_280","description":"The number of products displayed on the page. Maximum 1000"}],"pointer":"/paths/~1goods~1category_node~1{location_id}~1{category_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods~1category_node~1{location_id}~1{category_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/goods/category_node/{location_id}/{category_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"category_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"page","in":"query","schemaId":"schema_280"},{"name":"count","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/goods/category_node/{location_id}/{category_id}","href":"products/get_product_category_composition","openApiOperationId":"get_product_category_composition","summary":"Example of a request to get the composition of a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/goods_category_node_response200_data_types","exampleIds":["paths/~1goods~1category_node~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_category_node_response200_data_types","exampleIds":["paths/~1goods~1category_node~1{location_id}~1{category_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/~1goods~1category_node~1{location_id}~1{category_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_category_node_response200_data_types","exampleIds":["paths/~1goods~1category_node~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_category_node_response200_data_types","exampleIds":["paths/~1goods~1category_node~1{location_id}~1{category_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":"/products/get_product_category_composition"}],"panels":[]}]},"httpPath":"/goods/category_node/{location_id}/{category_id}"},{"label":"Get a list of product categories by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/get_product_category_list_by_ids","routeSlug":"/en/b2b-v1/openapi/products/get_product_category_list_by_ids","metadata":{"seo":{"title":"Get a list of product categories by ID","description":"Get a list of product categories by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_product_category_list_by_ids","name":"Get a list of product categories by ID","isWebhook":false,"pointer":"/paths/~1goods_categories~1multiple~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of product categories by ID","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1goods_categories~1multiple~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"location_id","in":"query","schemaId":"schema_280","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product category ID (you can specify several additional parameters &ids[]={id}"},"children":[]}]}]}]}],"pointer":"/paths/~1goods_categories~1multiple~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods_categories~1multiple~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/goods_categories/multiple/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"location_id","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/goods_categories/multiple/{location_id}","href":"products/get_product_category_list_by_ids","openApiOperationId":"get_product_category_list_by_ids","summary":"Get a list of product categories by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1multiple~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1multiple~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/~1goods_categories~1multiple~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1multiple~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1multiple~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":"/products/get_product_category_list_by_ids"}],"panels":[]}]},"httpPath":"/goods_categories/multiple/{location_id}"},{"label":"Create a Product Category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/create_product_category","routeSlug":"/en/b2b-v1/openapi/products/create_product_category","metadata":{"seo":{"title":"Create a Product Category","description":"The method allows you to create a product category."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_product_category","name":"Create a Product Category","isWebhook":false,"pointer":"/paths/~1goods_categories~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Product Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to create a product category."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1goods_categories~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods_categories~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_categories_request_data_types"}},"schemaId":"components/schemas/goods_categories_request_data_types","pointer":"/paths/~1goods_categories~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/goods_categories/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/goods_categories_request_data_types"}},"responseCodes":["201","401","403","404"],"pointer":"/goods_categories/{location_id}","href":"products/create_product_category","openApiOperationId":"create_product_category","summary":"Create a Product Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/goods_categories_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_categories_request_data_types"}},"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/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~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/~1goods_categories~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~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":"/products/create_product_category"}],"panels":[]}]},"httpPath":"/goods_categories/{location_id}"},{"label":"Edit a Product Category","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/update_product_category","routeSlug":"/en/b2b-v1/openapi/products/update_product_category","metadata":{"seo":{"title":"Edit a Product Category","description":"The method allows you to edit the product category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_product_category","name":"Edit a Product Category","isWebhook":false,"pointer":"/paths/~1goods_categories~1{location_id}~1{category_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit a Product Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to edit the product category"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"category_id","in":"path","schemaId":"schema_280","description":"Product category ID","required":true}],"pointer":"/paths/~1goods_categories~1{location_id}~1{category_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods_categories~1{location_id}~1{category_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_categories_request_data_types"}},"schemaId":"components/schemas/goods_categories_request_data_types","pointer":"/paths/~1goods_categories~1{location_id}~1{category_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/goods_categories/{location_id}/{category_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"category_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/goods_categories_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/goods_categories/{location_id}/{category_id}","href":"products/update_product_category","openApiOperationId":"update_product_category","summary":"Edit a Product Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/goods_categories_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/goods_categories_request_data_types"}},"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/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_id}/put/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/~1goods_categories~1{location_id}~1{category_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_categories_post_put_response_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_id}/put/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":"/products/update_product_category"}],"panels":[]}]},"httpPath":"/goods_categories/{location_id}/{category_id}"},{"label":"Delete a Product Category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/delete_product_category","routeSlug":"/en/b2b-v1/openapi/products/delete_product_category","metadata":{"seo":{"title":"Delete a Product Category","description":"The method allows you to delete a product category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_product_category","name":"Delete a Product Category","isWebhook":false,"pointer":"/paths/~1goods_categories~1{location_id}~1{category_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Product Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to delete a product category"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"category_id","in":"path","schemaId":"schema_280","description":"Product category ID","required":true}],"pointer":"/paths/~1goods_categories~1{location_id}~1{category_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods_categories~1{location_id}~1{category_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/goods_categories/{location_id}/{category_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"category_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/goods_categories/{location_id}/{category_id}","href":"products/delete_product_category","openApiOperationId":"delete_product_category","summary":"Delete a Product Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1goods_categories~1{location_id}~1{category_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/products/delete_product_category"}],"panels":[]}]},"httpPath":"/goods_categories/{location_id}/{category_id}"},{"label":"Get a list of product categories","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/products/deprecated_get_product_category_list","routeSlug":"/en/b2b-v1/openapi/products/deprecated_get_product_category_list","metadata":{"seo":{"title":"Get a list of product categories","description":"Get a list of product categories"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deprecated_get_product_category_list","name":"Get a list of product categories","deprecated":true,"isWebhook":false,"pointer":"/paths/~1goods_categories~1{location_id}~1{category_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of product categories","isWebhook":false,"deprecated":true,"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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"category_id","in":"path","schemaId":"schema_280","description":"ID of the parent product category. Default 0 - top-level categories are displayed (optional)","required":true}],"pointer":"/paths/~1goods_categories~1{location_id}~1{category_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1goods_categories~1{location_id}~1{category_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/goods_categories/{location_id}/{category_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"category_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/goods_categories/{location_id}/{category_id}","href":"products/deprecated_get_product_category_list","openApiOperationId":"deprecated_get_product_category_list","summary":"Get a list of product categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_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/~1goods_categories~1{location_id}~1{category_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/goods_categories_response200_data_types","exampleIds":["paths/~1goods_categories~1{location_id}~1{category_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":"/products/deprecated_get_product_category_list"}],"panels":[]}]},"httpPath":"/goods_categories/{location_id}/{category_id}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Product catalog and categories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/goods/search/{location_id}","summary":"Search products and categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/search_product","deprecated":false},{"title":"/goods/{location_id}/{product_id}","summary":"Get Products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_product","deprecated":false},{"title":"/goods/{location_id}/{product_id}","summary":"Edit Products","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/update_product","deprecated":false},{"title":"/goods/{location_id}/{product_id}","summary":"Delete Items","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/delete_product","deprecated":false},{"title":"/goods/{location_id}","summary":"Get a list of products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_products_list","deprecated":false},{"title":"/goods/{location_id}","summary":"Create product","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/create_product","deprecated":false},{"title":"/company/{location_id}/goods_categories/{parent_category_id}","summary":"Example of a request to get categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_product_category_list","deprecated":false},{"title":"/goods/category_node/{location_id}/{category_id}","summary":"Example of a request to get the composition of a category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_product_category_composition","deprecated":false},{"title":"/goods_categories/multiple/{location_id}","summary":"Get a list of product categories by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_product_category_list_by_ids","deprecated":false},{"title":"/goods_categories/{location_id}","summary":"Create a Product Category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/create_product_category","deprecated":false},{"title":"/goods_categories/{location_id}/{category_id}","summary":"Edit a Product Category","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/update_product_category","deprecated":false},{"title":"/goods_categories/{location_id}/{category_id}","summary":"Delete a Product Category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/delete_product_category","deprecated":false},{"title":"/goods_categories/{location_id}/{category_id}","summary":"Get a list of product categories","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/products/deprecated_get_product_category_list","deprecated":true}]}]}]}]}},{"type":"group","label":"Inventory","link":"/en/b2b-v1/openapi/inventory","routeSlug":"/en/b2b-v1/openapi/inventory","items":[{"label":"Get location inventories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/get_location_inventories","routeSlug":"/en/b2b-v1/openapi/inventory/get_location_inventories","metadata":{"seo":{"title":"Get location inventories","description":"The location inventory object has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_inventories","name":"Get location inventories","isWebhook":false,"pointer":"/paths/~1storages~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location inventories","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":"The location inventory object has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inventory ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for_services"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - if used for automatic write-off of consumables"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for_sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - if the default inventory for selling products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description of the inventory"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1storages~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storages~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storages/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/storages/{location_id}","href":"inventory/get_location_inventories","openApiOperationId":"get_location_inventories","summary":"Get location inventories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/storage_response_data_types","exampleIds":["paths/~1storages~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_response_data_types","exampleIds":["paths/~1storages~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/~1storages~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_response_data_types","exampleIds":["paths/~1storages~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_response_data_types","exampleIds":["paths/~1storages~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":"/inventory/get_location_inventories"}],"panels":[]}]},"httpPath":"/storages/{location_id}"},{"label":"Search for product transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/search_for_product_transactions","routeSlug":"/en/b2b-v1/openapi/inventory/search_for_product_transactions","metadata":{"seo":{"title":"Search for product transactions","description":"Search for product transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_for_product_transactions","name":"Search for product transactions","isWebhook":false,"pointer":"/paths/~1storages~1transactions~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for product transactions","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1storages~1transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_280","description":"page number","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"number of transactions per page","example":20},{"name":"start_date","in":"query","schemaId":"schema_279","description":"period start date","example":"''"},{"name":"end_date","in":"query","schemaId":"schema_279","description":"period end date","example":"''"},{"name":"document_id","in":"query","schemaId":"schema_279","description":"Document ID"},{"name":"changed_after","in":"query","schemaId":"schema_279","description":"Filtering product transactions modified/created since a specific date and time"},{"name":"changed_before","in":"query","schemaId":"schema_279","description":"Filtering product transactions modified/created before a specific date and time"}],"pointer":"/paths/~1storages~1transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storages~1transactions~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storages/transactions/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":20,"schemaId":"schema_280"},{"name":"start_date","in":"query","example":"''","schemaId":"schema_279"},{"name":"end_date","in":"query","example":"''","schemaId":"schema_279"},{"name":"document_id","in":"query","schemaId":"schema_279"},{"name":"changed_after","in":"query","schemaId":"schema_279"},{"name":"changed_before","in":"query","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/storages/transactions/{location_id}","href":"inventory/search_for_product_transactions","openApiOperationId":"search_for_product_transactions","summary":"Search for product transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/storages_transaction_response_data_types","exampleIds":["paths/~1storages~1transactions~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storages_transaction_response_data_types","exampleIds":["paths/~1storages~1transactions~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/~1storages~1transactions~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storages_transaction_response_data_types","exampleIds":["paths/~1storages~1transactions~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storages_transaction_response_data_types","exampleIds":["paths/~1storages~1transactions~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":"/inventory/search_for_product_transactions"}],"panels":[]}]},"httpPath":"/storages/transactions/{location_id}"},{"label":"Create an inventory operation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/create_inventory_operation","routeSlug":"/en/b2b-v1/openapi/inventory/create_inventory_operation","metadata":{"seo":{"title":"Create an inventory operation","description":"An inventory operation is created by submitting a document along with multiple product transactions in a single API request. If a payment type is specified, the corresponding financial transactions will be generated automatically."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_inventory_operation","name":"Create an inventory operation","isWebhook":false,"pointer":"/paths/~1storage_operations~1operation~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an inventory operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"An inventory operation is created by submitting a document along with multiple product transactions in a single API request. If a payment type is specified, the corresponding financial transactions will be generated automatically."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1storage_operations~1operation~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1operation~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/storage_operation_operation_request_data_types"}},"schemaId":"components/schemas/storage_operation_operation_request_data_types","pointer":"/paths/~1storage_operations~1operation~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storage_operations/operation/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/storage_operation_operation_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/operation/{location_id}","href":"inventory/create_inventory_operation","openApiOperationId":"create_inventory_operation","summary":"Create an inventory operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/storage_operation_operation_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/storage_operation_operation_request_data_types"}},"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/storage_operation_operation_response_data_types","exampleIds":["paths/~1storage_operations~1operation~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_operation_response_data_types","exampleIds":["paths/~1storage_operations~1operation~1{location_id}/post/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/~1storage_operations~1operation~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_operation_response_data_types","exampleIds":["paths/~1storage_operations~1operation~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_operation_response_data_types","exampleIds":["paths/~1storage_operations~1operation~1{location_id}/post/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":"/inventory/create_inventory_operation"}],"panels":[]}]},"httpPath":"/storage_operations/operation/{location_id}"},{"label":"Create document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/create_document","routeSlug":"/en/b2b-v1/openapi/inventory/create_document","metadata":{"seo":{"title":"Create document","description":"Create document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_document","name":"Create document","isWebhook":false,"pointer":"/paths/~1storage_operations~1documents~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create document","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1storage_operations~1documents~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1documents~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/storage_operation_documents_request_data_types"}},"schemaId":"components/schemas/storage_operation_documents_request_data_types","pointer":"/paths/~1storage_operations~1documents~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storage_operations/documents/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/storage_operation_documents_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/documents/{location_id}","href":"inventory/create_document","openApiOperationId":"create_document","summary":"Create document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/storage_operation_documents_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/storage_operation_documents_request_data_types"}},"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/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}/post/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/~1storage_operations~1documents~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}/post/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":"/inventory/create_document"}],"panels":[]}]},"httpPath":"/storage_operations/documents/{location_id}"},{"label":"Get document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/get_document","routeSlug":"/en/b2b-v1/openapi/inventory/get_document","metadata":{"seo":{"title":"Get document","description":"Get document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_document","name":"Get document","isWebhook":false,"pointer":"/paths/~1storage_operations~1documents~1{location_id}~1{document_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"document_id","in":"path","schemaId":"schema_280","description":"Document ID","required":true}],"pointer":"/paths/~1storage_operations~1documents~1{location_id}~1{document_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1documents~1{location_id}~1{document_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storage_operations/documents/{location_id}/{document_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"document_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/documents/{location_id}/{document_id}","href":"inventory/get_document","openApiOperationId":"get_document","summary":"Get document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_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/~1storage_operations~1documents~1{location_id}~1{document_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_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":"/inventory/get_document"}],"panels":[]}]},"httpPath":"/storage_operations/documents/{location_id}/{document_id}"},{"label":"Update Document","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/update_document","routeSlug":"/en/b2b-v1/openapi/inventory/update_document","metadata":{"seo":{"title":"Update Document","description":"Update Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_document","name":"Update Document","isWebhook":false,"pointer":"/paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Document","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"document_id","in":"path","schemaId":"schema_280","description":"Document ID","required":true}],"pointer":"/paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1documents~1{location_id}~1{document_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/storage_operation_documents_request_data_types"}},"schemaId":"components/schemas/storage_operation_documents_request_data_types","pointer":"/paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storage_operations/documents/{location_id}/{document_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"document_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/storage_operation_documents_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/documents/{location_id}/{document_id}","href":"inventory/update_document","openApiOperationId":"update_document","summary":"Update Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/storage_operation_documents_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/storage_operation_documents_request_data_types"}},"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/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/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/~1storage_operations~1documents~1{location_id}~1{document_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_documents_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/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":"/inventory/update_document"}],"panels":[]}]},"httpPath":"/storage_operations/documents/{location_id}/{document_id}"},{"label":"Delete document","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/delete_document","routeSlug":"/en/b2b-v1/openapi/inventory/delete_document","metadata":{"seo":{"title":"Delete document","description":"Delete document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_document","name":"Delete document","isWebhook":false,"pointer":"/paths/~1storage_operations~1documents~1{location_id}~1{document_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete document","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"document_id","in":"path","schemaId":"schema_280","description":"Document ID","required":true}],"pointer":"/paths/~1storage_operations~1documents~1{location_id}~1{document_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1documents~1{location_id}~1{document_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/storage_operations/documents/{location_id}/{document_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"document_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["202","401","403","404"],"pointer":"/storage_operations/documents/{location_id}/{document_id}","href":"inventory/delete_document","openApiOperationId":"delete_document","summary":"Delete document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"202","description":"Accepted"},{"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/~1storage_operations~1documents~1{location_id}~1{document_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"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":"/inventory/delete_document"}],"panels":[]}]},"httpPath":"/storage_operations/documents/{location_id}/{document_id}"},{"label":"Create Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/create_transaction","routeSlug":"/en/b2b-v1/openapi/inventory/create_transaction","metadata":{"seo":{"title":"Create Transaction","description":"Create Transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_transaction","name":"Create Transaction","isWebhook":false,"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Transaction","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1goods_transactions~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types"}},"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types","pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storage_operations/goods_transactions/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types"}},"responseCodes":["200","400","401","403","404"],"pointer":"/storage_operations/goods_transactions/{location_id}","href":"inventory/create_transaction","openApiOperationId":"create_transaction","summary":"Create Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types"}},"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/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - validation errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_response"}},"schemaId":"components/schemas/422_unprocessable_entity_response"},{"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/~1storage_operations~1goods_transactions~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/422_unprocessable_entity_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/422_unprocessable_entity_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":"/inventory/create_transaction"}],"panels":[]}]},"httpPath":"/storage_operations/goods_transactions/{location_id}"},{"label":"Get a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/get_transaction","routeSlug":"/en/b2b-v1/openapi/inventory/get_transaction","metadata":{"seo":{"title":"Get a transaction","description":"Get a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_transaction","name":"Get a transaction","isWebhook":false,"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a transaction","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"transaction_id","in":"path","schemaId":"schema_280","description":"transaction ID","required":true}],"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","href":"inventory/get_transaction","openApiOperationId":"get_transaction","summary":"Get a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_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/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_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":"/inventory/get_transaction"}],"panels":[]}]},"httpPath":"/storage_operations/goods_transactions/{location_id}/{transaction_id}"},{"label":"Transaction update","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/update_transaction","routeSlug":"/en/b2b-v1/openapi/inventory/update_transaction","metadata":{"seo":{"title":"Transaction update","description":"Transaction update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_transaction","name":"Transaction update","isWebhook":false,"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transaction update","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transaction_id","in":"path","schemaId":"schema_280","description":"transaction ID","required":true},{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types"}},"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types","pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","href":"inventory/update_transaction","openApiOperationId":"update_transaction","summary":"Transaction update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/storage_operation_good_transaction_request_data_types"}},"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/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/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/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_good_transaction_response200_data_types","exampleIds":["paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/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":"/inventory/update_transaction"}],"panels":[]}]},"httpPath":"/storage_operations/goods_transactions/{location_id}/{transaction_id}"},{"label":"Deleting a transaction","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/delete_transaction","routeSlug":"/en/b2b-v1/openapi/inventory/delete_transaction","metadata":{"seo":{"title":"Deleting a transaction","description":"Deleting a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_transaction","name":"Deleting a transaction","isWebhook":false,"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting a transaction","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"transaction_id","in":"path","schemaId":"schema_280","description":"transaction ID","required":true}],"pointer":"/paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["202","401","403","404"],"pointer":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","href":"inventory/delete_transaction","openApiOperationId":"delete_transaction","summary":"Deleting a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"202","description":"Accepted"},{"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/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"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":"/inventory/delete_transaction"}],"panels":[]}]},"httpPath":"/storage_operations/goods_transactions/{location_id}/{transaction_id}"},{"label":"Get Product Transactions of a Document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/get_document_product_transactions","routeSlug":"/en/b2b-v1/openapi/inventory/get_document_product_transactions","metadata":{"seo":{"title":"Get Product Transactions of a Document","description":"Get Product Transactions of a Document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_document_product_transactions","name":"Get Product Transactions of a Document","isWebhook":false,"pointer":"/paths/~1storage_operations~1documents~1goods_transactions~1{document_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Product Transactions of a Document","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_280","description":"Document ID","required":true}],"pointer":"/paths/~1storage_operations~1documents~1goods_transactions~1{document_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1documents~1goods_transactions~1{document_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storage_operations/documents/goods_transactions/{document_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/documents/goods_transactions/{document_id}","href":"inventory/get_document_product_transactions","openApiOperationId":"get_document_product_transactions","summary":"Get Product Transactions of a Document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/storage_operation_good_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1goods_transactions~1{document_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_good_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1goods_transactions~1{document_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/~1storage_operations~1documents~1goods_transactions~1{document_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_good_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1goods_transactions~1{document_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_good_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1goods_transactions~1{document_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":"/inventory/get_document_product_transactions"}],"panels":[]}]},"httpPath":"/storage_operations/documents/goods_transactions/{document_id}"},{"label":"Retrieve a list of bill of materials and consumables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/get_bill_of_materials_list","routeSlug":"/en/b2b-v1/openapi/inventory/get_bill_of_materials_list","metadata":{"seo":{"title":"Retrieve a list of bill of materials and consumables","description":"Retrieve a list of bill of materials and consumables"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_bill_of_materials_list","name":"Retrieve a list of bill of materials and consumables","isWebhook":false,"pointer":"/paths/~1technological_cards~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of bill of materials and consumables","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1technological_cards~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_279","description":"parameter for searching by the name of those lists","example":"'test'"},{"name":"page","in":"query","schemaId":"schema_280","description":"page number","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"number of those lists per page","example":20}],"pointer":"/paths/~1technological_cards~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1technological_cards~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/technological_cards/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"search","in":"query","example":"'test'","schemaId":"schema_279"},{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":20,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/technological_cards/{location_id}","href":"inventory/get_bill_of_materials_list","openApiOperationId":"get_bill_of_materials_list","summary":"Retrieve a list of bill of materials and consumables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~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/~1technological_cards~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~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":"/inventory/get_bill_of_materials_list"}],"panels":[]}]},"httpPath":"/technological_cards/{location_id}"},{"label":"Get the Bill of Materials for a Team Member’s Service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/get_team_member_service_bill_of_materials","routeSlug":"/en/b2b-v1/openapi/inventory/get_team_member_service_bill_of_materials","metadata":{"seo":{"title":"Get the Bill of Materials for a Team Member’s Service","description":"Get the Bill of Materials for a Team Member’s Service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_service_bill_of_materials","name":"Get the Bill of Materials for a Team Member’s Service","isWebhook":false,"pointer":"/paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the Bill of Materials for a Team Member’s Service","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"team_member_id","in":"path","schemaId":"schema_280","description":"team member ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID","required":true}],"pointer":"/paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/technological_cards/default_for_staff_and_service/{location_id}/{team_member_id}/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"team_member_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/technological_cards/default_for_staff_and_service/{location_id}/{team_member_id}/{service_id}","href":"inventory/get_team_member_service_bill_of_materials","openApiOperationId":"get_team_member_service_bill_of_materials","summary":"Get the Bill of Materials for a Team Member’s Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_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/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/technological_cards_response200_data_types","exampleIds":["paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_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":"/inventory/get_team_member_service_bill_of_materials"}],"panels":[]}]},"httpPath":"/technological_cards/default_for_staff_and_service/{location_id}/{team_member_id}/{service_id}"},{"label":"Retrieve a list of bill of materials and consumables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/get_appointment_consumables","routeSlug":"/en/b2b-v1/openapi/inventory/get_appointment_consumables","metadata":{"seo":{"title":"Retrieve a list of bill of materials and consumables","description":"Retrieve a list of bill of materials and consumables"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment_consumables","name":"Retrieve a list of bill of materials and consumables","isWebhook":false,"pointer":"/paths/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a list of bill of materials and consumables","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_280","description":"Appointment ID","required":true}],"pointer":"/paths/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/technological_cards/record_consumables/{location_id}/{record_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/technological_cards/record_consumables/{location_id}/{record_id}","href":"inventory/get_appointment_consumables","openApiOperationId":"get_appointment_consumables","summary":"Retrieve a list of bill of materials and consumables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1{location_id}~1{record_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/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1{location_id}~1{record_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":"/inventory/get_appointment_consumables"}],"panels":[]}]},"httpPath":"/technological_cards/record_consumables/{location_id}/{record_id}"},{"label":"Update Consumables for the Appointment-Service Association","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/update_appointment_service_consumables","routeSlug":"/en/b2b-v1/openapi/inventory/update_appointment_service_consumables","metadata":{"seo":{"title":"Update Consumables for the Appointment-Service Association","description":"Update Consumables for the Appointment-Service Association"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_appointment_service_consumables","name":"Update Consumables for the Appointment-Service Association","isWebhook":false,"pointer":"/paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Consumables for the Appointment-Service Association","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_280","description":"Appointment ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID","required":true}],"pointer":"/paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/consumables"}},"schemaId":"components/schemas/consumables","pointer":"/paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/technological_cards/record_consumables/consumables/{location_id}/{record_id}/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/consumables"}},"responseCodes":["200","401","403","404"],"pointer":"/technological_cards/record_consumables/consumables/{location_id}/{record_id}/{service_id}","href":"inventory/update_appointment_service_consumables","openApiOperationId":"update_appointment_service_consumables","summary":"Update Consumables for the Appointment-Service Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/consumables","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/consumables"}},"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/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/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/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/technological_cards_consumables_response200_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/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":"/inventory/update_appointment_service_consumables"}],"panels":[]}]},"httpPath":"/technological_cards/record_consumables/consumables/{location_id}/{record_id}/{service_id}"},{"label":"Unlink Appointment-Service Association","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/inventory/unlink_appointment_service_association","routeSlug":"/en/b2b-v1/openapi/inventory/unlink_appointment_service_association","metadata":{"seo":{"title":"Unlink Appointment-Service Association","description":"Unlink Appointment-Service Association"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlink_appointment_service_association","name":"Unlink Appointment-Service Association","isWebhook":false,"pointer":"/paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlink Appointment-Service Association","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_280","description":"Appointment ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_280","description":"Service ID","required":true}],"pointer":"/paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"delete_consumables","in":"query","schemaId":"schema_280","description":"Whether to remove consumables along with deleting bill of materials. Default 0"}],"pointer":"/paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_342"}},"schemaId":"schema_342","pointer":"/paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/technological_cards/record_consumables/technological_cards/{location_id}/{record_id}/{service_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"delete_consumables","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_342"}},"responseCodes":["200","401","403","404"],"pointer":"/technological_cards/record_consumables/technological_cards/{location_id}/{record_id}/{service_id}","href":"inventory/unlink_appointment_service_association","openApiOperationId":"unlink_appointment_service_association","summary":"Unlink Appointment-Service Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_342","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_342"}},"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/technological_cards_consumables_response200_delete_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/technological_cards_consumables_response200_delete_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/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/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/technological_cards_consumables_response200_delete_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/technological_cards_consumables_response200_delete_data_types","exampleIds":["paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/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":"/inventory/unlink_appointment_service_association"}],"panels":[]}]},"httpPath":"/technological_cards/record_consumables/technological_cards/{location_id}/{record_id}/{service_id}"}],"content":{"contentType":"group","meta":{"name":"Inventory"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inventory","showPageActions":true},{"nodeType":"markdoc","content":"Stock management, storage operations, and tech cards"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/storages/{location_id}","summary":"Get location inventories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/get_location_inventories","deprecated":false},{"title":"/storages/transactions/{location_id}","summary":"Search for product transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/search_for_product_transactions","deprecated":false},{"title":"/storage_operations/operation/{location_id}","summary":"Create an inventory operation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory/create_inventory_operation","deprecated":false},{"title":"/storage_operations/documents/{location_id}","summary":"Create document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory/create_document","deprecated":false},{"title":"/storage_operations/documents/{location_id}/{document_id}","summary":"Get document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/get_document","deprecated":false},{"title":"/storage_operations/documents/{location_id}/{document_id}","summary":"Update Document","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory/update_document","deprecated":false},{"title":"/storage_operations/documents/{location_id}/{document_id}","summary":"Delete document","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inventory/delete_document","deprecated":false},{"title":"/storage_operations/goods_transactions/{location_id}","summary":"Create Transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inventory/create_transaction","deprecated":false},{"title":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","summary":"Get a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/get_transaction","deprecated":false},{"title":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","summary":"Transaction update","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory/update_transaction","deprecated":false},{"title":"/storage_operations/goods_transactions/{location_id}/{transaction_id}","summary":"Deleting a transaction","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inventory/delete_transaction","deprecated":false},{"title":"/storage_operations/documents/goods_transactions/{document_id}","summary":"Get Product Transactions of a Document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/get_document_product_transactions","deprecated":false},{"title":"/technological_cards/{location_id}","summary":"Retrieve a list of bill of materials and consumables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/get_bill_of_materials_list","deprecated":false},{"title":"/technological_cards/default_for_staff_and_service/{location_id}/{team_member_id}/{service_id}","summary":"Get the Bill of Materials for a Team Member’s Service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/get_team_member_service_bill_of_materials","deprecated":false},{"title":"/technological_cards/record_consumables/{location_id}/{record_id}","summary":"Retrieve a list of bill of materials and consumables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inventory/get_appointment_consumables","deprecated":false},{"title":"/technological_cards/record_consumables/consumables/{location_id}/{record_id}/{service_id}","summary":"Update Consumables for the Appointment-Service Association","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inventory/update_appointment_service_consumables","deprecated":false},{"title":"/technological_cards/record_consumables/technological_cards/{location_id}/{record_id}/{service_id}","summary":"Unlink Appointment-Service Association","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inventory/unlink_appointment_service_association","deprecated":false}]}]}]}]}},{"type":"group","label":"Sales","link":"/en/b2b-v1/openapi/sales","routeSlug":"/en/b2b-v1/openapi/sales","items":[{"label":"Receipt of a Sales Transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/sales/get_sale_transaction","routeSlug":"/en/b2b-v1/openapi/sales/get_sale_transaction","metadata":{"seo":{"title":"Receipt of a Sales Transaction","description":"Receipt of a Sales Transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_sale_transaction","name":"Receipt of a Sales Transaction","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receipt of a Sales Transaction","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_286","description":"Sales Document ID","required":true},{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1sale~1{document_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/sale/{document_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/sale/{document_id}","href":"sales/get_sale_transaction","openApiOperationId":"get_sale_transaction","summary":"Receipt of a Sales Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_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/~1company~1{location_id}~1sale~1{document_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_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":"/sales/get_sale_transaction"}],"panels":[]}]},"httpPath":"/company/{location_id}/sale/{document_id}"},{"label":"Payment at the Location Account and Loyalty (Various Methods)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/sales/create_payment_with_loyalty_methods","routeSlug":"/en/b2b-v1/openapi/sales/create_payment_with_loyalty_methods","metadata":{"seo":{"title":"Payment at the Location Account and Loyalty (Various Methods)","description":"As a response, information about the Sale operation is returned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_payment_with_loyalty_methods","name":"Payment at the Location Account and Loyalty (Various Methods)","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment at the Location Account and Loyalty (Various Methods)","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":"As a response, information about the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#sale-operation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_280","description":"Document ID","required":true},{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1sale~1{document_id}~1payment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"schemaId":"schema_343","pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/requestBody","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of payment by a gift card, if the user does not have the \"Pay by gift card and membership without code\" right, the \"number\" (string) parameter containing the gift card code must also be passed in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the case of payment by membership, if the user does not have the \"Pay by gift card and membership without code\" right, the \"number\" (string) parameter containing the membership code must also be passed in the request body."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/sale/{document_id}/payment","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_343"}},"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/sale/{document_id}/payment","href":"sales/create_payment_with_loyalty_methods","openApiOperationId":"create_payment_with_loyalty_methods","summary":"Payment at the Location Account and Loyalty (Various Methods)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_343","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_343"}},"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/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/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/~1company~1{location_id}~1sale~1{document_id}~1payment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/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":"/sales/create_payment_with_loyalty_methods"}],"panels":[]}]},"httpPath":"/company/{location_id}/sale/{document_id}/payment"},{"label":"Delete a Loyalty Payment Transaction","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/sales/delete_loyalty_payment_transaction","routeSlug":"/en/b2b-v1/openapi/sales/delete_loyalty_payment_transaction","metadata":{"seo":{"title":"Delete a Loyalty Payment Transaction","description":"As a response, information about the Sale operation is returned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_loyalty_payment_transaction","name":"Delete a Loyalty Payment Transaction","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Loyalty Payment Transaction","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":"As a response, information about the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#sale-operation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_286","description":"Sales Document ID","required":true},{"name":"payment_transaction_id","in":"path","schemaId":"schema_286","description":"transaction ID","required":true},{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/sale/{document_id}/payment/loyalty_transaction/{payment_transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"payment_transaction_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/sale/{document_id}/payment/loyalty_transaction/{payment_transaction_id}","href":"sales/delete_loyalty_payment_transaction","openApiOperationId":"delete_loyalty_payment_transaction","summary":"Delete a Loyalty Payment Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/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/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/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":"/sales/delete_loyalty_payment_transaction"}],"panels":[]}]},"httpPath":"/company/{location_id}/sale/{document_id}/payment/loyalty_transaction/{payment_transaction_id}"},{"label":"Delete a Cashier Payment Transaction","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/sales/delete_location_account_payment","routeSlug":"/en/b2b-v1/openapi/sales/delete_location_account_payment","metadata":{"seo":{"title":"Delete a Cashier Payment Transaction","description":"As a response, information about the Sale operation is returned"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_location_account_payment","name":"Delete a Cashier Payment Transaction","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Cashier Payment Transaction","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":"As a response, information about the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#sale-operation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_286","description":"Sales Document ID","required":true},{"name":"payment_transaction_id","in":"path","schemaId":"schema_286","description":"transaction ID","required":true},{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/sale/{document_id}/payment/payment_transaction/{payment_transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"payment_transaction_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/sale/{document_id}/payment/payment_transaction/{payment_transaction_id}","href":"sales/delete_location_account_payment","openApiOperationId":"delete_location_account_payment","summary":"Delete a Cashier Payment Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/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/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_salon_id_sale_documentid_response_data_types","exampleIds":["paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/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":"/sales/delete_location_account_payment"}],"panels":[]}]},"httpPath":"/company/{location_id}/sale/{document_id}/payment/payment_transaction/{payment_transaction_id}"}],"content":{"contentType":"group","meta":{"name":"Sales"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sales","showPageActions":true},{"nodeType":"markdoc","content":"Sales transactions and document management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company/{location_id}/sale/{document_id}","summary":"Receipt of a Sales Transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sales/get_sale_transaction","deprecated":false},{"title":"/company/{location_id}/sale/{document_id}/payment","summary":"Payment at the Location Account and Loyalty (Various Methods)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sales/create_payment_with_loyalty_methods","deprecated":false},{"title":"/company/{location_id}/sale/{document_id}/payment/loyalty_transaction/{payment_transaction_id}","summary":"Delete a Loyalty Payment Transaction","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sales/delete_loyalty_payment_transaction","deprecated":false},{"title":"/company/{location_id}/sale/{document_id}/payment/payment_transaction/{payment_transaction_id}","summary":"Delete a Cashier Payment Transaction","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sales/delete_location_account_payment","deprecated":false}]}]}]}]}},{"type":"group","label":"Payments","link":"/en/b2b-v1/openapi/payments","routeSlug":"/en/b2b-v1/openapi/payments","items":[{"label":"Get document financial transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/get_document_financial_transactions","routeSlug":"/en/b2b-v1/openapi/payments/get_document_financial_transactions","metadata":{"seo":{"title":"Get document financial transactions","description":"Get document financial transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_document_financial_transactions","name":"Get document financial transactions","isWebhook":false,"pointer":"/paths/~1storage_operations~1documents~1finance_transactions~1{document_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document financial transactions","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document_id","in":"path","schemaId":"schema_280","description":"Document ID","required":true}],"pointer":"/paths/~1storage_operations~1documents~1finance_transactions~1{document_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1storage_operations~1documents~1finance_transactions~1{document_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storage_operations/documents/finance_transactions/{document_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"document_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/storage_operations/documents/finance_transactions/{document_id}","href":"payments/get_document_financial_transactions","openApiOperationId":"get_document_financial_transactions","summary":"Get document financial transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/storage_operation_finance_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1finance_transactions~1{document_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/storage_operation_finance_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1finance_transactions~1{document_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/~1storage_operations~1documents~1finance_transactions~1{document_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/storage_operation_finance_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1finance_transactions~1{document_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/storage_operation_finance_transaction_response_data_types","exampleIds":["paths/~1storage_operations~1documents~1finance_transactions~1{document_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":"/payments/get_document_financial_transactions"}],"panels":[]}]},"httpPath":"/storage_operations/documents/finance_transactions/{document_id}"},{"label":"Get location accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/get_account_list","routeSlug":"/en/b2b-v1/openapi/payments/get_account_list","metadata":{"seo":{"title":"Get location accounts","description":"The location account object has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_account_list","name":"Get location accounts","isWebhook":false,"pointer":"/paths/~1accounts~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location accounts","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":"The location account object has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location account ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 - for non-cash payments, 0 for cash"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description to the location account"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1accounts~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1accounts~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accounts/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/accounts/{location_id}","href":"payments/get_account_list","openApiOperationId":"get_account_list","summary":"Get location accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/accounts_response_data_types","exampleIds":["paths/~1accounts~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/accounts_response_data_types","exampleIds":["paths/~1accounts~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/~1accounts~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/accounts_response_data_types","exampleIds":["paths/~1accounts~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/accounts_response_data_types","exampleIds":["paths/~1accounts~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":"/payments/get_account_list"}],"panels":[]}]},"httpPath":"/accounts/{location_id}"},{"label":"Get transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/get_transactions","routeSlug":"/en/b2b-v1/openapi/payments/get_transactions","metadata":{"seo":{"title":"Get transactions","description":"Transaction filtering"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_transactions","name":"Get transactions","isWebhook":false,"pointer":"/paths/~1transactions~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transactions","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":"payments/get_transactions/request/transaction-filtering","deepLinkHash":"/payments/get_transactions#payments/get_transactions/request/transaction-filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"+"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"page: Page number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"count: Number of customers per page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account_id: Checkout ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supplier_id: Supplier ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client_id: Client ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user_id: user ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"master_id: team member ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type: transaction type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"real_money: Indicates whether this is a real-money (fiat) transaction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted: whether the transaction was deleted"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start_date: start date of the period"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end_date: end date of the period"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance_is: 0 - any balance, 1 - positive, 2 - negative"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"document_id: document ID"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_280","description":"Page number","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"Number of customers per page","example":50},{"name":"account_id","in":"query","schemaId":"schema_280","description":"Checkout ID","example":0},{"name":"supplier_id","in":"query","schemaId":"schema_280","description":"Supplier ID","example":0},{"name":"client_id","in":"query","schemaId":"schema_280","description":"Client ID","example":0},{"name":"user_id","in":"query","schemaId":"schema_280","description":"User ID","example":0},{"name":"master_id","in":"query","schemaId":"schema_280","description":"team member ID","example":0},{"name":"type","in":"query","schemaId":"schema_280","description":"transaction type","example":0},{"name":"real_money","in":"query","schemaId":"schema_280","description":"Indicates whether this is a real-money (fiat) transaction","example":0},{"name":"deleted","in":"query","schemaId":"schema_280","description":"whether the transaction was deleted","example":0},{"name":"start_date","in":"query","schemaId":"schema_280","description":"period start date","example":20251201},{"name":"end_date","in":"query","schemaId":"schema_280","description":"period end date","example":20251231},{"name":"balance_is","in":"query","schemaId":"schema_280","description":"0 - any balance, 1 - positive, 2 - negative","example":1},{"name":"document_id","in":"query","schemaId":"schema_280","description":"document ID","example":0}],"pointer":"/paths/~1transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1transactions~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transactions/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":50,"schemaId":"schema_280"},{"name":"account_id","in":"query","example":0,"schemaId":"schema_280"},{"name":"supplier_id","in":"query","example":0,"schemaId":"schema_280"},{"name":"client_id","in":"query","example":0,"schemaId":"schema_280"},{"name":"user_id","in":"query","example":0,"schemaId":"schema_280"},{"name":"master_id","in":"query","example":0,"schemaId":"schema_280"},{"name":"type","in":"query","example":0,"schemaId":"schema_280"},{"name":"real_money","in":"query","example":0,"schemaId":"schema_280"},{"name":"deleted","in":"query","example":0,"schemaId":"schema_280"},{"name":"start_date","in":"query","example":20251201,"schemaId":"schema_280"},{"name":"end_date","in":"query","example":20251231,"schemaId":"schema_280"},{"name":"balance_is","in":"query","example":1,"schemaId":"schema_280"},{"name":"document_id","in":"query","example":0,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/transactions/{location_id}","href":"payments/get_transactions","openApiOperationId":"get_transactions","summary":"Get transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/transaction_companyid_response_data_types","exampleIds":["paths/~1transactions~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1transactions~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/~1transactions~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1transactions~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1transactions~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":"/payments/get_transactions"}],"panels":[]}]},"httpPath":"/transactions/{location_id}"},{"label":"Get Transactions by Visit or Appointment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/get_transactions_by_visit_or_appointment_id","routeSlug":"/en/b2b-v1/openapi/payments/get_transactions_by_visit_or_appointment_id","metadata":{"seo":{"title":"Get Transactions by Visit or Appointment ID","description":"Transaction filtering"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_transactions_by_visit_or_appointment_id","name":"Get Transactions by Visit or Appointment ID","isWebhook":false,"pointer":"/paths/~1timetable~1transactions~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Transactions by Visit or Appointment ID","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":"payments/get_transactions_by_visit_or_appointment_id/request/transaction-filtering","deepLinkHash":"/payments/get_transactions_by_visit_or_appointment_id#payments/get_transactions_by_visit_or_appointment_id/request/transaction-filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"+"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"record_id: Appointment ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visit_id: ID of the visit"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1timetable~1transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"record_id","in":"query","schemaId":"schema_280","description":"Appointment ID","example":0},{"name":"visit_id","in":"query","schemaId":"schema_280","description":"Visit ID","example":0}],"pointer":"/paths/~1timetable~1transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1timetable~1transactions~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/timetable/transactions/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"record_id","in":"query","example":0,"schemaId":"schema_280"},{"name":"visit_id","in":"query","example":0,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/timetable/transactions/{location_id}","href":"payments/get_transactions_by_visit_or_appointment_id","openApiOperationId":"get_transactions_by_visit_or_appointment_id","summary":"Get Transactions by Visit or Appointment ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/transaction_companyid_response_data_types","exampleIds":["paths/~1timetable~1transactions~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1timetable~1transactions~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/~1timetable~1transactions~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1timetable~1transactions~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1timetable~1transactions~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":"/payments/get_transactions_by_visit_or_appointment_id"}],"panels":[]}]},"httpPath":"/timetable/transactions/{location_id}"},{"label":"Create a Financial Transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/create_financial_transaction","routeSlug":"/en/b2b-v1/openapi/payments/create_financial_transaction","metadata":{"seo":{"title":"Create a Financial Transaction","description":"Create a Financial Transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_financial_transaction","name":"Create a Financial Transaction","isWebhook":false,"pointer":"/paths/~1finance_transactions~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Financial Transaction","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1finance_transactions~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1finance_transactions~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/finance_transaction_request_data_types"}},"schemaId":"components/schemas/finance_transaction_request_data_types","pointer":"/paths/~1finance_transactions~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/finance_transactions/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/finance_transaction_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/finance_transactions/{location_id}","href":"payments/create_financial_transaction","openApiOperationId":"create_financial_transaction","summary":"Create a Financial Transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/finance_transaction_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/finance_transaction_request_data_types"}},"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/finance_transaction_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/finance_transaction_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}/post/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/~1finance_transactions~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/finance_transaction_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/finance_transaction_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}/post/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":"/payments/create_financial_transaction"}],"panels":[]}]},"httpPath":"/finance_transactions/{location_id}"},{"label":"Getting a financial transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/get_financial_transaction","routeSlug":"/en/b2b-v1/openapi/payments/get_financial_transaction","metadata":{"seo":{"title":"Getting a financial transaction","description":"Getting a financial transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_financial_transaction","name":"Getting a financial transaction","isWebhook":false,"pointer":"/paths/~1finance_transactions~1{location_id}~1{transaction_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting a financial transaction","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"transaction_id","in":"path","schemaId":"schema_280","description":"transaction ID","required":true}],"pointer":"/paths/~1finance_transactions~1{location_id}~1{transaction_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1finance_transactions~1{location_id}~1{transaction_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/finance_transactions/{location_id}/{transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/finance_transactions/{location_id}/{transaction_id}","href":"payments/get_financial_transaction","openApiOperationId":"get_financial_transaction","summary":"Getting a financial transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_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/~1finance_transactions~1{location_id}~1{transaction_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_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":"/payments/get_financial_transaction"}],"panels":[]}]},"httpPath":"/finance_transactions/{location_id}/{transaction_id}"},{"label":"Financial Transaction Update","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/update_financial_transaction","routeSlug":"/en/b2b-v1/openapi/payments/update_financial_transaction","metadata":{"seo":{"title":"Financial Transaction Update","description":"Financial Transaction Update"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_financial_transaction","name":"Financial Transaction Update","isWebhook":false,"pointer":"/paths/~1finance_transactions~1{location_id}~1{transaction_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Financial Transaction Update","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"transaction_id","in":"path","schemaId":"schema_280","description":"transaction ID","required":true}],"pointer":"/paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1finance_transactions~1{location_id}~1{transaction_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/finance_transaction_request_data_types"}},"schemaId":"components/schemas/finance_transaction_request_data_types","pointer":"/paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/finance_transactions/{location_id}/{transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/finance_transaction_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/finance_transactions/{location_id}/{transaction_id}","href":"payments/update_financial_transaction","openApiOperationId":"update_financial_transaction","summary":"Financial Transaction Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/finance_transaction_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/finance_transaction_request_data_types"}},"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/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/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/~1finance_transactions~1{location_id}~1{transaction_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transaction_companyid_response_data_types","exampleIds":["paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/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":"/payments/update_financial_transaction"}],"panels":[]}]},"httpPath":"/finance_transactions/{location_id}/{transaction_id}"},{"label":"Deleting a transaction","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/payments/delete_financial_transaction","routeSlug":"/en/b2b-v1/openapi/payments/delete_financial_transaction","metadata":{"seo":{"title":"Deleting a transaction","description":"Deleting a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_financial_transaction","name":"Deleting a transaction","isWebhook":false,"pointer":"/paths/~1finance_transactions~1{location_id}~1{transaction_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting a transaction","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"transaction_id","in":"path","schemaId":"schema_280","description":"transaction ID","required":true}],"pointer":"/paths/~1finance_transactions~1{location_id}~1{transaction_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1finance_transactions~1{location_id}~1{transaction_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/finance_transactions/{location_id}/{transaction_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["202","401","403","404"],"pointer":"/finance_transactions/{location_id}/{transaction_id}","href":"payments/delete_financial_transaction","openApiOperationId":"delete_financial_transaction","summary":"Deleting a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"202","description":"Accepted"},{"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/~1finance_transactions~1{location_id}~1{transaction_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"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":"/payments/delete_financial_transaction"}],"panels":[]}]},"httpPath":"/finance_transactions/{location_id}/{transaction_id}"}],"content":{"contentType":"group","meta":{"name":"Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","showPageActions":true},{"nodeType":"markdoc","content":"Payment processing, accounts, and KKM transactions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/storage_operations/documents/finance_transactions/{document_id}","summary":"Get document financial transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_document_financial_transactions","deprecated":false},{"title":"/accounts/{location_id}","summary":"Get location accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_account_list","deprecated":false},{"title":"/transactions/{location_id}","summary":"Get transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_transactions","deprecated":false},{"title":"/timetable/transactions/{location_id}","summary":"Get Transactions by Visit or Appointment ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_transactions_by_visit_or_appointment_id","deprecated":false},{"title":"/finance_transactions/{location_id}","summary":"Create a Financial Transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/create_financial_transaction","deprecated":false},{"title":"/finance_transactions/{location_id}/{transaction_id}","summary":"Getting a financial transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/get_financial_transaction","deprecated":false},{"title":"/finance_transactions/{location_id}/{transaction_id}","summary":"Financial Transaction Update","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/update_financial_transaction","deprecated":false},{"title":"/finance_transactions/{location_id}/{transaction_id}","summary":"Deleting a transaction","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payments/delete_financial_transaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Notifications","link":"/en/b2b-v1/openapi/notifications","routeSlug":"/en/b2b-v1/openapi/notifications","items":[{"label":"Send SMS to the list of clients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/send_sms_to_clients","routeSlug":"/en/b2b-v1/openapi/notifications/send_sms_to_clients","metadata":{"seo":{"title":"Send SMS to the list of clients","description":"The object for creating SMS mailing has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"send_sms_to_clients","name":"Send SMS to the list of clients","isWebhook":false,"pointer":"/paths/~1sms~1clients~1by_id~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send SMS to the list of clients","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":"The object for creating SMS mailing has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of numbers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of client IDs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS text message"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1sms~1clients~1by_id~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1sms~1clients~1by_id~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_request_data_types"}},"schemaId":"components/schemas/sms_clients_by_id_request_data_types","pointer":"/paths/~1sms~1clients~1by_id~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sms/clients/by_id/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_request_data_types"}},"responseCodes":["201","202","401","402","403","404","422"],"pointer":"/sms/clients/by_id/{location_id}","href":"notifications/send_sms_to_clients","openApiOperationId":"send_sms_to_clients","summary":"Send SMS to the list of clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/sms_clients_by_id_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_request_data_types"}},"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/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"]},{"code":"202","description":"Accepted - SMS mailing queued for delivery","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/post/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/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":"402","description":"Payment Required - Insufficient funds","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344"},{"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"},{"code":"422","description":"Unprocessable Entity - validation errors or insufficient funds","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/~1sms~1clients~1by_id~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"]}}},{"code":"202","schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_id~1{location_id}/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":"402","schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_344"}}},{"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"}}},{"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":"/notifications/send_sms_to_clients"}],"panels":[]}]},"httpPath":"/sms/clients/by_id/{location_id}"},{"label":"Send SMS campaigns to customers matching the filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/send_sms_campaign_to_filtered_clients","routeSlug":"/en/b2b-v1/openapi/notifications/send_sms_campaign_to_filtered_clients","metadata":{"seo":{"title":"Send SMS campaigns to customers matching the filters","description":"The object for creating SMS mailing has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"send_sms_campaign_to_filtered_clients","name":"Send SMS campaigns to customers matching the filters","isWebhook":false,"pointer":"/paths/~1sms~1clients~1by_filter~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send SMS campaigns to customers matching the filters","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":"The object for creating SMS mailing has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SMS text message"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"notifications/send_sms_campaign_to_filtered_clients/request/client-filtering","deepLinkHash":"/notifications/send_sms_campaign_to_filtered_clients#notifications/send_sms_campaign_to_filtered_clients/request/client-filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client filtering"},"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":"fullname:'Joh' (optional, string) - Name (part of name) to filter clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone:'1315' (optional, string) - Phone (part of the number) to filter clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email:'test@' (optional, string) - Email (part) for client filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card:'5663rt' (optional, string) - Card (part) to filter customers by loyalty card number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attention: If there are no filters, SMS mailing will go to the entire database!"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1sms~1clients~1by_filter~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fullname","in":"query","schemaId":"schema_279","description":"Name (part of the name) for client filtering","example":"'Joh'"},{"name":"phone","in":"query","schemaId":"schema_279","description":"Phone (part of the number) for customer filtering","example":"'1315'"},{"name":"email","in":"query","schemaId":"schema_279","description":"Email (part) for customer filtering","example":"'test@'"}],"pointer":"/paths/~1sms~1clients~1by_filter~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1sms~1clients~1by_filter~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sms_clients_by_filter_request_data_types"}},"schemaId":"components/schemas/sms_clients_by_filter_request_data_types","pointer":"/paths/~1sms~1clients~1by_filter~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sms/clients/by_filter/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"fullname","in":"query","example":"'Joh'","schemaId":"schema_279"},{"name":"phone","in":"query","example":"'1315'","schemaId":"schema_279"},{"name":"email","in":"query","example":"'test@'","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/sms_clients_by_filter_request_data_types"}},"responseCodes":["201","202","401","403","404"],"pointer":"/sms/clients/by_filter/{location_id}","href":"notifications/send_sms_campaign_to_filtered_clients","openApiOperationId":"send_sms_campaign_to_filtered_clients","summary":"Send SMS campaigns to customers matching the filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/sms_clients_by_filter_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/sms_clients_by_filter_request_data_types"}},"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/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"]},{"code":"202","description":"Accepted - SMS campaign queued for delivery","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/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/~1sms~1clients~1by_filter~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"]}}},{"code":"202","schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1sms~1clients~1by_filter~1{location_id}/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":"/notifications/send_sms_campaign_to_filtered_clients"}],"panels":[]}]},"httpPath":"/sms/clients/by_filter/{location_id}"},{"label":"Send Email newsletter according to the list of clients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/send_email_newsletter_to_clients","routeSlug":"/en/b2b-v1/openapi/notifications/send_email_newsletter_to_clients","metadata":{"seo":{"title":"Send Email newsletter according to the list of clients","description":"The object for creating an Email campaign has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"send_email_newsletter_to_clients","name":"Send Email newsletter according to the list of clients","isWebhook":false,"pointer":"/paths/~1email~1clients~1by_id~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send Email newsletter according to the list of clients","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":"The object for creating an Email campaign has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client_ids"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of numbers"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of client IDs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text Email Message"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subject"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Subject"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1email~1clients~1by_id~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1email~1clients~1by_id~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/email_clients_by_id_request_data_types"}},"schemaId":"components/schemas/email_clients_by_id_request_data_types","pointer":"/paths/~1email~1clients~1by_id~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/email/clients/by_id/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/email_clients_by_id_request_data_types"}},"responseCodes":["201","401","403","404"],"pointer":"/email/clients/by_id/{location_id}","href":"notifications/send_email_newsletter_to_clients","openApiOperationId":"send_email_newsletter_to_clients","summary":"Send Email newsletter according to the list of clients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/email_clients_by_id_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/email_clients_by_id_request_data_types"}},"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/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_id~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/~1email~1clients~1by_id~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_id~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":"/notifications/send_email_newsletter_to_clients"}],"panels":[]}]},"httpPath":"/email/clients/by_id/{location_id}"},{"label":"Send email campaigns for clients matching the filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/send_email_campaign_to_filtered_clients","routeSlug":"/en/b2b-v1/openapi/notifications/send_email_campaign_to_filtered_clients","metadata":{"seo":{"title":"Send email campaigns for clients matching the filters","description":"The object for creating an Email campaign has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"send_email_campaign_to_filtered_clients","name":"Send email campaigns for clients matching the filters","isWebhook":false,"pointer":"/paths/~1email~1clients~1by_filter~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send email campaigns for clients matching the filters","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":"The object for creating an Email campaign has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"text"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text Email Message"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subject"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email Subject"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"notifications/send_email_campaign_to_filtered_clients/request/client-filtering","deepLinkHash":"/notifications/send_email_campaign_to_filtered_clients#notifications/send_email_campaign_to_filtered_clients/request/client-filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client filtering"},"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":"fullname:'Joh' (optional, string) - Name (part of name) to filter clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"phone:'1315' (optional, string) - Phone (part of the number) to filter clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"email:'test@' (optional, string) - Email (part) for client filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"card:'5663rt' (optional, string) - Card (part) to filter customers by loyalty card number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attention: If there are no filters, email distribution will go to the entire database!"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1email~1clients~1by_filter~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fullname","in":"query","schemaId":"schema_279","description":"Name (part of the name) for client filtering","example":"'Joh'"},{"name":"phone","in":"query","schemaId":"schema_279","description":"Phone (part of the number) for customer filtering","example":"'1315'"},{"name":"email","in":"query","schemaId":"schema_279","description":"Email (part) for customer filtering","example":"'test@'"}],"pointer":"/paths/~1email~1clients~1by_filter~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1email~1clients~1by_filter~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/email_clients_by_filter_request_data_types"}},"schemaId":"components/schemas/email_clients_by_filter_request_data_types","pointer":"/paths/~1email~1clients~1by_filter~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/email/clients/by_filter/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"fullname","in":"query","example":"'Joh'","schemaId":"schema_279"},{"name":"phone","in":"query","example":"'1315'","schemaId":"schema_279"},{"name":"email","in":"query","example":"'test@'","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/email_clients_by_filter_request_data_types"}},"responseCodes":["201","401","403","404"],"pointer":"/email/clients/by_filter/{location_id}","href":"notifications/send_email_campaign_to_filtered_clients","openApiOperationId":"send_email_campaign_to_filtered_clients","summary":"Send email campaigns for clients matching the filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/email_clients_by_filter_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/email_clients_by_filter_request_data_types"}},"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/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_filter~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/~1email~1clients~1by_filter~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sms_clients_by_id_response_data_types","exampleIds":["paths/~1email~1clients~1by_filter~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":"/notifications/send_email_campaign_to_filtered_clients"}],"panels":[]}]},"httpPath":"/email/clients/by_filter/{location_id}"},{"label":"Getting Message Statuses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/get_message_status_list","routeSlug":"/en/b2b-v1/openapi/notifications/get_message_status_list","metadata":{"seo":{"title":"Getting Message Statuses","description":"Get message statuses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_message_status_list","name":"Getting Message Statuses","isWebhook":false,"pointer":"/paths/~1delivery~1status/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting Message Statuses","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":3,"id":"notifications/get_message_status_list/request/get-message-statuses","deepLinkHash":"/notifications/get_message_status_list#notifications/get_message_status_list/request/get-message-statuses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get message statuses"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not delivered"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent to phone"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transferred to the operator"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"16"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejected by operator"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"52"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not enough funds"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the event of an error, the corresponding HTTP status code is returned. In some cases, a descriptive error message is also included in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following error codes may be returned by all API methods:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"error code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Http status code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ENTITY_VALIDATION_ERROR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request body did not pass validation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FIELD_VALIDATION_ERROR"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter not validated"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCESS_FORBIDDEN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action is not available, the application does not have the required permissions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_PARTNER_TOKEN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partner_token missing or invalid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RESOURCE_NOT_FOUND"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource at the requested path does not exist"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending SMS, the delivery_callback_url attribute is passed in the request - this is the url to which message statuses should be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use it to send message statuses. Url to which message statuses should be sent - https://app.alteg.io/smsprovider/status/callback/{partner_token}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1delivery~1status/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/delivery_status_request_data_types"}},"schemaId":"components/schemas/delivery_status_request_data_types","pointer":"/paths/~1delivery~1status/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/delivery/status","servers":[{"url":"/_mock/en/b2b-v1/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_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/delivery_status_request_data_types"}},"responseCodes":["200","400","401","404"],"pointer":"/delivery/status","href":"notifications/get_message_status_list","openApiOperationId":"get_message_status_list","summary":"Getting Message Statuses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/delivery_status_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/delivery_status_request_data_types"}},"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":{"exampleIds":["paths/~1delivery~1status/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1delivery~1status/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1delivery~1status/post/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1delivery~1status/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1delivery~1status/post/responses/401/content/application~1json/example"]}},"exampleIds":["paths/~1delivery~1status/post/responses/401/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1delivery~1status/post/responses/404/content/application~1json/example"]}},"exampleIds":["paths/~1delivery~1status/post/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1delivery~1status/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1delivery~1status/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1delivery~1status/post/responses/200/content/application~1json/example"]}}},{"code":"400","exampleIds":["paths/~1delivery~1status/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1delivery~1status/post/responses/400/content/application~1json/example"]}}},{"code":"401","exampleIds":["paths/~1delivery~1status/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1delivery~1status/post/responses/401/content/application~1json/example"]}}},{"code":"404","exampleIds":["paths/~1delivery~1status/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1delivery~1status/post/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notifications/get_message_status_list"}],"panels":[]}]},"httpPath":"/delivery/status"},{"label":"Get notification settings in a location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/get_location_notification_settings","routeSlug":"/en/b2b-v1/openapi/notifications/get_location_notification_settings","metadata":{"seo":{"title":"Get notification settings in a location","description":"The method allows you to get notification settings in a location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_notification_settings","name":"Get notification settings in a location","isWebhook":false,"pointer":"/paths/~1notification_settings~1{location_id}~1notification_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notification settings in a location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get notification settings in a location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1notification_settings~1{location_id}~1notification_types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer bearer_token, USer user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1notification_settings~1{location_id}~1notification_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification_settings/{location_id}/notification_types","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/notification_settings/{location_id}/notification_types","href":"notifications/get_location_notification_settings","openApiOperationId":"get_location_notification_settings","summary":"Get notification settings in a location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/notification_settings_notification_types_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1notification_types/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/notification_settings_notification_types_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1notification_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/~1notification_settings~1{location_id}~1notification_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/notification_settings_notification_types_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1notification_types/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notification_settings_notification_types_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1notification_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":"/notifications/get_location_notification_settings"}],"panels":[]}]},"httpPath":"/notification_settings/{location_id}/notification_types"},{"label":"Get User Notification Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/get_user_notification_settings","routeSlug":"/en/b2b-v1/openapi/notifications/get_user_notification_settings","metadata":{"seo":{"title":"Get User Notification Settings","description":"The method allows you to get notification settings for a particular location user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_user_notification_settings","name":"Get User Notification Settings","isWebhook":false,"pointer":"/paths/~1notification_settings~1{location_id}~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User Notification Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get notification settings for a particular location user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"user_id","in":"path","schemaId":"schema_280","description":"User ID","required":true}],"pointer":"/paths/~1notification_settings~1{location_id}~1users~1{user_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer bearer_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1notification_settings~1{location_id}~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification_settings/{location_id}/users/{user_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/notification_settings/{location_id}/users/{user_id}","href":"notifications/get_user_notification_settings","openApiOperationId":"get_user_notification_settings","summary":"Get User Notification Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_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/~1notification_settings~1{location_id}~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_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":"/notifications/get_user_notification_settings"}],"panels":[]}]},"httpPath":"/notification_settings/{location_id}/users/{user_id}"},{"label":"Change User Push Notification Settings","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/notifications/update_user_notification_settings","routeSlug":"/en/b2b-v1/openapi/notifications/update_user_notification_settings","metadata":{"seo":{"title":"Change User Push Notification Settings","description":"The method allows you to change the user's PUSH notification settings.The type of notification to be changed (record_create_online_staff or record_create_online_admin, etc.) should be selected based on the type of notification specified by the user (mode: admin or mode: team_member). Note: 'staff' in notification type names is a legacy term for team member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_user_notification_settings","name":"Change User Push Notification Settings","isWebhook":false,"pointer":"/paths/~1notification_settings~1{location_id}~1users~1{user_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change User Push Notification Settings","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":"The method allows you to change the user's PUSH notification settings."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of notification to be changed (record_create_online_staff or record_create_online_admin, etc.) should be selected based on the type of notification specified by the user (mode: admin or mode: team_member). Note: 'staff' in notification type names is a legacy term for team member."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"user_id","in":"path","schemaId":"schema_280","description":"User ID","required":true}],"pointer":"/paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer bearer_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification_settings_users_request_data_type"}},"schemaId":"components/schemas/notification_settings_users_request_data_type","pointer":"/paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notification_settings/{location_id}/users/{user_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/notification_settings_users_request_data_type"}},"responseCodes":["200","401","403","404"],"pointer":"/notification_settings/{location_id}/users/{user_id}","href":"notifications/update_user_notification_settings","openApiOperationId":"update_user_notification_settings","summary":"Change User Push Notification Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/notification_settings_users_request_data_type","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/notification_settings_users_request_data_type"}},"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/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/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/~1notification_settings~1{location_id}~1users~1{user_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/notification_settings_users_data_type","exampleIds":["paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/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":"/notifications/update_user_notification_settings"}],"panels":[]}]},"httpPath":"/notification_settings/{location_id}/users/{user_id}"}],"content":{"contentType":"group","meta":{"name":"Notifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notifications","showPageActions":true},{"nodeType":"markdoc","content":"SMS and email notifications to clients"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sms/clients/by_id/{location_id}","summary":"Send SMS to the list of clients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/send_sms_to_clients","deprecated":false},{"title":"/sms/clients/by_filter/{location_id}","summary":"Send SMS campaigns to customers matching the filters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/send_sms_campaign_to_filtered_clients","deprecated":false},{"title":"/email/clients/by_id/{location_id}","summary":"Send Email newsletter according to the list of clients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/send_email_newsletter_to_clients","deprecated":false},{"title":"/email/clients/by_filter/{location_id}","summary":"Send email campaigns for clients matching the filters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/send_email_campaign_to_filtered_clients","deprecated":false},{"title":"/delivery/status","summary":"Getting Message Statuses","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/get_message_status_list","deprecated":false},{"title":"/notification_settings/{location_id}/notification_types","summary":"Get notification settings in a location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_location_notification_settings","deprecated":false},{"title":"/notification_settings/{location_id}/users/{user_id}","summary":"Get User Notification Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notifications/get_user_notification_settings","deprecated":false},{"title":"/notification_settings/{location_id}/users/{user_id}","summary":"Change User Push Notification Settings","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notifications/update_user_notification_settings","deprecated":false}]}]}]}]}},{"type":"group","label":"Online Booking Settings","link":"/en/b2b-v1/openapi/online-booking-settings","routeSlug":"/en/b2b-v1/openapi/online-booking-settings","items":[{"label":"Get Online Booking Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/get_online_booking_settings","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/get_online_booking_settings","metadata":{"seo":{"title":"Get Online Booking Settings","description":"Get Online Booking Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_online_booking_settings","name":"Get Online Booking Settings","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1settings~1online/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Online Booking 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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1online/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1online/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/settings/online","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/settings/online","href":"online-booking-settings/get_online_booking_settings","openApiOperationId":"get_online_booking_settings","summary":"Get Online Booking Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Online Booking Settings Data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/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/~1company~1{location_id}~1settings~1online/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/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":"/online-booking-settings/get_online_booking_settings"}],"panels":[]}]},"httpPath":"/company/{location_id}/settings/online"},{"label":"Update Online Booking Settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/update_online_booking_settings","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/update_online_booking_settings","metadata":{"seo":{"title":"Update Online Booking Settings","description":"Update Online Booking Settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_online_booking_settings","name":"Update Online Booking Settings","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1settings~1online/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Online Booking 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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1online/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1settings~1online/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_update_online_settings_data_types"}},"schemaId":"components/schemas/company_update_online_settings_data_types","pointer":"/paths/~1company~1{location_id}~1settings~1online/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/company/{location_id}/settings/online","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/company_update_online_settings_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/settings/online","href":"online-booking-settings/update_online_booking_settings","openApiOperationId":"update_online_booking_settings","summary":"Update Online Booking Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/company_update_online_settings_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/company_update_online_settings_data_types"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated online booking settings data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/patch/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/~1company~1{location_id}~1settings~1online/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_get_online_settings_response_data_types","exampleIds":["paths/~1company~1{location_id}~1settings~1online/patch/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":"/online-booking-settings/update_online_booking_settings"}],"panels":[]}]},"httpPath":"/company/{location_id}/settings/online"},{"label":"Get timeslot settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/get_timeslot_settings","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/get_timeslot_settings","metadata":{"seo":{"title":"Get timeslot settings","description":"Retrieves the timeslot configuration for online booking at a location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_timeslot_settings","name":"Get timeslot settings","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1settings~1timeslots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get timeslot settings","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 timeslot configuration for online booking at a location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timeslot settings control how available booking times are displayed to clients:"},"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":"Grid type (predefined, schedule-based, or dynamic)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available time range"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Step interval between slots"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before nearest available slot"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-weekday and per-date overrides"},"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":"Timeslot values are in seconds from midnight"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., 7200 = 02:00, 50400 = 14:00)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true,"example":720441}],"pointer":"/paths/~1company~1{location_id}~1settings~1timeslots/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1settings~1timeslots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/settings/timeslots","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":720441,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/settings/timeslots","href":"online-booking-settings/get_timeslot_settings","openApiOperationId":"get_timeslot_settings","summary":"Get timeslot settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Timeslot settings retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_345","exampleIds":["paths/~1company~1{location_id}~1settings~1timeslots/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_345","exampleIds":["paths/~1company~1{location_id}~1settings~1timeslots/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1company~1{location_id}~1settings~1timeslots/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_345","exampleIds":["paths/~1company~1{location_id}~1settings~1timeslots/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_345","exampleIds":["paths/~1company~1{location_id}~1settings~1timeslots/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/online-booking-settings/get_timeslot_settings"}],"panels":[]}]},"httpPath":"/company/{location_id}/settings/timeslots"},{"label":"Get a list of booking widgets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/get_booking_widget_list","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/get_booking_widget_list","metadata":{"seo":{"title":"Get a list of booking widgets","description":"Get a list of booking widgets"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_booking_widget_list","name":"Get a list of booking widgets","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1booking_forms/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of booking widgets","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/booking_forms","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/booking_forms","href":"online-booking-settings/get_booking_widget_list","openApiOperationId":"get_booking_widget_list","summary":"Get a list of booking widgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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 letterforms","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_list_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/booking_form_list_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/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/~1company~1{location_id}~1booking_forms/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/booking_form_list_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_list_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/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":"/online-booking-settings/get_booking_widget_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/booking_forms"},{"label":"Create a Booking Widget","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/create_booking_widget","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/create_booking_widget","metadata":{"seo":{"title":"Create a Booking Widget","description":"Create a Booking Widget"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_booking_widget","name":"Create a Booking Widget","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1booking_forms/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Booking Widget","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookform_create_request"}},"schemaId":"components/schemas/bookform_create_request","pointer":"/paths/~1company~1{location_id}~1booking_forms/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/booking_forms","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/bookform_create_request"}},"responseCodes":["201","401","403","404"],"pointer":"/company/{location_id}/booking_forms","href":"online-booking-settings/create_booking_widget","openApiOperationId":"create_booking_widget","summary":"Create a Booking Widget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/bookform_create_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookform_create_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"appointment Widget Settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/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/~1company~1{location_id}~1booking_forms/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms/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":"/online-booking-settings/create_booking_widget"}],"panels":[]}]},"httpPath":"/company/{location_id}/booking_forms"},{"label":"Get a Booking Widget","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/get_booking_widget","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/get_booking_widget","metadata":{"seo":{"title":"Get a Booking Widget","description":"Get a Booking Widget"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_booking_widget","name":"Get a Booking Widget","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Booking Widget","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"form_id","in":"path","schemaId":"schema_280","description":"appointment widget ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/booking_forms/{form_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"form_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/booking_forms/{form_id}","href":"online-booking-settings/get_booking_widget","openApiOperationId":"get_booking_widget","summary":"Get a Booking Widget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"appointment Widget Settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_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/~1company~1{location_id}~1booking_forms~1{form_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_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":"/online-booking-settings/get_booking_widget"}],"panels":[]}]},"httpPath":"/company/{location_id}/booking_forms/{form_id}"},{"label":"Delete Booking Widget","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/delete_booking_widget","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/delete_booking_widget","metadata":{"seo":{"title":"Delete Booking Widget","description":"Delete Booking Widget"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_booking_widget","name":"Delete Booking Widget","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Booking Widget","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"form_id","in":"path","schemaId":"schema_280","description":"appointment widget ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/company/{location_id}/booking_forms/{form_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"form_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/company/{location_id}/booking_forms/{form_id}","href":"online-booking-settings/delete_booking_widget","openApiOperationId":"delete_booking_widget","summary":"Delete Booking Widget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1company~1{location_id}~1booking_forms~1{form_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/online-booking-settings/delete_booking_widget"}],"panels":[]}]},"httpPath":"/company/{location_id}/booking_forms/{form_id}"},{"label":"Change Booking Widget","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/online-booking-settings/update_booking_widget","routeSlug":"/en/b2b-v1/openapi/online-booking-settings/update_booking_widget","metadata":{"seo":{"title":"Change Booking Widget","description":"Change Booking Widget"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_booking_widget","name":"Change Booking Widget","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change Booking Widget","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"form_id","in":"path","schemaId":"schema_280","description":"appointment widget ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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},{"name":"Authorization","in":"header","schemaId":"schema_279","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},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true}],"pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookform_update_request"}},"schemaId":"components/schemas/bookform_update_request","pointer":"/paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/company/{location_id}/booking_forms/{form_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"form_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/bookform_update_request"}},"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/booking_forms/{form_id}","href":"online-booking-settings/update_booking_widget","openApiOperationId":"update_booking_widget","summary":"Change Booking Widget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/bookform_update_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/bookform_update_request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"appointment Widget Settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/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/~1company~1{location_id}~1booking_forms~1{form_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/booking_form_response_data_type","exampleIds":["paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/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":"/online-booking-settings/update_booking_widget"}],"panels":[]}]},"httpPath":"/company/{location_id}/booking_forms/{form_id}"}],"content":{"contentType":"group","meta":{"name":"Online Booking Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Online Booking Settings","showPageActions":true},{"nodeType":"markdoc","content":"Configure online booking behavior and forms"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company/{location_id}/settings/online","summary":"Get Online Booking Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/online-booking-settings/get_online_booking_settings","deprecated":false},{"title":"/company/{location_id}/settings/online","summary":"Update Online Booking Settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/online-booking-settings/update_online_booking_settings","deprecated":false},{"title":"/company/{location_id}/settings/timeslots","summary":"Get timeslot settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/online-booking-settings/get_timeslot_settings","deprecated":false},{"title":"/company/{location_id}/booking_forms","summary":"Get a list of booking widgets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/online-booking-settings/get_booking_widget_list","deprecated":false},{"title":"/company/{location_id}/booking_forms","summary":"Create a Booking Widget","prefix":{"name":"post","color":"post"},"badges":[],"link":"/online-booking-settings/create_booking_widget","deprecated":false},{"title":"/company/{location_id}/booking_forms/{form_id}","summary":"Get a Booking Widget","prefix":{"name":"get","color":"get"},"badges":[],"link":"/online-booking-settings/get_booking_widget","deprecated":false},{"title":"/company/{location_id}/booking_forms/{form_id}","summary":"Delete Booking Widget","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/online-booking-settings/delete_booking_widget","deprecated":false},{"title":"/company/{location_id}/booking_forms/{form_id}","summary":"Change Booking Widget","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/online-booking-settings/update_booking_widget","deprecated":false}]}]}]}]}},{"type":"separator","label":"Administrative","content":null},{"type":"group","label":"Analytics & Reports","link":"/en/b2b-v1/openapi/analytics-and-reports","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports","items":[{"label":"Get key location metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_overall","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_overall","metadata":{"seo":{"title":"Get key location metrics","description":"The method allows you to get the main indicators of the location for the selected period and compare with the previous period of the same duration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_analytics_overall","name":"Get key location metrics","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1overall/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get key location metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get the main indicators of the location for the selected period and compare with the previous period of the same duration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_323","description":"Start date of the analyzed period","required":true},{"name":"date_to","in":"query","schemaId":"schema_323","description":"End date of the analyzed period (included in the report)","required":true},{"name":"team_member_id","in":"query","schemaId":"schema_286","description":"ID of the location team member whose work needs to be analyzed"},{"name":"position_id","in":"query","schemaId":"schema_286","description":"location position ID to analyze the work of all team members belonging to the same position"},{"name":"user_id","in":"query","schemaId":"schema_286","description":"The user ID of the location whose work you want to analyze"}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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{location_id}~1analytics~1overall/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/overall","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_from","in":"query","required":true,"schemaId":"schema_323"},{"name":"date_to","in":"query","required":true,"schemaId":"schema_323"},{"name":"team_member_id","in":"query","schemaId":"schema_286"},{"name":"position_id","in":"query","schemaId":"schema_286"},{"name":"user_id","in":"query","schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/overall","href":"analytics-and-reports/get_location_analytics_overall","openApiOperationId":"get_location_analytics_overall","summary":"Get key location metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Basic indicators","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_analytics_overall_data_type"}},"schemaId":"components/schemas/company_analytics_overall_data_type"},{"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/~1company~1{location_id}~1analytics~1overall/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_analytics_overall_data_type","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_analytics_overall_data_type"}}},{"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":"/analytics-and-reports/get_location_analytics_overall"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/overall"},{"label":"Get occupancy data by day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_occupancy_daily","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_occupancy_daily","metadata":{"seo":{"title":"Get occupancy data by day","description":"Get occupancy data by day"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_analytics_occupancy_daily","name":"Get occupancy data by day","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get occupancy data by day","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_323","description":"Start date of the analyzed period","required":true},{"name":"date_to","in":"query","schemaId":"schema_323","description":"End date of the analyzed period (included in the report)","required":true},{"name":"team_member_id","in":"query","schemaId":"schema_286","description":"ID of the location team member whose work needs to be analyzed"},{"name":"user_id","in":"query","schemaId":"schema_286","description":"The user ID of the location whose work you want to analyze"}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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{location_id}~1analytics~1overall~1charts~1fullness_daily/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/overall/charts/fullness_daily","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_from","in":"query","required":true,"schemaId":"schema_323"},{"name":"date_to","in":"query","required":true,"schemaId":"schema_323"},{"name":"team_member_id","in":"query","schemaId":"schema_286"},{"name":"user_id","in":"query","schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/overall/charts/fullness_daily","href":"analytics-and-reports/get_location_analytics_occupancy_daily","openApiOperationId":"get_location_analytics_occupancy_daily","summary":"Get occupancy data by day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Occupancy by day","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/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/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/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":"/analytics-and-reports/get_location_analytics_occupancy_daily"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/overall/charts/fullness_daily"},{"label":"Get data on revenue by day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_revenue_daily","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_revenue_daily","metadata":{"seo":{"title":"Get data on revenue by day","description":"Get data on revenue by day"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_analytics_revenue_daily","name":"Get data on revenue by day","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get data on revenue by day","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_323","description":"Start date of the analyzed period","required":true},{"name":"date_to","in":"query","schemaId":"schema_323","description":"End date of the analyzed period (included in the report)","required":true},{"name":"team_member_id","in":"query","schemaId":"schema_286","description":"ID of the location team member whose work needs to be analyzed"},{"name":"position_id","in":"query","schemaId":"schema_286","description":"location position ID to analyze the work of all team members belonging to the same position"},{"name":"user_id","in":"query","schemaId":"schema_286","description":"The user ID of the location whose work you want to analyze"}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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{location_id}~1analytics~1overall~1charts~1income_daily/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/overall/charts/income_daily","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_from","in":"query","required":true,"schemaId":"schema_323"},{"name":"date_to","in":"query","required":true,"schemaId":"schema_323"},{"name":"team_member_id","in":"query","schemaId":"schema_286"},{"name":"position_id","in":"query","schemaId":"schema_286"},{"name":"user_id","in":"query","schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/overall/charts/income_daily","href":"analytics-and-reports/get_location_analytics_revenue_daily","openApiOperationId":"get_location_analytics_revenue_daily","summary":"Get data on revenue by day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Revenue by day","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/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/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/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":"/analytics-and-reports/get_location_analytics_revenue_daily"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/overall/charts/income_daily"},{"label":"Get the Structure of Appointments by Source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_appointment_analytics_by_source","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_appointment_analytics_by_source","metadata":{"seo":{"title":"Get the Structure of Appointments by Source","description":"Get the Structure of Appointments by Source"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment_analytics_by_source","name":"Get the Structure of Appointments by Source","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the Structure of Appointments by Source","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_323","description":"Start date of the analyzed period","required":true},{"name":"date_to","in":"query","schemaId":"schema_323","description":"End date of the analyzed period (included in the report)","required":true},{"name":"team_member_id","in":"query","schemaId":"schema_286","description":"ID of the location team member whose work needs to be analyzed"},{"name":"user_id","in":"query","schemaId":"schema_286","description":"The user ID of the location whose work you want to analyze"}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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{location_id}~1analytics~1overall~1charts~1record_source/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/overall/charts/record_source","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_from","in":"query","required":true,"schemaId":"schema_323"},{"name":"date_to","in":"query","required":true,"schemaId":"schema_323"},{"name":"team_member_id","in":"query","schemaId":"schema_286"},{"name":"user_id","in":"query","schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/overall/charts/record_source","href":"analytics-and-reports/get_appointment_analytics_by_source","openApiOperationId":"get_appointment_analytics_by_source","summary":"Get the Structure of Appointments by Source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Structure of appointments by sources","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/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/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/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":"/analytics-and-reports/get_appointment_analytics_by_source"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/overall/charts/record_source"},{"label":"Get the Structure of Appointments by Visit Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_appointment_analytics_by_status","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_appointment_analytics_by_status","metadata":{"seo":{"title":"Get the Structure of Appointments by Visit Status","description":"Get the Structure of Appointments by Visit Status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_appointment_analytics_by_status","name":"Get the Structure of Appointments by Visit Status","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the Structure of Appointments by Visit Status","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_323","description":"Start date of the analyzed period","required":true},{"name":"date_to","in":"query","schemaId":"schema_323","description":"End date of the analyzed period (included in the report)","required":true},{"name":"team_member_id","in":"query","schemaId":"schema_286","description":"ID of the location team member whose work needs to be analyzed"},{"name":"user_id","in":"query","schemaId":"schema_286","description":"The user ID of the location whose work you want to analyze"}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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{location_id}~1analytics~1overall~1charts~1record_status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/overall/charts/record_status","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_from","in":"query","required":true,"schemaId":"schema_323"},{"name":"date_to","in":"query","required":true,"schemaId":"schema_323"},{"name":"team_member_id","in":"query","schemaId":"schema_286"},{"name":"user_id","in":"query","schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/overall/charts/record_status","href":"analytics-and-reports/get_appointment_analytics_by_status","openApiOperationId":"get_appointment_analytics_by_status","summary":"Get the Structure of Appointments by Visit Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Structure of appointments by visit status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/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/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/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":"/analytics-and-reports/get_appointment_analytics_by_status"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/overall/charts/record_status"},{"label":"Get Data on the Number of Appointments by Day","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_appointments_daily","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_location_analytics_appointments_daily","metadata":{"seo":{"title":"Get Data on the Number of Appointments by Day","description":"Get Data on the Number of Appointments by Day"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_analytics_appointments_daily","name":"Get Data on the Number of Appointments by Day","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Data on the Number of Appointments by Day","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_323","description":"Start date of the analyzed period","required":true},{"name":"date_to","in":"query","schemaId":"schema_323","description":"End date of the analyzed period (included in the report)","required":true},{"name":"team_member_id","in":"query","schemaId":"schema_286","description":"ID of the location team member whose work needs to be analyzed"},{"name":"user_id","in":"query","schemaId":"schema_286","description":"User ID of the location whose work you want to analyze"}],"pointer":"/paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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{location_id}~1analytics~1overall~1charts~1records_daily/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/overall/charts/records_daily","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_from","in":"query","required":true,"schemaId":"schema_323"},{"name":"date_to","in":"query","required":true,"schemaId":"schema_323"},{"name":"team_member_id","in":"query","schemaId":"schema_286"},{"name":"user_id","in":"query","schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/overall/charts/records_daily","href":"analytics-and-reports/get_location_analytics_appointments_daily","openApiOperationId":"get_location_analytics_appointments_daily","summary":"Get Data on the Number of Appointments by Day"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Number of appointments by day","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/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/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/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":"/analytics-and-reports/get_location_analytics_appointments_daily"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/overall/charts/records_daily"},{"label":"Get revenue statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_loyalty_program_revenue_statistics","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_loyalty_program_revenue_statistics","metadata":{"seo":{"title":"Get revenue statistics","description":"The method allows you to get statistics on revenue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_program_revenue_statistics","name":"Get revenue statistics","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get revenue statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get statistics on revenue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_to","in":"query","schemaId":"schema_279","description":"Period end date","required":true},{"name":"date_from","in":"query","schemaId":"schema_279","description":"Period start date","required":true},{"name":"loyalty_program_id","in":"query","schemaId":"schema_279","description":"Promotion ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer bearer_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/loyalty_programs/income","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_to","in":"query","required":true,"schemaId":"schema_279"},{"name":"date_from","in":"query","required":true,"schemaId":"schema_279"},{"name":"loyalty_program_id","in":"query","required":true,"schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/loyalty_programs/income","href":"analytics-and-reports/get_loyalty_program_revenue_statistics","openApiOperationId":"get_loyalty_program_revenue_statistics","summary":"Get revenue statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_analytics_loyalty_programs_income_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_analytics_loyalty_programs_income_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/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/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_analytics_loyalty_programs_income_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_analytics_loyalty_programs_income_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/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":"/analytics-and-reports/get_loyalty_program_revenue_statistics"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/loyalty_programs/income"},{"label":"Get team member return","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_loyalty_program_team_member_statistics","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_loyalty_program_team_member_statistics","metadata":{"seo":{"title":"Get team member return","description":"The method allows you to get the return statistics for a team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_program_team_member_statistics","name":"Get team member return","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get team member return","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get the return statistics for a team member"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_to","in":"query","schemaId":"schema_279","description":"Period end date","required":true},{"name":"date_from","in":"query","schemaId":"schema_279","description":"Period start date","required":true},{"name":"loyalty_program_id","in":"query","schemaId":"schema_279","description":"Promotion ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer bearer_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/loyalty_programs/staff","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_to","in":"query","required":true,"schemaId":"schema_279"},{"name":"date_from","in":"query","required":true,"schemaId":"schema_279"},{"name":"loyalty_program_id","in":"query","required":true,"schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/loyalty_programs/staff","href":"analytics-and-reports/get_loyalty_program_team_member_statistics","openApiOperationId":"get_loyalty_program_team_member_statistics","summary":"Get team member return"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_analytics_loyalty_programs_staff_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_analytics_loyalty_programs_staff_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/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/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_analytics_loyalty_programs_staff_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_analytics_loyalty_programs_staff_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/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":"/analytics-and-reports/get_loyalty_program_team_member_statistics"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/loyalty_programs/staff"},{"label":"Get customer statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_loyalty_program_client_statistics","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_loyalty_program_client_statistics","metadata":{"seo":{"title":"Get customer statistics","description":"The method allows you to get statistics on returning, new and lost customers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_program_client_statistics","name":"Get customer statistics","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get customer statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get statistics on returning, new and lost customers"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_to","in":"query","schemaId":"schema_279","description":"Period end date","required":true},{"name":"date_from","in":"query","schemaId":"schema_279","description":"Period start date","required":true},{"name":"loyalty_program_id","in":"query","schemaId":"schema_279","description":"Promotion ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer bearer_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/analytics/loyalty_programs/visits","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"date_to","in":"query","required":true,"schemaId":"schema_279"},{"name":"date_from","in":"query","required":true,"schemaId":"schema_279"},{"name":"loyalty_program_id","in":"query","required":true,"schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/analytics/loyalty_programs/visits","href":"analytics-and-reports/get_loyalty_program_client_statistics","openApiOperationId":"get_loyalty_program_client_statistics","summary":"Get customer statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_analytics_loyalty_programs_visits_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_analytics_loyalty_programs_visits_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/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/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_analytics_loyalty_programs_visits_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_analytics_loyalty_programs_visits_data_types","exampleIds":["paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/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":"/analytics-and-reports/get_loyalty_program_client_statistics"}],"panels":[]}]},"httpPath":"/company/{location_id}/analytics/loyalty_programs/visits"},{"label":"Get day-end report data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/analytics-and-reports/get_day_end_report_data","routeSlug":"/en/b2b-v1/openapi/analytics-and-reports/get_day_end_report_data","metadata":{"seo":{"title":"Get day-end report data","description":"start_date: Report dateteam_member_id: team member ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_day_end_report_data","name":"Get day-end report data","isWebhook":false,"pointer":"/paths/~1reports~1z_report~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get day-end report data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"+"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start_date: Report date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team_member_id: team member ID"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"location ID","required":true}],"pointer":"/paths/~1reports~1z_report~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_279","description":"period start date","example":"''"},{"name":"master_id","in":"query","schemaId":"schema_286","description":"team member ID","example":0}],"pointer":"/paths/~1reports~1z_report~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1reports~1z_report~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/reports/z_report/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_286"}],"query":[{"name":"start_date","in":"query","example":"''","schemaId":"schema_279"},{"name":"master_id","in":"query","example":0,"schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/reports/z_report/{location_id}","href":"analytics-and-reports/get_day_end_report_data","openApiOperationId":"get_day_end_report_data","summary":"Get day-end report data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/z_report_response_data_types","exampleIds":["paths/~1reports~1z_report~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/z_report_response_data_types","exampleIds":["paths/~1reports~1z_report~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/~1reports~1z_report~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/z_report_response_data_types","exampleIds":["paths/~1reports~1z_report~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/z_report_response_data_types","exampleIds":["paths/~1reports~1z_report~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":"/analytics-and-reports/get_day_end_report_data"}],"panels":[]}]},"httpPath":"/reports/z_report/{location_id}"}],"content":{"contentType":"group","meta":{"name":"Analytics & Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Analytics & Reports","showPageActions":true},{"nodeType":"markdoc","content":"Business analytics, charts, and Z-reports"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company/{location_id}/analytics/overall","summary":"Get key location metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_location_analytics_overall","deprecated":false},{"title":"/company/{location_id}/analytics/overall/charts/fullness_daily","summary":"Get occupancy data by day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_location_analytics_occupancy_daily","deprecated":false},{"title":"/company/{location_id}/analytics/overall/charts/income_daily","summary":"Get data on revenue by day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_location_analytics_revenue_daily","deprecated":false},{"title":"/company/{location_id}/analytics/overall/charts/record_source","summary":"Get the Structure of Appointments by Source","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_appointment_analytics_by_source","deprecated":false},{"title":"/company/{location_id}/analytics/overall/charts/record_status","summary":"Get the Structure of Appointments by Visit Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_appointment_analytics_by_status","deprecated":false},{"title":"/company/{location_id}/analytics/overall/charts/records_daily","summary":"Get Data on the Number of Appointments by Day","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_location_analytics_appointments_daily","deprecated":false},{"title":"/company/{location_id}/analytics/loyalty_programs/income","summary":"Get revenue statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_loyalty_program_revenue_statistics","deprecated":false},{"title":"/company/{location_id}/analytics/loyalty_programs/staff","summary":"Get team member return","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_loyalty_program_team_member_statistics","deprecated":false},{"title":"/company/{location_id}/analytics/loyalty_programs/visits","summary":"Get customer statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_loyalty_program_client_statistics","deprecated":false},{"title":"/reports/z_report/{location_id}","summary":"Get day-end report data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics-and-reports/get_day_end_report_data","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/en/b2b-v1/openapi/tags","routeSlug":"/en/b2b-v1/openapi/tags","items":[{"label":"Create a Tag (Deprecated)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/tags/create_tag","routeSlug":"/en/b2b-v1/openapi/tags/create_tag","metadata":{"seo":{"title":"Create a Tag (Deprecated)","description":"Deprecated: Use POST /api/v2/companies/{company_id}/tags instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_tag","name":"Create a Tag (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1labels~1{location_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Tag (Deprecated)","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /api/v2/companies/{company_id}/tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new tag for the specified location."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1labels~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"title","in":"query","schemaId":"schema_279","description":"Name of tag","required":true},{"name":"color","in":"query","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag color in #RRGGBB format"},"children":[]}]}]}],"required":true},{"name":"entity","in":"query","schemaId":"schema_280","description":"Tag type (0 - general tags, 1 - customer tags, 2 - appointment tags)"},{"name":"icon","in":"query","schemaId":"schema_279","description":"Icon name"}],"pointer":"/paths/~1labels~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1labels~1{location_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/labels/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"title","in":"query","required":true,"schemaId":"schema_279"},{"name":"color","in":"query","required":true,"schemaId":"schema_279"},{"name":"entity","in":"query","schemaId":"schema_280"},{"name":"icon","in":"query","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","202","401","403","404"],"pointer":"/labels/{location_id}","href":"tags/create_tag","openApiOperationId":"create_tag","summary":"Create a Tag (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/tags_create_response200_data_types","exampleIds":["paths/~1labels~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/tags_create_response200_data_types","exampleIds":["paths/~1labels~1{location_id}/post/responses/200/content/application~1json/example"]},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1labels~1{location_id}/post/responses/202/content/application~1json/example"]}},"exampleIds":["paths/~1labels~1{location_id}/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/~1labels~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tags_create_response200_data_types","exampleIds":["paths/~1labels~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tags_create_response200_data_types","exampleIds":["paths/~1labels~1{location_id}/post/responses/200/content/application~1json/example"]}}},{"code":"202","exampleIds":["paths/~1labels~1{location_id}/post/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1labels~1{location_id}/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":"/tags/create_tag"}],"panels":[]}]},"httpPath":"/labels/{location_id}"},{"label":"Get location tags (Deprecated)","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/tags/get_tag_list_by_entity","routeSlug":"/en/b2b-v1/openapi/tags/get_tag_list_by_entity","metadata":{"seo":{"title":"Get location tags (Deprecated)","description":"Deprecated: Use GET /api/v2/companies/{company_id}/tags?entity={entity} instead.Returns tags for the specified entity type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_tag_list_by_entity","name":"Get location tags (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1labels~1{location_id}~1{entity}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location tags (Deprecated)","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/v2/companies/{company_id}/tags?entity={entity}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns tags for the specified entity type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter accepts string aliases:"},"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":"code","inline":true,"attributes":{"content":"common"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - common tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - client tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - appointment/record tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - activity/event tags"},"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":"Legacy support:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Numeric values ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are also accepted but string aliases are preferred."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true},{"name":"entity","in":"path","schemaId":"schema_348","description":"Tag type alias","required":true,"example":"client"}],"pointer":"/paths/~1labels~1{location_id}~1{entity}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1labels~1{location_id}~1{entity}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/labels/{location_id}/{entity}","servers":[{"url":"/_mock/en/b2b-v1/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_286"},{"name":"entity","in":"path","required":true,"example":"client","schemaId":"schema_348"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/labels/{location_id}/{entity}","href":"tags/get_tag_list_by_entity","openApiOperationId":"get_tag_list_by_entity","summary":"Get location tags (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/tags_company_entity_response200_data_types","exampleIds":["paths/~1labels~1{location_id}~1{entity}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/tags_company_entity_response200_data_types","exampleIds":["paths/~1labels~1{location_id}~1{entity}/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/~1labels~1{location_id}~1{entity}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tags_company_entity_response200_data_types","exampleIds":["paths/~1labels~1{location_id}~1{entity}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tags_company_entity_response200_data_types","exampleIds":["paths/~1labels~1{location_id}~1{entity}/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":"/tags/get_tag_list_by_entity"}],"panels":[]}]},"httpPath":"/labels/{location_id}/{entity}"},{"label":"Update Tag (Deprecated)","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/tags/update_tag_by_tag_id","routeSlug":"/en/b2b-v1/openapi/tags/update_tag_by_tag_id","metadata":{"seo":{"title":"Update Tag (Deprecated)","description":"Deprecated: Use PUT /api/v2/companies/{company_id}/tags/{tag_id} instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_tag_by_tag_id","name":"Update Tag (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1labels~1{location_id}~1{tag_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tag (Deprecated)","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /api/v2/companies/{company_id}/tags/{tag_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"tag_id","in":"path","schemaId":"schema_280","description":"Tag ID","required":true}],"pointer":"/paths/~1labels~1{location_id}~1{tag_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1labels~1{location_id}~1{tag_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tags_update_request_data_types"}},"schemaId":"components/schemas/tags_update_request_data_types","pointer":"/paths/~1labels~1{location_id}~1{tag_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/labels/{location_id}/{tag_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"tag_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/tags_update_request_data_types"}},"responseCodes":["202","401","403","404"],"pointer":"/labels/{location_id}/{tag_id}","href":"tags/update_tag_by_tag_id","openApiOperationId":"update_tag_by_tag_id","summary":"Update Tag (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/tags_update_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/tags_update_request_data_types"}},"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":{"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/put/responses/202/content/application~1json/example"]}},"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/put/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/~1labels~1{location_id}~1{tag_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/put/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/put/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":"/tags/update_tag_by_tag_id"}],"panels":[]}]},"httpPath":"/labels/{location_id}/{tag_id}"},{"label":"Delete location tag (Deprecated)","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/tags/delete_tag_by_tag_id","routeSlug":"/en/b2b-v1/openapi/tags/delete_tag_by_tag_id","metadata":{"seo":{"title":"Delete location tag (Deprecated)","description":"Deprecated: Use DELETE /api/v2/companies/{company_id}/tags/{tag_id} instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_tag_by_tag_id","name":"Delete location tag (Deprecated)","deprecated":true,"isWebhook":false,"pointer":"/paths/~1labels~1{location_id}~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete location tag (Deprecated)","isWebhook":false,"deprecated":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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /api/v2/companies/{company_id}/tags/{tag_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true},{"name":"tag_id","in":"path","schemaId":"schema_280","description":"Tag ID","required":true}],"pointer":"/paths/~1labels~1{location_id}~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1labels~1{location_id}~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/labels/{location_id}/{tag_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"tag_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","202","401","403","404"],"pointer":"/labels/{location_id}/{tag_id}","href":"tags/delete_tag_by_tag_id","openApiOperationId":"delete_tag_by_tag_id","summary":"Delete location tag (Deprecated)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/responses/200/content/application~1json/example"]},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/responses/202/content/application~1json/example"]}},"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/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/~1labels~1{location_id}~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/responses/200/content/application~1json/example"]}}},{"code":"202","exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1labels~1{location_id}~1{tag_id}/delete/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":"/tags/delete_tag_by_tag_id"}],"panels":[]}]},"httpPath":"/labels/{location_id}/{tag_id}"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Label management for categorizing entities (deprecated, use v2)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/labels/{location_id}","summary":"Create a Tag (Deprecated)","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/tags/create_tag","deprecated":true},{"title":"/labels/{location_id}/{entity}","summary":"Get location tags (Deprecated)","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/tags/get_tag_list_by_entity","deprecated":true},{"title":"/labels/{location_id}/{tag_id}","summary":"Update Tag (Deprecated)","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/tags/update_tag_by_tag_id","deprecated":true},{"title":"/labels/{location_id}/{tag_id}","summary":"Delete location tag (Deprecated)","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/tags/delete_tag_by_tag_id","deprecated":true}]}]}]}]}},{"type":"group","label":"Deposits","link":"/en/b2b-v1/openapi/deposits","routeSlug":"/en/b2b-v1/openapi/deposits","items":[{"label":"Get a List of Client Accounts by Location and Client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/deposits/get_client_account_list_by_location_and_client","routeSlug":"/en/b2b-v1/openapi/deposits/get_client_account_list_by_location_and_client","metadata":{"seo":{"title":"Get a List of Client Accounts by Location and Client","description":"Get a List of Client Accounts by Location and Client"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client_account_list_by_location_and_client","name":"Get a List of Client Accounts by Location and Client","isWebhook":false,"pointer":"/paths/~1deposits~1company~1{location_id}~1client~1{client_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Client Accounts by Location and Client","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"client_id","in":"path","schemaId":"schema_280","description":"Client ID","required":true}],"pointer":"/paths/~1deposits~1company~1{location_id}~1client~1{client_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":[]}]}]}],"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1deposits~1company~1{location_id}~1client~1{client_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deposits/company/{location_id}/client/{client_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"client_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/deposits/company/{location_id}/client/{client_id}","href":"deposits/get_client_account_list_by_location_and_client","openApiOperationId":"get_client_account_list_by_location_and_client","summary":"Get a List of Client Accounts by Location and Client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1deposits~1company~1{location_id}~1client~1{client_id}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1deposits~1company~1{location_id}~1client~1{client_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/~1deposits~1company~1{location_id}~1client~1{client_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1deposits~1company~1{location_id}~1client~1{client_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1deposits~1company~1{location_id}~1client~1{client_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":"/deposits/get_client_account_list_by_location_and_client"}],"panels":[]}]},"httpPath":"/deposits/company/{location_id}/client/{client_id}"},{"label":"Get a list of client accounts by chain and a set of filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/deposits/get_client_account_list_by_chain","routeSlug":"/en/b2b-v1/openapi/deposits/get_client_account_list_by_chain","metadata":{"seo":{"title":"Get a list of client accounts by chain and a set of filters","description":"Get a list of client accounts by chain and a set of filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client_account_list_by_chain","name":"Get a list of client accounts by chain and a set of filters","isWebhook":false,"pointer":"/paths/~1deposits~1chain~1{chain_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of client accounts by chain and a set of filters","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_280","description":"Chain ID","required":true}],"pointer":"/paths/~1deposits~1chain~1{chain_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"balance_from","in":"query","schemaId":"schema_280","description":"Minimum balance for filtering"},{"name":"balance_to","in":"query","schemaId":"schema_280","description":"Maximum balance for filtering"},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_280","description":"Number of items per page"}],"pointer":"/paths/~1deposits~1chain~1{chain_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":[]}]}]}],"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1deposits~1chain~1{chain_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deposits/chain/{chain_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"balance_from","in":"query","schemaId":"schema_280"},{"name":"balance_to","in":"query","schemaId":"schema_280"},{"name":"page","in":"query","schemaId":"schema_280"},{"name":"limit","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/deposits/chain/{chain_id}","href":"deposits/get_client_account_list_by_chain","openApiOperationId":"get_client_account_list_by_chain","summary":"Get a list of client accounts by chain and a set of filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1deposits~1chain~1{chain_id}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1deposits~1chain~1{chain_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/~1deposits~1chain~1{chain_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1deposits~1chain~1{chain_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1deposits~1chain~1{chain_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":"/deposits/get_client_account_list_by_chain"}],"panels":[]}]},"httpPath":"/deposits/chain/{chain_id}"},{"label":"Get a list of client accounts by chain and customer phone number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/deposits/get_client_account_by_chain_and_phone","routeSlug":"/en/b2b-v1/openapi/deposits/get_client_account_by_chain_and_phone","metadata":{"seo":{"title":"Get a list of client accounts by chain and customer phone number","description":"Get a list of client accounts by chain and customer phone number"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client_account_by_chain_and_phone","name":"Get a list of client accounts by chain and customer phone number","isWebhook":false,"pointer":"/paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of client accounts by chain and customer phone number","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_280","description":"Chain ID","required":true},{"name":"phone","in":"path","schemaId":"schema_280","description":"Customer phone number","required":true}],"pointer":"/paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":[]}]}]}],"example":"application/vnd.api.v2+json"}],"pointer":"/paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/deposits/chain/{chain_id}/phone/{phone}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"phone","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/deposits/chain/{chain_id}/phone/{phone}","href":"deposits/get_client_account_by_chain_and_phone","openApiOperationId":"get_client_account_by_chain_and_phone","summary":"Get a list of client accounts by chain and customer phone number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/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/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/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":"/deposits/get_client_account_by_chain_and_phone"}],"panels":[]}]},"httpPath":"/deposits/chain/{chain_id}/phone/{phone}"},{"label":"Create a client account topup operation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/deposits/create_client_account_topup_operation","routeSlug":"/en/b2b-v1/openapi/deposits/create_client_account_topup_operation","metadata":{"seo":{"title":"Create a client account topup operation","description":"Creating a transaction with a client account involves creating a document, a transaction with a client account, and a financial transaction within a single API request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_client_account_topup_operation","name":"Create a client account topup operation","isWebhook":false,"pointer":"/paths/~1deposits_operations~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a client account topup operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creating a transaction with a client account involves creating a document, a transaction with a client account, and a financial transaction within a single API request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1deposits_operations~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1deposits_operations~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_349"}},"schemaId":"schema_349","pointer":"/paths/~1deposits_operations~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/deposits_operations/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_349"}},"responseCodes":["200","401","403","404"],"pointer":"/deposits_operations/{location_id}","href":"deposits/create_client_account_topup_operation","openApiOperationId":"create_client_account_topup_operation","summary":"Create a client account topup operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_349","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_349"}},"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/deposit_operation_response_data_types","exampleIds":["paths/~1deposits_operations~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/deposit_operation_response_data_types","exampleIds":["paths/~1deposits_operations~1{location_id}/post/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/~1deposits_operations~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/deposit_operation_response_data_types","exampleIds":["paths/~1deposits_operations~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/deposit_operation_response_data_types","exampleIds":["paths/~1deposits_operations~1{location_id}/post/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":"/deposits/create_client_account_topup_operation"}],"panels":[]}]},"httpPath":"/deposits_operations/{location_id}"},{"label":"Get client account transaction history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/deposits/get_chain_client_account_history","routeSlug":"/en/b2b-v1/openapi/deposits/get_chain_client_account_history","metadata":{"seo":{"title":"Get client account transaction history","description":"Retrieves the transaction history for a specific client account in the chain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_client_account_history","name":"Get client account transaction history","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1deposits~1{deposit_id}~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get client account transaction history","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 transaction history for a specific client account in the chain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of all transactions (top-ups, withdrawals, etc.) made on the client account."},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"deposit_id","in":"path","schemaId":"schema_286","description":"Client account ID","required":true,"example":12345}],"pointer":"/paths/~1chain~1{chain_id}~1deposits~1{deposit_id}~1history/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1deposits~1{deposit_id}~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/deposits/{deposit_id}/history","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"deposit_id","in":"path","required":true,"example":12345,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/chain/{chain_id}/deposits/{deposit_id}/history","href":"deposits/get_chain_client_account_history","openApiOperationId":"get_chain_client_account_history","summary":"Get client account transaction history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Transaction history retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Client account not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"}],"pointer":"/paths/~1chain~1{chain_id}~1deposits~1{deposit_id}~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_350"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deposits/get_chain_client_account_history"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/deposits/{deposit_id}/history"}],"content":{"contentType":"group","meta":{"name":"Deposits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deposits","showPageActions":true},{"nodeType":"markdoc","content":"Client deposit accounts and operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/deposits/company/{location_id}/client/{client_id}","summary":"Get a List of Client Accounts by Location and Client","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deposits/get_client_account_list_by_location_and_client","deprecated":false},{"title":"/deposits/chain/{chain_id}","summary":"Get a list of client accounts by chain and a set of filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deposits/get_client_account_list_by_chain","deprecated":false},{"title":"/deposits/chain/{chain_id}/phone/{phone}","summary":"Get a list of client accounts by chain and customer phone number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deposits/get_client_account_by_chain_and_phone","deprecated":false},{"title":"/deposits_operations/{location_id}","summary":"Create a client account topup operation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/deposits/create_client_account_topup_operation","deprecated":false},{"title":"/chain/{chain_id}/deposits/{deposit_id}/history","summary":"Get client account transaction history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/deposits/get_chain_client_account_history","deprecated":false}]}]}]}]}},{"type":"group","label":"Loyalty Cards","link":"/en/b2b-v1/openapi/loyalty-cards","routeSlug":"/en/b2b-v1/openapi/loyalty-cards","items":[{"label":"Get a List of Customer Cards by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_list_by_client_id","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_list_by_client_id","metadata":{"seo":{"title":"Get a List of Customer Cards by ID","description":"Returns a list of customer cards with programs that are active in this location The attributes in the response to the request completely match the \"Get a list of issued cards by phone number\" method described above"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_card_list_by_client_id","name":"Get a List of Customer Cards by ID","isWebhook":false,"pointer":"/paths/~1loyalty~1client_cards~1{client_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Customer Cards by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of customer cards with programs that are active in this location\r\n\r\nThe attributes in the response to the request completely match the \"Get a list of issued cards by phone number\" method described above"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_280","description":"Client ID","required":true}],"pointer":"/paths/~1loyalty~1client_cards~1{client_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1loyalty~1client_cards~1{client_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loyalty/client_cards/{client_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/loyalty/client_cards/{client_id}","href":"loyalty-cards/get_loyalty_card_list_by_client_id","openApiOperationId":"get_loyalty_card_list_by_client_id","summary":"Get a List of Customer Cards by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1client_cards~1{client_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1client_cards~1{client_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/~1loyalty~1client_cards~1{client_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1client_cards~1{client_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1client_cards~1{client_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":"/loyalty-cards/get_loyalty_card_list_by_client_id"}],"panels":[]}]},"httpPath":"/loyalty/client_cards/{client_id}"},{"label":"Get a List of Customer Cards by Phone Number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_list_by_phone","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_list_by_phone","metadata":{"seo":{"title":"Get a List of Customer Cards by Phone Number","description":"Returns a list of customer cards with programs that are active in this location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_card_list_by_phone","name":"Get a List of Customer Cards by Phone Number","isWebhook":false,"pointer":"/paths/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Customer Cards by Phone Number","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 a list of customer cards with programs that are active in this location"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loyalty card ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loyalty card balance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paid_amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount \"Paid\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sold_amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount \"Sold\""},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visits_count"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of visits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loyalty card type identifier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salon_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the chain where the card was created"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object that contains the \"id\" and \"title\" fields: card type identifier and name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salon_group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object that contains the \"id\" and \"title\" fields: identifier of the chain where the card type was created and the name of this chain"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"programs"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array with information about promotions linked to a loyalty card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array with information about the rules configured in the action"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The programs array consists of objects with the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotion ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loyalty_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotion type ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is cashback accrued from products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value_unit_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bonus field — Discount % or Fixed amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the chain where the action was created"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loyalty_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with information about the action"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The rules array consists of objects with the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rule ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loyalty_program_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the promotion to which the rule is attached"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"loyalty_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Promotion type ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value from which the rule will work"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"phone","in":"path","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer phone number in the format +13155550175"},"children":[]}]}]}],"required":true},{"name":"chain_id","in":"path","schemaId":"schema_280","description":"Chain ID","required":true},{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loyalty/cards/{phone}/{chain_id}/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"phone","in":"path","required":true,"schemaId":"schema_279"},{"name":"chain_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/loyalty/cards/{phone}/{chain_id}/{location_id}","href":"loyalty-cards/get_loyalty_card_list_by_phone","openApiOperationId":"get_loyalty_card_list_by_phone","summary":"Get a List of Customer Cards by Phone Number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{phone}~1{chain_id}~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/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{phone}~1{chain_id}~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":"/loyalty-cards/get_loyalty_card_list_by_phone"}],"panels":[]}]},"httpPath":"/loyalty/cards/{phone}/{chain_id}/{location_id}"},{"label":"Get User Loyalty Cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/get_user_loyalty_cards","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/get_user_loyalty_cards","metadata":{"seo":{"title":"Get User Loyalty Cards","description":"Returns a list of cards of an authorized user with programs, filtering cards by location chain / location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_user_loyalty_cards","name":"Get User Loyalty Cards","isWebhook":false,"pointer":"/paths/~1user~1loyalty_cards~1{chain_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User Loyalty Cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of cards of an authorized user with programs, filtering cards by location chain / location"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_280","description":"Chain ID","required":true}],"pointer":"/paths/~1user~1loyalty_cards~1{chain_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1user~1loyalty_cards~1{chain_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/loyalty_cards/{chain_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/user/loyalty_cards/{chain_id}","href":"loyalty-cards/get_user_loyalty_cards","openApiOperationId":"get_user_loyalty_cards","summary":"Get User Loyalty Cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_cards_response_data_types"}},"schemaId":"components/schemas/loyalty_cards_response_data_types"},{"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/~1user~1loyalty_cards~1{chain_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_cards_response_data_types","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_cards_response_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"}}},{"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":"/loyalty-cards/get_user_loyalty_cards"}],"panels":[]}]},"httpPath":"/user/loyalty_cards/{chain_id}"},{"label":"Get a list of card types available at the location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_type_list","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_type_list","metadata":{"seo":{"title":"Get a list of card types available at the location","description":"Returns a list of card types that are valid for the given location. The attributes and their descriptions match those defined in the \"Collection of Card Types Available to the Client\" method described above."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_card_type_list","name":"Get a list of card types available at the location","isWebhook":false,"pointer":"/paths/~1loyalty~1card_types~1salon~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of card types available at the location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of card types that are valid for the given location.\r\n\r\nThe attributes and their descriptions match those defined in the \"Collection of Card Types Available to the Client\" method described above."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":12345}],"pointer":"/paths/~1loyalty~1card_types~1salon~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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/~1loyalty~1card_types~1salon~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loyalty/card_types/salon/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":12345,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/loyalty/card_types/salon/{location_id}","href":"loyalty-cards/get_loyalty_card_type_list","openApiOperationId":"get_loyalty_card_type_list","summary":"Get a list of card types available at the location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1salon~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1salon~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/~1loyalty~1card_types~1salon~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1salon~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1salon~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":"/loyalty-cards/get_loyalty_card_type_list"}],"panels":[]}]},"httpPath":"/loyalty/card_types/salon/{location_id}"},{"label":"Get a List of Card Types Available for Issuance to the Client","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_type_list_for_client","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/get_loyalty_card_type_list_for_client","metadata":{"seo":{"title":"Get a List of Card Types Available for Issuance to the Client","description":"Returns a list of card types that are available for issuance to a location client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_card_type_list_for_client","name":"Get a List of Card Types Available for Issuance to the Client","isWebhook":false,"pointer":"/paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Card Types Available for Issuance to the Client","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 a list of card types that are available for issuance to a location client."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card type identifier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card type name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salon_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the chain where the card type was created"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salon_group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that contains the \"id\" and \"title\" fields: identifier of the chain where the card type was created and the name of this chain"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true,"example":12345},{"name":"phone","in":"path","schemaId":"schema_280","description":"Customer phone number","required":true,"example":13155550175}],"pointer":"/paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loyalty/card_types/client/{location_id}/{phone}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":12345,"schemaId":"schema_280"},{"name":"phone","in":"path","required":true,"example":13155550175,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/loyalty/card_types/client/{location_id}/{phone}","href":"loyalty-cards/get_loyalty_card_type_list_for_client","openApiOperationId":"get_loyalty_card_type_list_for_client","summary":"Get a List of Card Types Available for Issuance to the Client"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/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/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_card_types_response_data_types","exampleIds":["paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/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":"/loyalty-cards/get_loyalty_card_type_list_for_client"}],"panels":[]}]},"httpPath":"/loyalty/card_types/client/{location_id}/{phone}"},{"label":"Get a List of Card Types Available at the Chain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/get_chain_loyalty_card_type_list","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/get_chain_loyalty_card_type_list","metadata":{"seo":{"title":"Get a List of Card Types Available at the Chain","description":"Get a List of Card Types Available at the Chain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_loyalty_card_type_list","name":"Get a List of Card Types Available at the Chain","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1card_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Card Types Available at the Chain","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1card_types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1card_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/card_types","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/card_types","href":"loyalty-cards/get_chain_loyalty_card_type_list","openApiOperationId":"get_chain_loyalty_card_type_list","summary":"Get a List of Card Types Available at the Chain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_352"}},"schemaId":"schema_352"},{"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/~1chain~1{chain_id}~1loyalty~1card_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}},{"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":"/loyalty-cards/get_chain_loyalty_card_type_list"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/card_types"},{"label":"Issue a Loyalty Card","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/issue_loyalty_card","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/issue_loyalty_card","metadata":{"seo":{"title":"Issue a Loyalty Card","description":"| Attribute | Type | Description ||----------------------|--------|----------------- ------------------------------|| loyalty_card_number | number | Loyalty card number || loyalty_card_type_id | number | Loyalty card type identifier || phone | number | Customer phone number (e.g., 13155550175 for +13155550175) |"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"issue_loyalty_card","name":"Issue a Loyalty Card","isWebhook":false,"pointer":"/paths/~1loyalty~1cards~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue a Loyalty Card","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":"| Attribute | Type | Description |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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":"| loyalty_card_number | number | Loyalty card number |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| loyalty_card_type_id | number | Loyalty card type identifier |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| phone | number | Customer phone number (e.g., 13155550175 for +13155550175) |"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1loyalty~1cards~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1loyalty~1cards~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/loyalty_cards_request_data_types"}},"schemaId":"components/schemas/loyalty_cards_request_data_types","pointer":"/paths/~1loyalty~1cards~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/loyalty/cards/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/loyalty_cards_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/loyalty/cards/{location_id}","href":"loyalty-cards/issue_loyalty_card","openApiOperationId":"issue_loyalty_card","summary":"Issue a Loyalty Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/loyalty_cards_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/loyalty_cards_request_data_types"}},"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/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{location_id}/post/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/~1loyalty~1cards~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_cards_response_data_types","exampleIds":["paths/~1loyalty~1cards~1{location_id}/post/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":"/loyalty-cards/issue_loyalty_card"}],"panels":[]}]},"httpPath":"/loyalty/cards/{location_id}"},{"label":"Remove a Loyalty Card","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/remove_loyalty_card","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/remove_loyalty_card","metadata":{"seo":{"title":"Remove a Loyalty Card","description":"Remove a Loyalty Card"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove_loyalty_card","name":"Remove a Loyalty Card","isWebhook":false,"pointer":"/paths/~1loyalty~1cards~1{location_id}~1{card_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a Loyalty Card","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"card_id","in":"path","schemaId":"schema_280","description":"loyalty card ID","required":true}],"pointer":"/paths/~1loyalty~1cards~1{location_id}~1{card_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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/~1loyalty~1cards~1{location_id}~1{card_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/loyalty/cards/{location_id}/{card_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/loyalty/cards/{location_id}/{card_id}","href":"loyalty-cards/remove_loyalty_card","openApiOperationId":"remove_loyalty_card","summary":"Remove a Loyalty Card"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No Content"},{"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/~1loyalty~1cards~1{location_id}~1{card_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/loyalty-cards/remove_loyalty_card"}],"panels":[]}]},"httpPath":"/loyalty/cards/{location_id}/{card_id}"},{"label":"Manual withdraw/deposit to loyalty card in location","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/create_loyalty_card_transaction","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/create_loyalty_card_transaction","metadata":{"seo":{"title":"Manual withdraw/deposit to loyalty card in location","description":"Manual withdraw/deposit to loyalty card in location"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_loyalty_card_transaction","name":"Manual withdraw/deposit to loyalty card in location","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual withdraw/deposit to loyalty card in location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Manual withdraw/deposit to loyalty card in location"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"card_id","in":"path","schemaId":"schema_280","description":"Loyalty card ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353","pointer":"/paths/~1company~1{location_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/company/{location_id}/loyalty/cards/{card_id}/manual_transaction","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_353"}},"responseCodes":["200","403","404"],"pointer":"/company/{location_id}/loyalty/cards/{card_id}/manual_transaction","href":"loyalty-cards/create_loyalty_card_transaction","openApiOperationId":"create_loyalty_card_transaction","summary":"Manual withdraw/deposit to loyalty card in location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_353"}},"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":"schema_354"}},"schemaId":"schema_354"},{"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/~1company~1{location_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_354","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354"}}},{"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":"/loyalty-cards/create_loyalty_card_transaction"}],"panels":[]}]},"httpPath":"/company/{location_id}/loyalty/cards/{card_id}/manual_transaction"},{"label":"Manual withdraw/deposit to loyalty card in chain","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-cards/create_chain_loyalty_card_transaction","routeSlug":"/en/b2b-v1/openapi/loyalty-cards/create_chain_loyalty_card_transaction","metadata":{"seo":{"title":"Manual withdraw/deposit to loyalty card in chain","description":"Manual withdraw/deposit to loyalty card in chain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_chain_loyalty_card_transaction","name":"Manual withdraw/deposit to loyalty card in chain","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manual withdraw/deposit to loyalty card in chain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Manual withdraw/deposit to loyalty card in chain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_280","description":"ID of a chain.","required":true,"example":123},{"name":"card_id","in":"path","schemaId":"schema_280","description":"Loyalty card ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/cards/{card_id}/manual_transaction","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_353"}},"responseCodes":["200","403","404"],"pointer":"/chain/{chain_id}/loyalty/cards/{card_id}/manual_transaction","href":"loyalty-cards/create_chain_loyalty_card_transaction","openApiOperationId":"create_chain_loyalty_card_transaction","summary":"Manual withdraw/deposit to loyalty card in chain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_353"}},"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":"schema_354"}},"schemaId":"schema_354"},{"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/~1chain~1{chain_id}~1loyalty~1cards~1{card_id}~1manual_transaction/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_354","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354"}}},{"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":"/loyalty-cards/create_chain_loyalty_card_transaction"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/cards/{card_id}/manual_transaction"}],"content":{"contentType":"group","meta":{"name":"Loyalty Cards"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loyalty Cards","showPageActions":true},{"nodeType":"markdoc","content":"Loyalty card types, issuance, and manual transactions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/loyalty/client_cards/{client_id}","summary":"Get a List of Customer Cards by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-cards/get_loyalty_card_list_by_client_id","deprecated":false},{"title":"/loyalty/cards/{phone}/{chain_id}/{location_id}","summary":"Get a List of Customer Cards by Phone Number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-cards/get_loyalty_card_list_by_phone","deprecated":false},{"title":"/user/loyalty_cards/{chain_id}","summary":"Get User Loyalty Cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-cards/get_user_loyalty_cards","deprecated":false},{"title":"/loyalty/card_types/salon/{location_id}","summary":"Get a list of card types available at the location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-cards/get_loyalty_card_type_list","deprecated":false},{"title":"/loyalty/card_types/client/{location_id}/{phone}","summary":"Get a List of Card Types Available for Issuance to the Client","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-cards/get_loyalty_card_type_list_for_client","deprecated":false},{"title":"/chain/{chain_id}/loyalty/card_types","summary":"Get a List of Card Types Available at the Chain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-cards/get_chain_loyalty_card_type_list","deprecated":false},{"title":"/loyalty/cards/{location_id}","summary":"Issue a Loyalty Card","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-cards/issue_loyalty_card","deprecated":false},{"title":"/loyalty/cards/{location_id}/{card_id}","summary":"Remove a Loyalty Card","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/loyalty-cards/remove_loyalty_card","deprecated":false},{"title":"/company/{location_id}/loyalty/cards/{card_id}/manual_transaction","summary":"Manual withdraw/deposit to loyalty card in location","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-cards/create_loyalty_card_transaction","deprecated":false},{"title":"/chain/{chain_id}/loyalty/cards/{card_id}/manual_transaction","summary":"Manual withdraw/deposit to loyalty card in chain","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-cards/create_chain_loyalty_card_transaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions & Certificates","link":"/en/b2b-v1/openapi/subscriptions-and-certificates","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates","items":[{"label":"Get Client Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_client_memberships","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_client_memberships","metadata":{"seo":{"title":"Get Client Memberships","description":"Returns a list of client's memberships by phone"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client_memberships","name":"Get Client Memberships","isWebhook":false,"pointer":"/paths/~1loyalty~1abonements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Client Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of client's memberships by phone"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"company_id","in":"query","schemaId":"schema_280","description":"Location ID","required":true},{"name":"phone","in":"query","schemaId":"schema_280","description":"Customer phone number","required":true}],"pointer":"/paths/~1loyalty~1abonements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1loyalty~1abonements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loyalty/abonements","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"company_id","in":"query","required":true,"schemaId":"schema_280"},{"name":"phone","in":"query","required":true,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/loyalty/abonements","href":"subscriptions-and-certificates/get_client_memberships","openApiOperationId":"get_client_memberships","summary":"Get Client Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_abonements_response_data_types","exampleIds":["paths/~1loyalty~1abonements/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_abonements_response_data_types","exampleIds":["paths/~1loyalty~1abonements/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/~1loyalty~1abonements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_abonements_response_data_types","exampleIds":["paths/~1loyalty~1abonements/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_abonements_response_data_types","exampleIds":["paths/~1loyalty~1abonements/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":"/subscriptions-and-certificates/get_client_memberships"}],"panels":[]}]},"httpPath":"/loyalty/abonements"},{"label":"Get User Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_user_memberships","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_user_memberships","metadata":{"seo":{"title":"Get User Memberships","description":"Returns a list of memberships of an authorized user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_user_memberships","name":"Get User Memberships","isWebhook":false,"pointer":"/paths/~1user~1loyalty~1abonements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User Memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of memberships of an authorized user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"company_id","in":"query","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1user~1loyalty~1abonements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1user~1loyalty~1abonements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/loyalty/abonements","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"company_id","in":"query","required":true,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/user/loyalty/abonements","href":"subscriptions-and-certificates/get_user_memberships","openApiOperationId":"get_user_memberships","summary":"Get User Memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_abonements_response_data_types","exampleIds":["paths/~1user~1loyalty~1abonements/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_abonements_response_data_types","exampleIds":["paths/~1user~1loyalty~1abonements/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/~1user~1loyalty~1abonements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_abonements_response_data_types","exampleIds":["paths/~1user~1loyalty~1abonements/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_abonements_response_data_types","exampleIds":["paths/~1user~1loyalty~1abonements/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":"/subscriptions-and-certificates/get_user_memberships"}],"panels":[]}]},"httpPath":"/user/loyalty/abonements"},{"label":"Get a List of Memberships by Filter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_membership_list","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_membership_list","metadata":{"seo":{"title":"Get a List of Memberships by Filter","description":"Get a List of Memberships by Filter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_membership_list","name":"Get a List of Memberships by Filter","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Memberships by Filter","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_280","description":"Chain ID.","required":true,"example":123}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_279","description":"Creation date from (filter by creation date).","example":"2026-09-21T23:00:00.000-05:00"},{"name":"created_before","in":"query","schemaId":"schema_279","description":"Creation date by (filter by creation date).","example":"2026-09-21T23:00:00.000-05:00"},{"name":"abonements_ids","in":"query","schemaId":"schema_355","description":"List of membership IDs for the filter."},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number.","example":1},{"name":"count","in":"query","schemaId":"schema_280","description":"Number of appointments per page.","example":25}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/abonements","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":123,"schemaId":"schema_280"}],"query":[{"name":"created_after","in":"query","example":"2026-09-21T23:00:00.000-05:00","schemaId":"schema_279"},{"name":"created_before","in":"query","example":"2026-09-21T23:00:00.000-05:00","schemaId":"schema_279"},{"name":"abonements_ids","in":"query","schemaId":"schema_355","style":"form","explode":false},{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"count","in":"query","example":25,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/chain/{chain_id}/loyalty/abonements","href":"subscriptions-and-certificates/get_membership_list","openApiOperationId":"get_membership_list","summary":"Get a List of Memberships by Filter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/400/content/application~1json/example"]}},"exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/400/content/application~1json/example"]}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/200/content/application~1json/example"]}}},{"code":"400","exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/400/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions-and-certificates/get_membership_list"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonements"},{"label":"Get a List of Membership Types by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_membership_type_list_by_id","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_membership_type_list_by_id","metadata":{"seo":{"title":"Get a List of Membership Types by ID","description":"A list of membership types available at a location can be obtained by querying the location ID and membership type IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_membership_type_list_by_id","name":"Get a List of Membership Types by ID","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Membership Types by ID","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 list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"membership types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available at a location can be obtained by querying the location ID and membership type IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list is an array of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#loyalty-membership-type"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"membership types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions-and-certificates/get_membership_type_list_by_id/request/get-a-list-of-membership-types-by-id","deepLinkHash":"/subscriptions-and-certificates/get_membership_type_list_by_id#subscriptions-and-certificates/get_membership_type_list_by_id/request/get-a-list-of-membership-types-by-id"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of membership types by ID"},"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":"Parameters"},"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":"company_id (required, number) - location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id: 1 (optional, number) - membership type ID (you can specify several additional parameters "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"&ids[]={id}"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids[]","in":"query","schemaId":"schema_280","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Membership type ID (you can specify several additional parameters &ids[]={id}"},"children":[]}]}]}]}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/loyalty/abonement_types/fetch","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"ids[]","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/loyalty/abonement_types/fetch","href":"subscriptions-and-certificates/get_membership_type_list_by_id","openApiOperationId":"get_membership_type_list_by_id","summary":"Get a List of Membership Types by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/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/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/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":"/subscriptions-and-certificates/get_membership_type_list_by_id"}],"panels":[]}]},"httpPath":"/company/{location_id}/loyalty/abonement_types/fetch"},{"label":"Get a List of Available Membership Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_membership_type_list","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_membership_type_list","metadata":{"seo":{"title":"Get a List of Available Membership Types","description":"A list of membership types available at a location can be obtained by requesting the location ID.The list can be filtered by membership type name by passing the title parameter. Pagination is supported, specified by the page and page_size parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_membership_type_list","name":"Get a List of Available Membership Types","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Available Membership Types","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 list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"membership types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available at a location can be obtained by requesting the location ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list can be filtered by membership type name by passing the title parameter. Pagination is supported, specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list is an array of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#loyalty-membership-type"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"membership types"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"loyalty-membership-type"}},"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":"Membership type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Membership type identifier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Membership type name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allow_freeze"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it possible to freeze memberships? true - allowed, false - not allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"freeze limit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum total freezing period (days)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"salon_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the chain in which the membership type is valid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Membership expiration date (0 if not set)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"period_unit_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Membership expiration unit (list of possible values, if not set - 0)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_allow_empty_code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow the sale of a membership without a code? true - allow, false - do not allow"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_united_balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total or separate membership balance: true - total, false - separate"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"united_balance_services_count"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of visits for total balance"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"loyalty-membership-expiration-unit"}},"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":"Measurement units of membership type validity period"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Year"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"title","in":"query","schemaId":"schema_279","description":"Membeship type name"},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number"},{"name":"page_size","in":"query","schemaId":"schema_280","description":"The number of output lines per page. Maximum 100"}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":"Conetnt-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/loyalty/abonement_types/search","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"title","in":"query","schemaId":"schema_279"},{"name":"page","in":"query","schemaId":"schema_280"},{"name":"page_size","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Conetnt-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/loyalty/abonement_types/search","href":"subscriptions-and-certificates/get_membership_type_list","openApiOperationId":"get_membership_type_list","summary":"Get a List of Available Membership Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/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/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_abonements_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/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":"/subscriptions-and-certificates/get_membership_type_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/loyalty/abonement_types/search"},{"label":"Search available subscriptions for event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/search_memberships_for_event","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/search_memberships_for_event","metadata":{"seo":{"title":"Search available subscriptions for event","description":"Retrieves subscriptions that can be used to create a client schedule for a series of events."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_memberships_for_event","name":"Search available subscriptions for event","isWebhook":false,"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1search_for_activity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search available subscriptions for event","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 subscriptions that can be used to create a client schedule for a series of events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method returns subscriptions (memberships) that:"},"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":"Belong to the specified client"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Are valid and active"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be applied to the specified activity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have remaining visits available"},"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":"Use cases:"},"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":"Display available subscriptions when scheduling recurring activity sessions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check which subscriptions cover specific activity types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate subscription applicability before creating schedules"},"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":" Returns subscriptions with their types and availability intervals."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true,"example":720441},{"name":"client_id","in":"path","schemaId":"schema_286","description":"Client ID","required":true,"example":146915197}],"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1search_for_activity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"event_id","in":"query","schemaId":"schema_286","description":"Event (group event) ID","required":true,"example":12345}],"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1search_for_activity/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1search_for_activity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/search_for_activity","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":720441,"schemaId":"schema_286"},{"name":"client_id","in":"path","required":true,"example":146915197,"schemaId":"schema_286"}],"query":[{"name":"event_id","in":"query","required":true,"example":12345,"schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/search_for_activity","href":"subscriptions-and-certificates/search_memberships_for_event","openApiOperationId":"search_memberships_for_event","summary":"Search available subscriptions for event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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 available subscriptions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Event or client not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}},"schemaId":"schema_357"}],"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1search_for_activity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_357","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions-and-certificates/search_memberships_for_event"}],"panels":[]}]},"httpPath":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/search_for_activity"},{"label":"Check membership availability for event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/check_memberships_for_event","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/check_memberships_for_event","metadata":{"seo":{"title":"Check membership availability for event","description":"Validates a specific subscription for creating activity schedules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"check_memberships_for_event","name":"Check membership availability for event","isWebhook":false,"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1{membership_id}~1check_for_activity/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check membership availability for event","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":"Validates a specific subscription for creating activity schedules."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last possible appointment date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on membership expiration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available visit count"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the selected subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schedule day IDs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be booked"},"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":"Use cases:"},"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":"Validate subscription before creating recurring appointments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check if subscription has enough visits for schedule"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determine last bookable date based on expiration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-validate schedule parameters"},"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":" Requires schedule_day_ids parameter to check specific dates."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"Location ID","required":true,"example":720441},{"name":"client_id","in":"path","schemaId":"schema_286","description":"Client ID","required":true,"example":146915197},{"name":"membership_id","in":"path","schemaId":"schema_286","description":"Membership instance ID","required":true,"example":5248829}],"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1{membership_id}~1check_for_activity/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"event_id","in":"query","schemaId":"schema_286","description":"Event (group event) ID","required":true,"example":12345},{"name":"schedule_day_ids","in":"query","schemaId":"schema_279","description":"Comma-separated list of schedule day IDs to check","required":true,"example":"1,2,3,4,5"}],"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1{membership_id}~1check_for_activity/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1{membership_id}~1check_for_activity/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/{membership_id}/check_for_activity","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":720441,"schemaId":"schema_286"},{"name":"client_id","in":"path","required":true,"example":146915197,"schemaId":"schema_286"},{"name":"membership_id","in":"path","required":true,"example":5248829,"schemaId":"schema_286"}],"query":[{"name":"event_id","in":"query","required":true,"example":12345,"schemaId":"schema_286"},{"name":"schedule_day_ids","in":"query","required":true,"example":"1,2,3,4,5","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/{membership_id}/check_for_activity","href":"subscriptions-and-certificates/check_memberships_for_event","openApiOperationId":"check_memberships_for_event","summary":"Check membership availability for event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Subscription availability information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358"},{"code":"400","description":"Bad Request - invalid parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}},"schemaId":"schema_359"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Event, client, or membership not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}},"schemaId":"schema_357"}],"pointer":"/paths/~1api~1v1~1company~1{location_id}~1client~1{client_id}~1loyalty~1abonements~1{membership_id}~1check_for_activity/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}}},{"code":"400","schemaId":"schema_359","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_357","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions-and-certificates/check_memberships_for_event"}],"panels":[]}]},"httpPath":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/{membership_id}/check_for_activity"},{"label":"Get client gift cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_client_gift_cards","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_client_gift_cards","metadata":{"seo":{"title":"Get client gift cards","description":"Returns a list of client gift cards by phone"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_client_gift_cards","name":"Get client gift cards","isWebhook":false,"pointer":"/paths/~1loyalty~1certificates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get client gift cards","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 a list of client gift cards by phone"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current balance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"default_balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initial balance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card type identifier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of sale"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"datetime"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Burn date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with gift card type information"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object with information about the current gift card status"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type array contains the following objects:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card type identifier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"decimal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card denomination"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_multi"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Is it available for multiple debits"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the chain where the certificate type was created"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restriction on the use of redemption points. 0 - no limit, 1 - services only, 2 - some services + all products, 3 - some services, 4 - products only"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the expiration limit. 0 - unlimited, 1 - fixed date, 2 - fixed term"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"timestamp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Burn date of all gift cards. Populated with expiration_type_id = 1"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_timeout"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validity period of gift card. Populated with expiration_type_id = 2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_timeout_unit_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"int"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time units. 1 - Day, 2 - Week, 3 - Month, 4 - Year"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_allow_empty_code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale without code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item_type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with item_type_id and its name"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"copmany_id","in":"query","schemaId":"schema_280","description":"Location ID","required":true},{"name":"phone","in":"query","schemaId":"schema_280","description":"Customer phone number","required":true}],"pointer":"/paths/~1loyalty~1certificates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1loyalty~1certificates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loyalty/certificates","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"copmany_id","in":"query","required":true,"schemaId":"schema_280"},{"name":"phone","in":"query","required":true,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/loyalty/certificates","href":"subscriptions-and-certificates/get_client_gift_cards","openApiOperationId":"get_client_gift_cards","summary":"Get client gift cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_certificates_response_data_types","exampleIds":["paths/~1loyalty~1certificates/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_certificates_response_data_types","exampleIds":["paths/~1loyalty~1certificates/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/~1loyalty~1certificates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_certificates_response_data_types","exampleIds":["paths/~1loyalty~1certificates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_certificates_response_data_types","exampleIds":["paths/~1loyalty~1certificates/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":"/subscriptions-and-certificates/get_client_gift_cards"}],"panels":[]}]},"httpPath":"/loyalty/certificates"},{"label":"Get user gift cards","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_user_gift_cards","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_user_gift_cards","metadata":{"seo":{"title":"Get user gift cards","description":"Returns a list of authorized user gift cards"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_user_gift_cards","name":"Get user gift cards","isWebhook":false,"pointer":"/paths/~1user~1loyalty~1certificates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user gift cards","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of authorized user gift cards"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"company_id","in":"query","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1user~1loyalty~1certificates/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1user~1loyalty~1certificates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/loyalty/certificates","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"company_id","in":"query","required":true,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/user/loyalty/certificates","href":"subscriptions-and-certificates/get_user_gift_cards","openApiOperationId":"get_user_gift_cards","summary":"Get user gift cards"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_certificates_response_data_types","exampleIds":["paths/~1user~1loyalty~1certificates/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_certificates_response_data_types","exampleIds":["paths/~1user~1loyalty~1certificates/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/~1user~1loyalty~1certificates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_certificates_response_data_types","exampleIds":["paths/~1user~1loyalty~1certificates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_certificates_response_data_types","exampleIds":["paths/~1user~1loyalty~1certificates/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":"/subscriptions-and-certificates/get_user_gift_cards"}],"panels":[]}]},"httpPath":"/user/loyalty/certificates"},{"label":"Get a List of Gift Card Types by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_gift_card_type_list_by_id","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_gift_card_type_list_by_id","metadata":{"seo":{"title":"Get a List of Gift Card Types by ID","description":"A list of gift card types available at the location can be obtained by querying the location ID and gift card type IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_gift_card_type_list_by_id","name":"Get a List of Gift Card Types by ID","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Gift Card Types by ID","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 list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift card types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available at the location can be obtained by querying the location ID and gift card type IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list is an array of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#loyalty-certificate-type"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift card types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/loyalty/certificate_types/fetch","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/loyalty/certificate_types/fetch","href":"subscriptions-and-certificates/get_gift_card_type_list_by_id","openApiOperationId":"get_gift_card_type_list_by_id","summary":"Get a List of Gift Card Types by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/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/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/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":"/subscriptions-and-certificates/get_gift_card_type_list_by_id"}],"panels":[]}]},"httpPath":"/company/{location_id}/loyalty/certificate_types/fetch"},{"label":"Get a List of Available Gift Card Types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_gift_card_type_list","routeSlug":"/en/b2b-v1/openapi/subscriptions-and-certificates/get_gift_card_type_list","metadata":{"seo":{"title":"Get a List of Available Gift Card Types","description":"A list of gift card types available at a location can be obtained by querying the location ID.The list can be filtered by the name of the gift card type by passing the title parameter.Pagination is supported, specified by the page and page_size parameters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_gift_card_type_list","name":"Get a List of Available Gift Card Types","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Available Gift Card Types","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 list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift card types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available at a location can be obtained by querying the location ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list can be filtered by the name of the gift card type by passing the title parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination is supported, specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list is an array of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#loyalty-certificate-type"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gift card types"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"loyalty-certificate-type"}},"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":"Gift card type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card type identifier"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card type name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"balance"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card denomination"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_multi"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Write-off type: true - multiple write-off, false - single write-off"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company_group_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the chain where the gift card type is valid"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"item_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application Constraint (list of possible values)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_type_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiration limit (list of possible values)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed burn date in ISO8601 format (null if not set)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_timeout"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gift card validity period from the date of sale (0 if not set)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration_timeout_unit_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unit of measurement of the validity period of the gift card from the moment of sale (list of possible values, if not set - 0)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is_allow_empty_code"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow sale of gift card without code? true - allow, false - do not allow"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"loyalty-certificate-item-type"}},"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":"Gift Card Type Restriction"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unlimited"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any services without products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any products without services"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some services without products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some services and any products"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"loyalty-certificate-expiration-type"}},"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":"Gift Card Type Expiration Limit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No expiration date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed date for all instances"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed period of validity from the date of sale"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"loyalty-certificate-expiration-unit"}},"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":"Units of certificate type validity period"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Week"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Year"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"title","in":"query","schemaId":"schema_279","description":"Gift card type name"},{"name":"page","in":"query","schemaId":"schema_280","description":"Page number"},{"name":"page_size","in":"query","schemaId":"schema_280","description":"The number of output lines per page. Maximum 100"}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_286","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/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/loyalty/certificate_types/search","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"title","in":"query","schemaId":"schema_279"},{"name":"page","in":"query","schemaId":"schema_280"},{"name":"page_size","in":"query","schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_286"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/loyalty/certificate_types/search","href":"subscriptions-and-certificates/get_gift_card_type_list","openApiOperationId":"get_gift_card_type_list","summary":"Get a List of Available Gift Card Types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/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/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_certificate_type_search_response_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/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":"/subscriptions-and-certificates/get_gift_card_type_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/loyalty/certificate_types/search"}],"content":{"contentType":"group","meta":{"name":"Subscriptions & Certificates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions & Certificates","showPageActions":true},{"nodeType":"markdoc","content":"Membership subscriptions and gift certificates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/loyalty/abonements","summary":"Get Client Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_client_memberships","deprecated":false},{"title":"/user/loyalty/abonements","summary":"Get User Memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_user_memberships","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonements","summary":"Get a List of Memberships by Filter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_membership_list","deprecated":false},{"title":"/company/{location_id}/loyalty/abonement_types/fetch","summary":"Get a List of Membership Types by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_membership_type_list_by_id","deprecated":false},{"title":"/company/{location_id}/loyalty/abonement_types/search","summary":"Get a List of Available Membership Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_membership_type_list","deprecated":false},{"title":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/search_for_activity","summary":"Search available subscriptions for event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/search_memberships_for_event","deprecated":false},{"title":"/api/v1/company/{location_id}/client/{client_id}/loyalty/abonements/{membership_id}/check_for_activity","summary":"Check membership availability for event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/check_memberships_for_event","deprecated":false},{"title":"/loyalty/certificates","summary":"Get client gift cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_client_gift_cards","deprecated":false},{"title":"/user/loyalty/certificates","summary":"Get user gift cards","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_user_gift_cards","deprecated":false},{"title":"/company/{location_id}/loyalty/certificate_types/fetch","summary":"Get a List of Gift Card Types by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_gift_card_type_list_by_id","deprecated":false},{"title":"/company/{location_id}/loyalty/certificate_types/search","summary":"Get a List of Available Gift Card Types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions-and-certificates/get_gift_card_type_list","deprecated":false}]}]}]}]}},{"type":"group","label":"Loyalty Programs","link":"/en/b2b-v1/openapi/loyalty-programs","routeSlug":"/en/b2b-v1/openapi/loyalty-programs","items":[{"label":"Get a List of Promotions Active in the Location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/get_location_loyalty_program_list","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/get_location_loyalty_program_list","metadata":{"seo":{"title":"Get a List of Promotions Active in the Location","description":"The method allows you to get a list of promotions that are active for the specified location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_loyalty_program_list","name":"Get a List of Promotions Active in the Location","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1loyalty~1programs~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Promotions Active in the Location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get a list of promotions that are active for the specified location."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1programs~1search/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The first_transaction_date value adds the date of the first stock transaction to the response."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_360","description":"Promotion type"}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1programs~1search/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer bearer_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1company~1{location_id}~1loyalty~1programs~1search/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/loyalty/programs/search","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"include","in":"query","schemaId":"schema_279"},{"name":"type","in":"query","schemaId":"schema_360"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/loyalty/programs/search","href":"loyalty-programs/get_location_loyalty_program_list","openApiOperationId":"get_location_loyalty_program_list","summary":"Get a List of Promotions Active in the Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/company_loyalty_programs_search_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1programs~1search/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/company_loyalty_programs_search_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1programs~1search/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/~1company~1{location_id}~1loyalty~1programs~1search/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company_loyalty_programs_search_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1programs~1search/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company_loyalty_programs_search_data_types","exampleIds":["paths/~1company~1{location_id}~1loyalty~1programs~1search/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":"/loyalty-programs/get_location_loyalty_program_list"}],"panels":[]}]},"httpPath":"/company/{location_id}/loyalty/programs/search"},{"label":"Get loyalty transactions by visit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/get_loyalty_transactions_by_visit","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/get_loyalty_transactions_by_visit","metadata":{"seo":{"title":"Get loyalty transactions by visit","description":"List of transactions for loyalty promotions for this visit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_loyalty_transactions_by_visit","name":"Get loyalty transactions by visit","isWebhook":false,"pointer":"/paths/~1visit~1loyalty~1transactions~1{visit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get loyalty transactions by visit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of transactions for loyalty promotions for this visit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"visit_id","in":"path","schemaId":"schema_280","description":"Visit ID","required":true}],"pointer":"/paths/~1visit~1loyalty~1transactions~1{visit_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visit~1loyalty~1transactions~1{visit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/visit/loyalty/transactions/{visit_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"visit_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/visit/loyalty/transactions/{visit_id}","href":"loyalty-programs/get_loyalty_transactions_by_visit","openApiOperationId":"get_loyalty_transactions_by_visit","summary":"Get loyalty transactions by visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/visit_loyalty_transaction_reaponse_data_types","exampleIds":["paths/~1visit~1loyalty~1transactions~1{visit_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visit_loyalty_transaction_reaponse_data_types","exampleIds":["paths/~1visit~1loyalty~1transactions~1{visit_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/~1visit~1loyalty~1transactions~1{visit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visit_loyalty_transaction_reaponse_data_types","exampleIds":["paths/~1visit~1loyalty~1transactions~1{visit_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visit_loyalty_transaction_reaponse_data_types","exampleIds":["paths/~1visit~1loyalty~1transactions~1{visit_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":"/loyalty-programs/get_loyalty_transactions_by_visit"}],"panels":[]}]},"httpPath":"/visit/loyalty/transactions/{visit_id}"},{"label":"Gift Card/Membership Code Generation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/generate_loyalty_code","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/generate_loyalty_code","metadata":{"seo":{"title":"Gift Card/Membership Code Generation","description":"Optionslocation_id (required, number, 1) - location IDproduct_id (required, number, 1) - product ID (gift card/ membership)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generate_loyalty_code","name":"Gift Card/Membership Code Generation","isWebhook":false,"pointer":"/paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gift Card/Membership Code Generation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$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":"Options"},"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":"location_id (required, number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - location ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product_id (required, number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - product ID (gift card/ membership)"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"product_id","in":"path","schemaId":"schema_280","description":"Product ID (membership/gift card)","required":true}],"pointer":"/paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/loyalty/generate_code/{location_id}/{product_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/loyalty/generate_code/{location_id}/{product_id}","href":"loyalty-programs/generate_loyalty_code","openApiOperationId":"generate_loyalty_code","summary":"Gift Card/Membership Code Generation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_361","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_361","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/403/content/application~1json/example"]}},"schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/404/content/application~1json/example"]}},"schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_361","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/loyalty-programs/generate_loyalty_code"}],"panels":[]}]},"httpPath":"/loyalty/generate_code/{location_id}/{product_id}"},{"label":"Apply Deduction from the Loyalty Card in the Visit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/apply_loyalty_card_deduction","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/apply_loyalty_card_deduction","metadata":{"seo":{"title":"Apply Deduction from the Loyalty Card in the Visit","description":"The amount deducted will not exceed the available bonus balance. If the value is set to 0, no write-off transaction will occur"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apply_loyalty_card_deduction","name":"Apply Deduction from the Loyalty Card in the Visit","isWebhook":false,"pointer":"/paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply Deduction from the Loyalty Card in the Visit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The amount deducted will not exceed the available bonus balance. If the value is set to 0, no write-off transaction will occur"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"card_id","in":"path","schemaId":"schema_280","description":"Client card ID","required":true}],"pointer":"/paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_withdrawl_request_data_types"}},"schemaId":"components/schemas/visit_loyalty_withdrawl_request_data_types","pointer":"/paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/visit_loyalty_withdrawl_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}","href":"loyalty-programs/apply_loyalty_card_deduction","openApiOperationId":"apply_loyalty_card_deduction","summary":"Apply Deduction from the Loyalty Card in the Visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/visit_loyalty_withdrawl_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_withdrawl_request_data_types"}},"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/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/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/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/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":"/loyalty-programs/apply_loyalty_card_deduction"}],"panels":[]}]},"httpPath":"/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}"},{"label":"Cancel Withdrawal from the Loyalty Card During the Visit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/cancel_loyalty_card_withdrawal","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/cancel_loyalty_card_withdrawal","metadata":{"seo":{"title":"Cancel Withdrawal from the Loyalty Card During the Visit","description":"Cancellation of write-off from the loyalty card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_loyalty_card_withdrawal","name":"Cancel Withdrawal from the Loyalty Card During the Visit","isWebhook":false,"pointer":"/paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Withdrawal from the Loyalty Card During the Visit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancellation of write-off from the loyalty card."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"card_id","in":"path","schemaId":"schema_280","description":"Client card ID","required":true}],"pointer":"/paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"schemaId":"components/schemas/visit_loyalty_request_data_types","pointer":"/paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visit/loyalty/cancel_card_withdrawal/{location_id}/{card_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/visit/loyalty/cancel_card_withdrawal/{location_id}/{card_id}","href":"loyalty-programs/cancel_loyalty_card_withdrawal","openApiOperationId":"cancel_loyalty_card_withdrawal","summary":"Cancel Withdrawal from the Loyalty Card During the Visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/visit_loyalty_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"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/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/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/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/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":"/loyalty-programs/cancel_loyalty_card_withdrawal"}],"panels":[]}]},"httpPath":"/visit/loyalty/cancel_card_withdrawal/{location_id}/{card_id}"},{"label":"Apply a Discount Promotion in a Visit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/apply_discount_promotion","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/apply_discount_promotion","metadata":{"seo":{"title":"Apply a Discount Promotion in a Visit","description":"Applying a promotion to a visit, it only makes sense if there is a visit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apply_discount_promotion","name":"Apply a Discount Promotion in a Visit","isWebhook":false,"pointer":"/paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a Discount Promotion in a Visit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applying a promotion to a visit, it only makes sense if there is a visit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"card_id","in":"path","schemaId":"schema_280","description":"Client card ID","required":true},{"name":"program_id","in":"path","schemaId":"schema_280","description":"ID of the promotion linked to the card","required":true}],"pointer":"/paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"schemaId":"components/schemas/visit_loyalty_request_data_types","pointer":"/paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visit/loyalty/apply_discount_program/{location_id}/{card_id}/{program_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"program_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/visit/loyalty/apply_discount_program/{location_id}/{card_id}/{program_id}","href":"loyalty-programs/apply_discount_promotion","openApiOperationId":"apply_discount_promotion","summary":"Apply a Discount Promotion in a Visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/visit_loyalty_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"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/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/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/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/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":"/loyalty-programs/apply_discount_promotion"}],"panels":[]}]},"httpPath":"/visit/loyalty/apply_discount_program/{location_id}/{card_id}/{program_id}"},{"label":"Cancel the Application of the Discount Promotion in the Visit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/cancel_discount_promotion","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/cancel_discount_promotion","metadata":{"seo":{"title":"Cancel the Application of the Discount Promotion in the Visit","description":"Cancellation of the promotion applied to the visit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel_discount_promotion","name":"Cancel the Application of the Discount Promotion in the Visit","isWebhook":false,"pointer":"/paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel the Application of the Discount Promotion in the Visit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancellation of the promotion applied to the visit."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"card_id","in":"path","schemaId":"schema_280","description":"Client card ID","required":true},{"name":"program_id","in":"path","schemaId":"schema_280","description":"ID of the promotion linked to the card","required":true}],"pointer":"/paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"schemaId":"components/schemas/visit_loyalty_request_data_types","pointer":"/paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visit/loyalty/cancel_discount_program/{location_id}/{card_id}/{program_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"card_id","in":"path","required":true,"schemaId":"schema_280"},{"name":"program_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/visit/loyalty/cancel_discount_program/{location_id}/{card_id}/{program_id}","href":"loyalty-programs/cancel_discount_promotion","openApiOperationId":"cancel_discount_promotion","summary":"Cancel the Application of the Discount Promotion in the Visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/visit_loyalty_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_request_data_types"}},"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/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/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/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visit_loyalty_cancel_response_data_types","exampleIds":["paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/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":"/loyalty-programs/cancel_discount_promotion"}],"panels":[]}]},"httpPath":"/visit/loyalty/cancel_discount_program/{location_id}/{card_id}/{program_id}"},{"label":"Apply Referral Program During a Visit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/loyalty-programs/apply_referral_program","routeSlug":"/en/b2b-v1/openapi/loyalty-programs/apply_referral_program","metadata":{"seo":{"title":"Apply Referral Program During a Visit","description":"Applying a referral program to a visit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apply_referral_program","name":"Apply Referral Program During a Visit","isWebhook":false,"pointer":"/paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply Referral Program During a Visit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applying a referral program to a visit"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true},{"name":"chain_id","in":"path","schemaId":"schema_280","description":"ID of the chain where the referral program is configured","required":true}],"pointer":"/paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_referral_request_data_types"}},"schemaId":"components/schemas/visit_loyalty_referral_request_data_types","pointer":"/paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/visit/loyalty/apply_referral_program/{location_id}/{chain_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"},{"name":"chain_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/visit_loyalty_referral_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/visit/loyalty/apply_referral_program/{location_id}/{chain_id}","href":"loyalty-programs/apply_referral_program","openApiOperationId":"apply_referral_program","summary":"Apply Referral Program During a Visit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/visit_loyalty_referral_request_data_types","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/visit_loyalty_referral_request_data_types"}},"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/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/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/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/visit_loyalty_apply_response_data_types","exampleIds":["paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/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":"/loyalty-programs/apply_referral_program"}],"panels":[]}]},"httpPath":"/visit/loyalty/apply_referral_program/{location_id}/{chain_id}"}],"content":{"contentType":"group","meta":{"name":"Loyalty Programs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Loyalty Programs","showPageActions":true},{"nodeType":"markdoc","content":"Discount programs, referral programs, and loyalty transactions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company/{location_id}/loyalty/programs/search","summary":"Get a List of Promotions Active in the Location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-programs/get_location_loyalty_program_list","deprecated":false},{"title":"/visit/loyalty/transactions/{visit_id}","summary":"Get loyalty transactions by visit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-programs/get_loyalty_transactions_by_visit","deprecated":false},{"title":"/loyalty/generate_code/{location_id}/{product_id}","summary":"Gift Card/Membership Code Generation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/loyalty-programs/generate_loyalty_code","deprecated":false},{"title":"/visit/loyalty/apply_card_withdrawal/{location_id}/{card_id}","summary":"Apply Deduction from the Loyalty Card in the Visit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-programs/apply_loyalty_card_deduction","deprecated":false},{"title":"/visit/loyalty/cancel_card_withdrawal/{location_id}/{card_id}","summary":"Cancel Withdrawal from the Loyalty Card During the Visit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-programs/cancel_loyalty_card_withdrawal","deprecated":false},{"title":"/visit/loyalty/apply_discount_program/{location_id}/{card_id}/{program_id}","summary":"Apply a Discount Promotion in a Visit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-programs/apply_discount_promotion","deprecated":false},{"title":"/visit/loyalty/cancel_discount_program/{location_id}/{card_id}/{program_id}","summary":"Cancel the Application of the Discount Promotion in the Visit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-programs/cancel_discount_promotion","deprecated":false},{"title":"/visit/loyalty/apply_referral_program/{location_id}/{chain_id}","summary":"Apply Referral Program During a Visit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/loyalty-programs/apply_referral_program","deprecated":false}]}]}]}]}},{"type":"group","label":"Salary","link":"/en/b2b-v1/openapi/salary","routeSlug":"/en/b2b-v1/openapi/salary","items":[{"label":"Receipt of mutual settlements of a team member grouped by date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/search_team_member_calculation_daily_salary","routeSlug":"/en/b2b-v1/openapi/salary/search_team_member_calculation_daily_salary","metadata":{"seo":{"title":"Receipt of mutual settlements of a team member grouped by date","description":"The method allows location owner to get mutual settlements of a team member grouped by date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_team_member_calculation_daily_salary","name":"Receipt of mutual settlements of a team member grouped by date","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receipt of mutual settlements of a team member grouped by date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows location owner to get mutual settlements of a team member grouped by date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_279","description":"Start from date.","required":true,"example":"2026-03-01"},{"name":"date_to","in":"query","schemaId":"schema_279","description":"End to date.","required":true,"example":"2026-03-31"}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/calculation/staff/daily/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"date_from","in":"query","required":true,"example":"2026-03-01","schemaId":"schema_279"},{"name":"date_to","in":"query","required":true,"example":"2026-03-31","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/salary/calculation/staff/daily/{team_member_id}","href":"salary/search_team_member_calculation_daily_salary","openApiOperationId":"search_team_member_calculation_daily_salary","summary":"Receipt of mutual settlements of a team member grouped by date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_363","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_363","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_363","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_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"}}},{"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":"/salary/search_team_member_calculation_daily_salary"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/calculation/staff/daily/{team_member_id}"},{"label":"Receipt of mutual settlements of a team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/search_team_member_calculation_salary","routeSlug":"/en/b2b-v1/openapi/salary/search_team_member_calculation_salary","metadata":{"seo":{"title":"Receipt of mutual settlements of a team member","description":"The method allows location owner to get mutual settlements of a team member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_team_member_calculation_salary","name":"Receipt of mutual settlements of a team member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receipt of mutual settlements of a team member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows location owner to get mutual settlements of a team member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_279","description":"Start from date.","required":true,"example":"2026-03-01"},{"name":"date_to","in":"query","schemaId":"schema_279","description":"End to date.","required":true,"example":"2026-03-31"}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/calculation/staff/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"date_from","in":"query","required":true,"example":"2026-03-01","schemaId":"schema_279"},{"name":"date_to","in":"query","required":true,"example":"2026-03-31","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/salary/calculation/staff/{team_member_id}","href":"salary/search_team_member_calculation_salary","openApiOperationId":"search_team_member_calculation_salary","summary":"Receipt of mutual settlements of a team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_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"}}},{"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":"/salary/search_team_member_calculation_salary"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/calculation/staff/{team_member_id}"},{"label":"Obtaining payroll schemes count for a team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/get_team_member_calculation_schemes_count","routeSlug":"/en/b2b-v1/openapi/salary/get_team_member_calculation_schemes_count","metadata":{"seo":{"title":"Obtaining payroll schemes count for a team member","description":"The method allows you to get salary calculation schemes count for a team member before trying to obtain calculation data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_calculation_schemes_count","name":"Obtaining payroll schemes count for a team member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtaining payroll schemes count for a team member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get salary calculation schemes count for a team member before trying to obtain calculation data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/calculation/staff/{team_member_id}/salary_schemes_count","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/salary/calculation/staff/{team_member_id}/salary_schemes_count","href":"salary/get_team_member_calculation_schemes_count","openApiOperationId":"get_team_member_calculation_schemes_count","summary":"Obtaining payroll schemes count for a team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_365","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_365","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/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/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_365","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365","exampleIds":["paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/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":"/salary/get_team_member_calculation_schemes_count"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/calculation/staff/{team_member_id}/salary_schemes_count"},{"label":"Search payroll calculations of a team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/search_team_member_payroll_calculation","routeSlug":"/en/b2b-v1/openapi/salary/search_team_member_payroll_calculation","metadata":{"seo":{"title":"Search payroll calculations of a team member","description":"The method allows location owner to search payroll calculations for the period for a team member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_team_member_payroll_calculation","name":"Search payroll calculations of a team member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search payroll calculations of a team member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows location owner to search payroll calculations for the period for a team member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_279","description":"Start from date.","required":true,"example":"2026-03-01"},{"name":"date_to","in":"query","schemaId":"schema_279","description":"End to date.","required":true,"example":"2026-03-31"}],"pointer":"/paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"date_from","in":"query","required":true,"example":"2026-03-01","schemaId":"schema_279"},{"name":"date_to","in":"query","required":true,"example":"2026-03-31","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation","href":"salary/search_team_member_payroll_calculation","openApiOperationId":"search_team_member_payroll_calculation","summary":"Search payroll calculations of a team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_366","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_366","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/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"}}},{"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":"/salary/search_team_member_payroll_calculation"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation"},{"label":"Get payroll calculation details of a team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/get_team_member_payroll_calculation","routeSlug":"/en/b2b-v1/openapi/salary/get_team_member_payroll_calculation","metadata":{"seo":{"title":"Get payroll calculation details of a team member","description":"The method allows location owner to get details of a specific payroll calculation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_payroll_calculation","name":"Get payroll calculation details of a team member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get payroll calculation details of a team member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows location owner to get details of a specific payroll calculation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123},{"name":"calculation_id","in":"path","schemaId":"schema_280","description":"ID of a salary calculation.","required":true,"example":789}],"pointer":"/paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation/{calculation_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"},{"name":"calculation_id","in":"path","required":true,"example":789,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation/{calculation_id}","href":"salary/get_team_member_payroll_calculation","openApiOperationId":"get_team_member_payroll_calculation","summary":"Get payroll calculation details of a team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_367","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_367","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_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/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_367","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367","exampleIds":["paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_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":"/salary/get_team_member_payroll_calculation"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation/{calculation_id}"},{"label":"Getting payroll for a period for a team member grouped by date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/search_team_member_period_daily_salary","routeSlug":"/en/b2b-v1/openapi/salary/search_team_member_period_daily_salary","metadata":{"seo":{"title":"Getting payroll for a period for a team member grouped by date","description":"The method allows location owner to get the calculation for the period for a team member grouped by date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_team_member_period_daily_salary","name":"Getting payroll for a period for a team member grouped by date","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting payroll for a period for a team member grouped by date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows location owner to get the calculation for the period for a team member grouped by date."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_279","description":"Start from date.","required":true,"example":"2026-03-01"},{"name":"date_to","in":"query","schemaId":"schema_279","description":"End to date.","required":true,"example":"2026-03-31"}],"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/period/staff/daily/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"date_from","in":"query","required":true,"example":"2026-03-01","schemaId":"schema_279"},{"name":"date_to","in":"query","required":true,"example":"2026-03-31","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/salary/period/staff/daily/{team_member_id}","href":"salary/search_team_member_period_daily_salary","openApiOperationId":"search_team_member_period_daily_salary","summary":"Getting payroll for a period for a team member grouped by date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_368","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_368","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_368","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_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"}}},{"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":"/salary/search_team_member_period_daily_salary"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/period/staff/daily/{team_member_id}"},{"label":"Getting payroll for a period for a team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/search_team_member_period_salary","routeSlug":"/en/b2b-v1/openapi/salary/search_team_member_period_salary","metadata":{"seo":{"title":"Getting payroll for a period for a team member","description":"The method allows location owner to get the calculation for the period for a team member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"search_team_member_period_salary","name":"Getting payroll for a period for a team member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting payroll for a period for a team member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows location owner to get the calculation for the period for a team member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_279","description":"Start from date.","required":true,"example":"2026-03-01"},{"name":"date_to","in":"query","schemaId":"schema_279","description":"End to date.","required":true,"example":"2026-03-31"}],"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/period/staff/{team_member_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"date_from","in":"query","required":true,"example":"2026-03-01","schemaId":"schema_279"},{"name":"date_to","in":"query","required":true,"example":"2026-03-31","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/salary/period/staff/{team_member_id}","href":"salary/search_team_member_period_salary","openApiOperationId":"search_team_member_period_salary","summary":"Getting payroll for a period for a team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_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"}}},{"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":"/salary/search_team_member_period_salary"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/period/staff/{team_member_id}"},{"label":"Get Mutual Settlements for a Specific Team Member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/get_team_member_salary_calculation","routeSlug":"/en/b2b-v1/openapi/salary/get_team_member_salary_calculation","metadata":{"seo":{"title":"Get Mutual Settlements for a Specific Team Member","description":"The method allows you to get mutual settlements of a specific team member. In the user's access rights, the checkbox \"Access to payroll only for a specific team member\" must be specified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_salary_calculation","name":"Get Mutual Settlements for a Specific Team Member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Mutual Settlements for a Specific Team Member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get mutual settlements of a specific team member. In the user's access rights, the checkbox \"Access to payroll only for a specific team member\" must be specified."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_279","description":"Start from date.","required":true,"example":"2026-03-01"},{"name":"date_to","in":"query","schemaId":"schema_279","description":"End to date.","required":true,"example":"2026-03-31"}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/staff/{team_member_id}/calculation","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"date_from","in":"query","required":true,"example":"2026-03-01","schemaId":"schema_279"},{"name":"date_to","in":"query","required":true,"example":"2026-03-31","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/salary/staff/{team_member_id}/calculation","href":"salary/get_team_member_salary_calculation","openApiOperationId":"get_team_member_salary_calculation","summary":"Get Mutual Settlements for a Specific Team Member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/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"}}},{"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":"/salary/get_team_member_salary_calculation"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/staff/{team_member_id}/calculation"},{"label":"Get Payroll for a Specific Team Member for a Given Period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/get_team_member_salary_period","routeSlug":"/en/b2b-v1/openapi/salary/get_team_member_salary_period","metadata":{"seo":{"title":"Get Payroll for a Specific Team Member for a Given Period","description":"The method allows you to get the calculation for the period for a specific team member. In the user's access rights, the checkbox \"Access to payroll only for a specific team member\" must be checked."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_salary_period","name":"Get Payroll for a Specific Team Member for a Given Period","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Payroll for a Specific Team Member for a Given Period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get the calculation for the period for a specific team member.\nIn the user's access rights, the checkbox \"Access to payroll only for a specific team member\" must be checked."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_from","in":"query","schemaId":"schema_279","description":"Start from date.","required":true,"example":"2026-03-01"},{"name":"date_to","in":"query","schemaId":"schema_279","description":"End to date.","required":true,"example":"2026-03-31"}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/staff/{team_member_id}/period","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[{"name":"date_from","in":"query","required":true,"example":"2026-03-01","schemaId":"schema_279"},{"name":"date_to","in":"query","required":true,"example":"2026-03-31","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/company/{location_id}/salary/staff/{team_member_id}/period","href":"salary/get_team_member_salary_period","openApiOperationId":"get_team_member_salary_period","summary":"Get Payroll for a Specific Team Member for a Given Period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_369","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_369","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/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"},{"code":"422","description":"Unprocessable Entity","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/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/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"}}},{"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":"/salary/get_team_member_salary_period"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/staff/{team_member_id}/period"},{"label":"Obtaining own payroll schemes for a specific team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/salary/get_team_member_salary_schemes","routeSlug":"/en/b2b-v1/openapi/salary/get_team_member_salary_schemes","metadata":{"seo":{"title":"Obtaining own payroll schemes for a specific team member","description":"The method allows you to get own salary calculation schemes for a specific team member. In the user's access rights, the checkbox \"Access to payroll only for a specific team member\" must be specified."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_salary_schemes","name":"Obtaining own payroll schemes for a specific team member","isWebhook":false,"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtaining own payroll schemes for a specific team member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The method allows you to get own salary calculation schemes for a specific team member.\nIn the user's access rights, the checkbox \"Access to payroll only for a specific team member\" must be specified."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"ID of a location.","required":true,"example":123},{"name":"team_member_id","in":"path","schemaId":"schema_286","description":"ID of a team member.","required":true,"example":123}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required B2B v2 response media type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is also accepted."},"children":[]}]}]}],"required":true,"example":"application/vnd.api.v2+json"},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Should be equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]}],"required":true,"example":"application/json"}],"pointer":"/paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/company/{location_id}/salary/staff/{team_member_id}/salary_schemes","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"example":123,"schemaId":"schema_280"},{"name":"team_member_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"example":"application/json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/company/{location_id}/salary/staff/{team_member_id}/salary_schemes","href":"salary/get_team_member_salary_schemes","openApiOperationId":"get_team_member_salary_schemes","summary":"Obtaining own payroll schemes for a specific team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_370","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_370","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/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/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_370","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370","exampleIds":["paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/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":"/salary/get_team_member_salary_schemes"}],"panels":[]}]},"httpPath":"/company/{location_id}/salary/staff/{team_member_id}/salary_schemes"}],"content":{"contentType":"group","meta":{"name":"Salary"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Salary","showPageActions":true},{"nodeType":"markdoc","content":"Staff salary calculations, payroll, and schemes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/company/{location_id}/salary/calculation/staff/daily/{team_member_id}","summary":"Receipt of mutual settlements of a team member grouped by date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/search_team_member_calculation_daily_salary","deprecated":false},{"title":"/company/{location_id}/salary/calculation/staff/{team_member_id}","summary":"Receipt of mutual settlements of a team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/search_team_member_calculation_salary","deprecated":false},{"title":"/company/{location_id}/salary/calculation/staff/{team_member_id}/salary_schemes_count","summary":"Obtaining payroll schemes count for a team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/get_team_member_calculation_schemes_count","deprecated":false},{"title":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation","summary":"Search payroll calculations of a team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/search_team_member_payroll_calculation","deprecated":false},{"title":"/company/{location_id}/salary/payroll/staff/{team_member_id}/calculation/{calculation_id}","summary":"Get payroll calculation details of a team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/get_team_member_payroll_calculation","deprecated":false},{"title":"/company/{location_id}/salary/period/staff/daily/{team_member_id}","summary":"Getting payroll for a period for a team member grouped by date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/search_team_member_period_daily_salary","deprecated":false},{"title":"/company/{location_id}/salary/period/staff/{team_member_id}","summary":"Getting payroll for a period for a team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/search_team_member_period_salary","deprecated":false},{"title":"/company/{location_id}/salary/staff/{team_member_id}/calculation","summary":"Get Mutual Settlements for a Specific Team Member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/get_team_member_salary_calculation","deprecated":false},{"title":"/company/{location_id}/salary/staff/{team_member_id}/period","summary":"Get Payroll for a Specific Team Member for a Given Period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/get_team_member_salary_period","deprecated":false},{"title":"/company/{location_id}/salary/staff/{team_member_id}/salary_schemes","summary":"Obtaining own payroll schemes for a specific team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/salary/get_team_member_salary_schemes","deprecated":false}]}]}]}]}},{"type":"group","label":"Notification Settings","link":"/en/b2b-v1/openapi/notification-settings","routeSlug":"/en/b2b-v1/openapi/notification-settings","items":[],"content":{"contentType":"group","meta":{"name":"Notification Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Settings","showPageActions":true},{"nodeType":"markdoc","content":"Configure notification types and user preferences"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notification-settings"}],"panels":[]}]}},{"type":"group","label":"Custom Fields","link":"/en/b2b-v1/openapi/custom-fields","routeSlug":"/en/b2b-v1/openapi/custom-fields","items":[{"label":"Getting a collection of location fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/custom-fields/get_custom_field_list","routeSlug":"/en/b2b-v1/openapi/custom-fields/get_custom_field_list","metadata":{"seo":{"title":"Getting a collection of location fields","description":"Getting a collection of location fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_custom_field_list","name":"Getting a collection of location fields","isWebhook":false,"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting a collection of location fields","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"field_category","in":"path","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field category."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For appointments - appointment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For clients - client "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}]}],"required":true,"example":"record"},{"name":"location_id","in":"path","schemaId":"schema_286","description":"location ID","required":true}],"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1custom_fields~1{field_category}~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custom_fields/{field_category}/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"field_category","in":"path","required":true,"example":"record","schemaId":"schema_279"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/custom_fields/{field_category}/{location_id}","href":"custom-fields/get_custom_field_list","openApiOperationId":"get_custom_field_list","summary":"Getting a collection of location fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~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/~1custom_fields~1{field_category}~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~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":"/custom-fields/get_custom_field_list"}],"panels":[]}]},"httpPath":"/custom_fields/{field_category}/{location_id}"},{"label":"Adding a Custom Field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/custom-fields/create_custom_field","routeSlug":"/en/b2b-v1/openapi/custom-fields/create_custom_field","metadata":{"seo":{"title":"Adding a Custom Field","description":"To add a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section: Settings → Access → Custom Fields → Create custom fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_custom_field","name":"Adding a Custom Field","isWebhook":false,"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adding a Custom Field","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":"To add a field, the user must be part of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain associated with the location"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and have the appropriate access rights in the following section: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings → Access → Custom Fields → Create custom fields"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"field_category","in":"path","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field category."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For appointments - appointment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For clients - client "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}]}],"required":true,"example":"record"},{"name":"location_id","in":"path","schemaId":"schema_286","description":"location ID","required":true}],"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1custom_fields~1{field_category}~1{location_id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/custom_fields_request_data_type"}},"schemaId":"components/schemas/custom_fields_request_data_type","pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/custom_fields/{field_category}/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"field_category","in":"path","required":true,"example":"record","schemaId":"schema_279"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/custom_fields_request_data_type"}},"responseCodes":["200","401","403","404"],"pointer":"/custom_fields/{field_category}/{location_id}","href":"custom-fields/create_custom_field","openApiOperationId":"create_custom_field","summary":"Adding a Custom Field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/custom_fields_request_data_type","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/custom_fields_request_data_type"}},"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/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}/post/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/~1custom_fields~1{field_category}~1{location_id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}/post/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":"/custom-fields/create_custom_field"}],"panels":[]}]},"httpPath":"/custom_fields/{field_category}/{location_id}"},{"label":"Update a Custom Field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/custom-fields/update_custom_field","routeSlug":"/en/b2b-v1/openapi/custom-fields/update_custom_field","metadata":{"seo":{"title":"Update a Custom Field","description":"To update a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section Settings → Access → Custom Fields → Modify custom fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_custom_field","name":"Update a Custom Field","isWebhook":false,"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Custom Field","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":"To update a field, the user must be part of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain associated with the location"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and have the appropriate access rights in the following section "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings → Access → Custom Fields → Modify custom fields"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"field_category","in":"path","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field category."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For appointments - appointment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For clients - client "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}]}],"required":true,"example":"record"},{"name":"location_id","in":"path","schemaId":"schema_286","description":"location ID","required":true},{"name":"field_id","in":"path","schemaId":"schema_286","description":"field ID","required":true}],"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/custom_fields_request_data_type"}},"schemaId":"components/schemas/custom_fields_request_data_type","pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/custom_fields/{field_category}/{location_id}/{field_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"field_category","in":"path","required":true,"example":"record","schemaId":"schema_279"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"field_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/custom_fields_request_data_type"}},"responseCodes":["202","403","404"],"pointer":"/custom_fields/{field_category}/{location_id}/{field_id}","href":"custom-fields/update_custom_field","openApiOperationId":"update_custom_field","summary":"Update a Custom Field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/custom_fields_request_data_type","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/custom_fields_request_data_type"}},"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/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/202/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/202/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/update_custom_field"}],"panels":[]}]},"httpPath":"/custom_fields/{field_category}/{location_id}/{field_id}"},{"label":"Remove a Custom Field from a Location","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/custom-fields/delete_custom_field","routeSlug":"/en/b2b-v1/openapi/custom-fields/delete_custom_field","metadata":{"seo":{"title":"Remove a Custom Field from a Location","description":"To remove a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section: Settings → Access → Custom Fields → Remove custom fields"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_custom_field","name":"Remove a Custom Field from a Location","isWebhook":false,"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a Custom Field from 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":"text","inline":true,"attributes":{"content":"To remove a field, the user must be part of the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain associated with the location"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and have the appropriate access rights in the following section: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings → Access → Custom Fields → Remove custom fields"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"field_category","in":"path","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field category."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For appointments - appointment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For clients - client "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}]}]}],"required":true,"example":"record"},{"name":"location_id","in":"path","schemaId":"schema_286","description":"location ID","required":true},{"name":"field_id","in":"path","schemaId":"schema_286","description":"field ID","required":true}],"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/custom_fields/{field_category}/{location_id}/{field_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"field_category","in":"path","required":true,"example":"record","schemaId":"schema_279"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"field_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/custom_fields/{field_category}/{location_id}/{field_id}","href":"custom-fields/delete_custom_field","openApiOperationId":"delete_custom_field","summary":"Remove a Custom Field from a Location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/200/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/200/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom_fields_response_data_types","exampleIds":["paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/delete_custom_field"}],"panels":[]}]},"httpPath":"/custom_fields/{field_category}/{location_id}/{field_id}"}],"content":{"contentType":"group","meta":{"name":"Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":"Custom field definitions for various entities"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custom_fields/{field_category}/{location_id}","summary":"Getting a collection of location fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/get_custom_field_list","deprecated":false},{"title":"/custom_fields/{field_category}/{location_id}","summary":"Adding a Custom Field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-fields/create_custom_field","deprecated":false},{"title":"/custom_fields/{field_category}/{location_id}/{field_id}","summary":"Update a Custom Field","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-fields/update_custom_field","deprecated":false},{"title":"/custom_fields/{field_category}/{location_id}/{field_id}","summary":"Remove a Custom Field from a Location","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-fields/delete_custom_field","deprecated":false}]}]}]}]}},{"type":"group","label":"Chain Management","link":"/en/b2b-v1/openapi/chain-management","routeSlug":"/en/b2b-v1/openapi/chain-management","items":[{"label":"Obtaining chains available to the user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-management/get_chain_list","routeSlug":"/en/b2b-v1/openapi/chain-management/get_chain_list","metadata":{"seo":{"title":"Obtaining chains available to the user","description":"The location chain object has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_list","name":"Obtaining chains available to the user","isWebhook":false,"pointer":"/paths/~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtaining chains available to the user","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":"The location chain object has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"number"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location chain ID"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location chain name"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"locations"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of chain locations"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"access"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with access rights for chain management"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/groups","servers":[{"url":"/_mock/en/b2b-v1/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_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/groups","href":"chain-management/get_chain_list","openApiOperationId":"get_chain_list","summary":"Obtaining chains available to the user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/groups_response_data_types","exampleIds":["paths/~1groups/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/groups_response_data_types","exampleIds":["paths/~1groups/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/~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/groups_response_data_types","exampleIds":["paths/~1groups/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/groups_response_data_types","exampleIds":["paths/~1groups/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":"/chain-management/get_chain_list"}],"panels":[]}]},"httpPath":"/groups"},{"label":"Get a chain client by phone number.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-management/get_chain_client_by_phone_number","routeSlug":"/en/b2b-v1/openapi/chain-management/get_chain_client_by_phone_number","metadata":{"seo":{"title":"Get a chain client by phone number.","description":"Parametergroup_id (required, number, 43877) - ID of the location chain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_client_by_phone_number","name":"Get a chain client by phone number.","isWebhook":false,"pointer":"/paths/~1group~1{chain_id}~1clients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a chain client by phone number.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$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":"Parameter"},"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":"group_id (required, number, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"43877"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - ID of the location chain"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"chain-management/get_chain_client_by_phone_number/request/client-filtering","deepLinkHash":"/chain-management/get_chain_client_by_phone_number#chain-management/get_chain_client_by_phone_number/request/client-filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client filtering"},"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":"phone:'+13155550175' (optional, string) - Phone to filter clients"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_280","description":"Chain ID","required":true}],"pointer":"/paths/~1group~1{chain_id}~1clients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"phone","in":"query","schemaId":"schema_279","description":"Phone to filter clients, required parameter","required":true,"example":"14264037640"}],"pointer":"/paths/~1group~1{chain_id}~1clients/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1group~1{chain_id}~1clients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group/{chain_id}/clients","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[{"name":"phone","in":"query","required":true,"example":"14264037640","schemaId":"schema_279"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/group/{chain_id}/clients","href":"chain-management/get_chain_client_by_phone_number","openApiOperationId":"get_chain_client_by_phone_number","summary":"Get a chain client by phone number."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/group_groupid_clients_response_data_types","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/group_groupid_clients_response_data_types","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/200/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/group_groupid_clients_response_data_types400","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/group_groupid_clients_response_data_types400","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1group~1{chain_id}~1clients/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/group_groupid_clients_response_data_types","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/group_groupid_clients_response_data_types","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/200/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/group_groupid_clients_response_data_types400","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/group_groupid_clients_response_data_types400","exampleIds":["paths/~1group~1{chain_id}~1clients/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-management/get_chain_client_by_phone_number"}],"panels":[]}]},"httpPath":"/group/{chain_id}/clients"}],"content":{"contentType":"group","meta":{"name":"Chain Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chain Management","showPageActions":true},{"nodeType":"markdoc","content":"Multi-location chain operations and clients"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/groups","summary":"Obtaining chains available to the user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-management/get_chain_list","deprecated":false},{"title":"/group/{chain_id}/clients","summary":"Get a chain client by phone number.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-management/get_chain_client_by_phone_number","deprecated":false}]}]}]}]}},{"type":"group","label":"Chain Loyalty Programs","link":"/en/b2b-v1/openapi/chain-loyalty-programs","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs","items":[{"label":"Freeze membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_freeze","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_freeze","metadata":{"seo":{"title":"Freeze membership","description":"Freezes a subscription (membership) until the specified date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_memberships_freeze","name":"Freeze membership","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1freeze/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Freeze membership","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":"Freezes a subscription (membership) until the specified date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subscription's expiration date will be extended by the freeze period."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Frozen subscriptions cannot be used for appointments."},"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":"Requirements:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Membership type must have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allow_freeze: true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freeze period must not exceed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"freeze_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from membership type"},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"membership_id","in":"path","schemaId":"schema_286","description":"Membership ID to freeze","required":true,"example":123}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1freeze/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1freeze/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"schemaId":"schema_371","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1freeze/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/abonements/{membership_id}/freeze","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"membership_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_371"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonements/{membership_id}/freeze","href":"chain-loyalty-programs/chain_loyalty_memberships_freeze","openApiOperationId":"chain_loyalty_memberships_freeze","summary":"Freeze membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_371"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription frozen successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372"},{"code":"400","description":"Bad Request - membership cannot be frozen","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error (freeze limit exceeded, freeze not allowed, etc.)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1freeze/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"400","schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_memberships_freeze"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonements/{membership_id}/freeze"},{"label":"Unfreeze membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_unfreeze","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_unfreeze","metadata":{"seo":{"title":"Unfreeze membership","description":"Removes the freeze from a subscription (membership)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_memberships_unfreeze","name":"Unfreeze membership","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1unfreeze/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unfreeze membership","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":"Removes the freeze from a subscription (membership)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subscription's expiration date will remain extended by the freeze period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that was already applied during the freeze."},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"membership_id","in":"path","schemaId":"schema_286","description":"Membership ID to unfreeze","required":true,"example":123}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1unfreeze/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1unfreeze/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1unfreeze/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/abonements/{membership_id}/unfreeze","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"membership_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_375"}},"responseCodes":["200","400","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/abonements/{membership_id}/unfreeze","href":"chain-loyalty-programs/chain_loyalty_memberships_unfreeze","openApiOperationId":"chain_loyalty_memberships_unfreeze","summary":"Unfreeze membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription unfrozen successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}},"schemaId":"schema_376"},{"code":"400","description":"Bad Request - membership is not frozen","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1unfreeze/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_376","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}}},{"code":"400","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_memberships_unfreeze"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonements/{membership_id}/unfreeze"},{"label":"Change membership balance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_set_balance","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_set_balance","metadata":{"seo":{"title":"Change membership balance","description":"Modifies the remaining visit count for a subscription (membership)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_memberships_set_balance","name":"Change membership balance","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_balance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change membership balance","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":"Modifies the remaining visit count for a subscription (membership)."},"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":"For unified balance subscriptions:"},"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":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"united_balance_services_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set total visits"},"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":"For separate balance subscriptions:"},"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":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services_balance_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array with service_id and balance for each service/category"},"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":"Use cases:"},"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":"Adjust balance after administrative changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correct errors in visit counts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add bonus visits"},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"membership_id","in":"path","schemaId":"schema_286","description":"Membership ID","required":true,"example":123}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_balance/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_balance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_balance/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_balance","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"membership_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_378"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_balance","href":"chain-loyalty-programs/chain_loyalty_memberships_set_balance","openApiOperationId":"chain_loyalty_memberships_set_balance","summary":"Change membership balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_378"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Balance updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379"},{"code":"400","description":"Bad Request - cannot change balance","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error (invalid balance values, wrong membership type, etc.)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_balance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}}},{"code":"400","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_memberships_set_balance"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_balance"},{"label":"Change membership validity period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_set_period","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_memberships_set_period","metadata":{"seo":{"title":"Change membership validity period","description":"Modifies the validity period (duration) of a subscription (membership)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_memberships_set_period","name":"Change membership validity period","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_period/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change membership validity period","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":"Modifies the validity period (duration) of a subscription (membership)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This changes how long the subscription remains active before expiring."},"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":"Period units:"},"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":"1 = day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = year"},"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":"Use cases:"},"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":"Extend expiration as customer service gesture"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adjust period after policy changes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correct administrative errors"},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"membership_id","in":"path","schemaId":"schema_286","description":"Membership ID","required":true,"example":123}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_period/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_period/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_period/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_period","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"membership_id","in":"path","required":true,"example":123,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_382"}},"responseCodes":["200","400","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_period","href":"chain-loyalty-programs/chain_loyalty_memberships_set_period","openApiOperationId":"chain_loyalty_memberships_set_period","summary":"Change membership validity period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Period updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383"},{"code":"400","description":"Bad Request - cannot change period","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Subscription not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error (invalid period values, etc.)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonements~1{membership_id}~1set_period/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}}},{"code":"400","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_memberships_set_period"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_period"},{"label":"List membership types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_list","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_list","metadata":{"seo":{"title":"List membership types","description":"Retrieves all membership types available in the chain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_list","name":"List membership types","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List membership types","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 all membership types available in the chain."},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/abonement_types","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/chain/{chain_id}/loyalty/abonement_types","href":"chain-loyalty-programs/chain_loyalty_membership_types_list","openApiOperationId":"chain_loyalty_membership_types_list","summary":"List membership types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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 membership types retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_list"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types"},{"label":"Create membership type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_create","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_create","metadata":{"seo":{"title":"Create membership type","description":"Creates a new membership type at the chain level. Membership types define reusable packages(e.g., \"10 visits\", \"Monthly unlimited\") that can be sold across multiple locations in the chain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_create","name":"Create membership type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create membership type","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":"Creates a new membership type at the chain level. Membership types define reusable packages"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(e.g., \"10 visits\", \"Monthly unlimited\") that can be sold across multiple locations in the chain."},"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":"Important API Differences:"},"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":"code","inline":true,"attributes":{"content":"services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"objects"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (key-value pairs), not arrays"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"service_id\": count}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[service_id]"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some legacy documentation shows arrays, but the real API requires objects"},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":1}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/abonement_types","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":1,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_387"}},"responseCodes":["200","201","400","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonement_types","href":"chain-loyalty-programs/chain_loyalty_membership_types_create","openApiOperationId":"chain_loyalty_membership_types_create","summary":"Create membership type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Membership type created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"201","description":"Membership type created successfully (alternate code)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"400","description":"Bad Request - validation errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Chain not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"201","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"400","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_create"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types"},{"label":"Get membership type details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_read","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_read","metadata":{"seo":{"title":"Get membership type details","description":"Retrieves detailed information about a specific membership type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_read","name":"Get membership type details","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get membership type details","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 detailed information about a specific membership type."},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":1},{"name":"loyalty_membership_type_id","in":"path","schemaId":"schema_286","description":"Membership type ID","required":true,"example":468039}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":1,"schemaId":"schema_286"},{"name":"loyalty_membership_type_id","in":"path","required":true,"example":468039,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","href":"chain-loyalty-programs/chain_loyalty_membership_types_read","openApiOperationId":"chain_loyalty_membership_types_read","summary":"Get membership type details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Membership type details retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Membership type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_read"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}"},{"label":"Update membership type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_update","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_update","metadata":{"seo":{"title":"Update membership type","description":"Updates an existing membership type. You can update basic information(title, cost, period) without modifying the service/category links."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_update","name":"Update membership type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update membership type","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 an existing membership type. You can update basic information"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(title, cost, period) without modifying the service/category links."},"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":" To preserve existing services, pass empty arrays for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":1},{"name":"loyalty_membership_type_id","in":"path","schemaId":"schema_286","description":"Membership type ID","required":true,"example":468039}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":1,"schemaId":"schema_286"},{"name":"loyalty_membership_type_id","in":"path","required":true,"example":468039,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_389"}},"responseCodes":["200","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","href":"chain-loyalty-programs/chain_loyalty_membership_types_update","openApiOperationId":"chain_loyalty_membership_types_update","summary":"Update membership type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Membership type updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Membership type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_291"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_update"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}"},{"label":"Delete membership type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_delete","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_delete","metadata":{"seo":{"title":"Delete membership type","description":"Deletes a membership type from the chain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_delete","name":"Delete membership type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete membership type","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":"Deletes a membership type from the chain."},"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":"Warning:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This action cannot be undone. Active subscriptions using this type"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may be affected."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":1},{"name":"loyalty_membership_type_id","in":"path","schemaId":"schema_286","description":"Membership type ID to delete","required":true,"example":468039}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":1,"schemaId":"schema_286"},{"name":"loyalty_membership_type_id","in":"path","required":true,"example":468039,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","href":"chain-loyalty-programs/chain_loyalty_membership_types_delete","openApiOperationId":"chain_loyalty_membership_types_delete","summary":"Delete membership type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"Membership type deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}},"schemaId":"schema_390"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Membership type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error (e.g., membership type is in use)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_390","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_delete"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}"},{"label":"Clone membership type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_clone","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_clone","metadata":{"seo":{"title":"Clone membership type","description":"Creates a copy of an existing membership type with a new ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_clone","name":"Clone membership type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1clone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone membership type","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":"Creates a copy of an existing membership type with a new ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cloned membership type will:"},"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":"Have the same settings (cost, period, services, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a modified title with \" (2)\" suffix automatically added"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have a new unique ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preserve all service/category links from the original"},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":1},{"name":"loyalty_membership_type_id","in":"path","schemaId":"schema_286","description":"Membership type ID to clone","required":true,"example":489159}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1clone/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1clone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1clone/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/clone","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":1,"schemaId":"schema_286"},{"name":"loyalty_membership_type_id","in":"path","required":true,"example":489159,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_375"}},"responseCodes":["200","201","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/clone","href":"chain-loyalty-programs/chain_loyalty_membership_types_clone","openApiOperationId":"chain_loyalty_membership_types_clone","summary":"Clone membership type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_375"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Membership type cloned successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"201","description":"Membership type cloned successfully (alternate code)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Source membership type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1clone/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"201","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_clone"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/clone"},{"label":"Restore deleted membership type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_restore","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_restore","metadata":{"seo":{"title":"Restore deleted membership type","description":"Restores a previously deleted membership type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_restore","name":"Restore deleted membership type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1restore/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore deleted membership type","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":"Restores a previously deleted membership type."},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":1},{"name":"loyalty_membership_type_id","in":"path","schemaId":"schema_286","description":"Membership type ID to restore","required":true,"example":489159}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1restore/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1restore/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"schemaId":"schema_391","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1restore/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/restore","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":1,"schemaId":"schema_286"},{"name":"loyalty_membership_type_id","in":"path","required":true,"example":489159,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_391"}},"responseCodes":["204","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/restore","href":"chain-loyalty-programs/chain_loyalty_membership_types_restore","openApiOperationId":"chain_loyalty_membership_types_restore","summary":"Restore deleted membership type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_391","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_391"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Membership type restored successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Membership type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1restore/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_restore"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/restore"},{"label":"Archive or unarchive membership type","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_archive","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_membership_types_archive","metadata":{"seo":{"title":"Archive or unarchive membership type","description":"Archives or unarchives a membership type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_membership_types_archive","name":"Archive or unarchive membership type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1archive/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive or unarchive membership type","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":"Archives or unarchives a membership type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archived membership types:"},"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":"Cannot be sold to new clients"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing active memberships remain functional"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be unarchived at any time"},"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":" Requires chain-level permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":1},{"name":"loyalty_membership_type_id","in":"path","schemaId":"schema_286","description":"Membership type ID","required":true,"example":489159}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1archive/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1archive/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1archive/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/archive","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":1,"schemaId":"schema_286"},{"name":"loyalty_membership_type_id","in":"path","required":true,"example":489159,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_392"}},"responseCodes":["204","401","403","404","422"],"pointer":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/archive","href":"chain-loyalty-programs/chain_loyalty_membership_types_archive","openApiOperationId":"chain_loyalty_membership_types_archive","summary":"Archive or unarchive membership type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_392"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Archive status updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Membership type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1abonement_types~1{loyalty_membership_type_id}~1archive/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"422","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_membership_types_archive"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/archive"},{"label":"List certificate types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_list","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_list","metadata":{"seo":{"title":"List certificate types","description":"Retrieves a list of certificate types at the chain level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_certificate_types_list","name":"List certificate types","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List certificate types","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 a list of certificate types at the chain level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all certificate types configured for the chain with optional filtering"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and pagination."},"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":"Query Parameters:"},"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":"code","inline":true,"attributes":{"content":"title"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Filter by certificate type name (partial match)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Page number (default: 1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page_size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Items per page (default: 10, max: 100)"},"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":"Item Type Restrictions:"},"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":"0 = All services and products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = Any services (no products)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = Any products (no services)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = Specific services only (no products)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = Specific services + any products"},"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":"Expiration Types:"},"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":"0 = No expiration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = Fixed date for all instances"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = Fixed period from sale date"},"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":"Expiration Units:"},"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":"1 = day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = year"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"title","in":"query","schemaId":"schema_279","description":"Filter by certificate type name (partial match)","example":"Gift"},{"name":"page","in":"query","schemaId":"schema_393","description":"Page number","example":1},{"name":"page_size","in":"query","schemaId":"schema_394","description":"Items per page (max 100)","example":10}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1certificate_types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/certificate_types","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"}],"query":[{"name":"title","in":"query","required":false,"example":"Gift","schemaId":"schema_279"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_393"},{"name":"page_size","in":"query","required":false,"example":10,"schemaId":"schema_394"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/chain/{chain_id}/loyalty/certificate_types","href":"chain-loyalty-programs/chain_loyalty_certificate_types_list","openApiOperationId":"chain_loyalty_certificate_types_list","summary":"List certificate types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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 certificate types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_certificate_types_list"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/certificate_types"},{"label":"Create certificate type","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_create","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_create","metadata":{"seo":{"title":"Create certificate type","description":"Creates a new certificate type at the chain level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_certificate_types_create","name":"Create certificate type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create certificate type","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":"Creates a new certificate type at the chain level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certificate types define gift certificate templates that can be sold across multiple locations."},"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":"Item Type Restrictions:"},"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":"0 = All services and products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = Any services (no products)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = Any products (no services)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = Specific services only (no products)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = Specific services + any products"},"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":"Expiration Types:"},"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":"0 = No expiration"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1 = Fixed date for all instances"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = Fixed period from sale date"},"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":"Expiration Units:"},"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":"1 = day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3 = month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4 = year"},"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":"Balance Edit Types:"},"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":"1 = Can be edited"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 = Cannot be edited"},"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":" After creation, certificate products are automatically created in inventory."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1certificate_types/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/certificate_types","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_396"}},"responseCodes":["200","400","401","403"],"pointer":"/chain/{chain_id}/loyalty/certificate_types","href":"chain-loyalty-programs/chain_loyalty_certificate_types_create","openApiOperationId":"chain_loyalty_certificate_types_create","summary":"Create certificate type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_396"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Certificate type created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397"},{"code":"400","description":"Bad Request - validation errors","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}}},{"code":"400","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_certificate_types_create"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/certificate_types"},{"label":"Get certificate type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_get","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_get","metadata":{"seo":{"title":"Get certificate type","description":"Retrieves a specific certificate type by ID at the chain level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_certificate_types_get","name":"Get certificate type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get certificate type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a specific certificate type by ID at the chain level.\n\nReturns complete certificate type configuration including expiration rules,\nrestrictions, and online sale settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"type_id","in":"path","schemaId":"schema_286","description":"Certificate type ID","required":true,"example":289056}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"type_id","in":"path","required":true,"example":289056,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","href":"chain-loyalty-programs/chain_loyalty_certificate_types_get","openApiOperationId":"chain_loyalty_certificate_types_get","summary":"Get certificate type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Certificate type details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Certificate type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_certificate_types_get"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/certificate_types/{type_id}"},{"label":"Update certificate type","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_update","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_update","metadata":{"seo":{"title":"Update certificate type","description":"Updates an existing certificate type at the chain level."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_certificate_types_update","name":"Update certificate type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update certificate type","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 an existing certificate type at the chain level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields from creation are required. Use GET first to retrieve current values,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"then modify needed fields and send complete object."},"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":" Cannot update certificate types that have already been issued."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"type_id","in":"path","schemaId":"schema_286","description":"Certificate type ID","required":true,"example":289056}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_287","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"type_id","in":"path","required":true,"example":289056,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_287"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_400"}},"responseCodes":["200","400","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","href":"chain-loyalty-programs/chain_loyalty_certificate_types_update","openApiOperationId":"chain_loyalty_certificate_types_update","summary":"Update certificate type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_400"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Certificate type updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401"},{"code":"400","description":"Bad Request - validation errors or certificate already issued","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Certificate type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400","schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_certificate_types_update"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/certificate_types/{type_id}"},{"label":"Delete certificate type","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_delete","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/chain_loyalty_certificate_types_delete","metadata":{"seo":{"title":"Delete certificate type","description":"Deletes a certificate type from the chain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"chain_loyalty_certificate_types_delete","name":"Delete certificate type","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete certificate type","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":"Deletes a certificate type from the chain."},"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":"Warning:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This action cannot be undone. Certificate types that have"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"issued certificates cannot be deleted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true,"example":706028},{"name":"type_id","in":"path","schemaId":"schema_286","description":"Certificate type ID to delete","required":true,"example":289056}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_282","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"example":706028,"schemaId":"schema_286"},{"name":"type_id","in":"path","required":true,"example":289056,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_282"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","href":"chain-loyalty-programs/chain_loyalty_certificate_types_delete","openApiOperationId":"chain_loyalty_certificate_types_delete","summary":"Delete certificate type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Certificate type deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}},"schemaId":"schema_390"},{"code":"204","description":"Certificate type deleted successfully (no content)"},{"code":"400","description":"Bad Request - certificate type has issued certificates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}},"schemaId":"schema_403"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"403","description":"Forbidden - insufficient permissions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"},{"code":"404","description":"Certificate type not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1certificate_types~1{type_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_390","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}}},{"code":"204"},{"code":"400","schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}}},{"code":"401","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"403","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}},{"code":"404","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/chain_loyalty_certificate_types_delete"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/certificate_types/{type_id}"},{"label":"Create a Chain Promotion","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/create_chain_loyalty_program","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/create_chain_loyalty_program","metadata":{"seo":{"title":"Create a Chain Promotion","description":"Create a Chain Promotion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_chain_loyalty_program","name":"Create a Chain Promotion","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Chain Promotion","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_404","description":"Include additional resources in the answer"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1programs/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/loyalty_program_create_request"}},"schemaId":"components/schemas/loyalty_program_create_request","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chain/{chain_id}/loyalty/programs","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[{"name":"include","in":"query","schemaId":"schema_404"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/loyalty_program_create_request"}},"responseCodes":["200","422"],"pointer":"/chain/{chain_id}/loyalty/programs","href":"chain-loyalty-programs/create_chain_loyalty_program","openApiOperationId":"create_chain_loyalty_program","summary":"Create a Chain Promotion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/loyalty_program_create_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/loyalty_program_create_request"}},"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/loyalty_program"}},"schemaId":"components/schemas/loyalty_program"},{"code":"422","description":"Validation error"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_program"}}},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/create_chain_loyalty_program"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/programs"},{"label":"Get a Chain Promotion","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/get_chain_loyalty_program","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/get_chain_loyalty_program","metadata":{"seo":{"title":"Get a Chain Promotion","description":"Get a Chain Promotion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_loyalty_program","name":"Get a Chain Promotion","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Chain Promotion","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true},{"name":"loyalty_program_id","in":"path","schemaId":"schema_286","description":"Promotion ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_404","description":"Include additional resources in the answer"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"loyalty_program_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[{"name":"include","in":"query","schemaId":"schema_404"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","href":"chain-loyalty-programs/get_chain_loyalty_program","openApiOperationId":"get_chain_loyalty_program","summary":"Get a Chain Promotion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_program"}},"schemaId":"components/schemas/loyalty_program"},{"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/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_program"}}},{"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":"/chain-loyalty-programs/get_chain_loyalty_program"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}"},{"label":"Edit Chain Promotion","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/update_chain_loyalty_program","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/update_chain_loyalty_program","metadata":{"seo":{"title":"Edit Chain Promotion","description":"Edit Chain Promotion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_chain_loyalty_program","name":"Edit Chain Promotion","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit Chain Promotion","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true},{"name":"loyalty_program_id","in":"path","schemaId":"schema_286","description":"Promotion ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_404","description":"Include additional resources in the answer"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/loyalty_program_update_request"}},"schemaId":"components/schemas/loyalty_program_update_request","pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"loyalty_program_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[{"name":"include","in":"query","schemaId":"schema_404"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/loyalty_program_update_request"}},"responseCodes":["200","422"],"pointer":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","href":"chain-loyalty-programs/update_chain_loyalty_program","openApiOperationId":"update_chain_loyalty_program","summary":"Edit Chain Promotion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/loyalty_program_update_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/loyalty_program_update_request"}},"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/loyalty_program"}},"schemaId":"components/schemas/loyalty_program"},{"code":"422","description":"Validation error"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_program"}}},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/update_chain_loyalty_program"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}"},{"label":"Delete Chain Promotion","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/delete_chain_loyalty_program","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/delete_chain_loyalty_program","metadata":{"seo":{"title":"Delete Chain Promotion","description":"Delete Chain Promotion"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_chain_loyalty_program","name":"Delete Chain Promotion","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Chain Promotion","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true},{"name":"loyalty_program_id","in":"path","schemaId":"schema_286","description":"Promotion ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_404","description":"Include additional resources in the answer"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"loyalty_program_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[{"name":"include","in":"query","schemaId":"schema_404"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","href":"chain-loyalty-programs/delete_chain_loyalty_program","openApiOperationId":"delete_chain_loyalty_program","summary":"Delete Chain Promotion"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"204","description":"No content"},{"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/~1chain~1{chain_id}~1loyalty~1programs~1{loyalty_program_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"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":"/chain-loyalty-programs/delete_chain_loyalty_program"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}"},{"label":"Get a List of Chain Loyalty Transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/get_chain_loyalty_transaction_list","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/get_chain_loyalty_transaction_list","metadata":{"seo":{"title":"Get a List of Chain Loyalty Transactions","description":"Get a List of Chain Loyalty Transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_loyalty_transaction_list","name":"Get a List of Chain Loyalty Transactions","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a List of Chain Loyalty Transactions","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_after","in":"query","schemaId":"schema_323","description":"Sample start date in Y-m-d format","required":true},{"name":"created_before","in":"query","schemaId":"schema_323","description":"Sample end date in Y-m-d format","required":true},{"name":"types","in":"query","schemaId":"schema_405","description":"Types of loyalty transactions included in the selection: 1 - Promotion discount, 2 - Loyalty program accrual, 3 - Loyalty card withdrawal, 4 - Referral program accrual, 5 - Manual replenishment, 6 - Manual withdrawal, 7 - Overdue points withdrawal , 8 - Withdrawal from the gift card, 9 - Use of the membership, 10 - Recalculation of the cost of the membership, 11 - Withdrawal from the client account"},{"name":"company_ids","in":"query","schemaId":"schema_317","description":"Loyalty transaction affiliate IDs included in the sample"},{"name":"visit_ids","in":"query","schemaId":"schema_317","description":"Loyalty transaction visit IDs included in the sample"},{"name":"page","in":"query","schemaId":"schema_286","description":"Selection page"},{"name":"count","in":"query","schemaId":"schema_286","description":"Number of results per selection page"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1transactions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/transactions","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[{"name":"created_after","in":"query","required":true,"schemaId":"schema_323"},{"name":"created_before","in":"query","required":true,"schemaId":"schema_323"},{"name":"types","in":"query","schemaId":"schema_405","style":"form","explode":false},{"name":"company_ids","in":"query","schemaId":"schema_317","style":"form","explode":false},{"name":"visit_ids","in":"query","schemaId":"schema_317","style":"form","explode":false},{"name":"page","in":"query","schemaId":"schema_286"},{"name":"count","in":"query","schemaId":"schema_286"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/chain/{chain_id}/loyalty/transactions","href":"chain-loyalty-programs/get_chain_loyalty_transaction_list","openApiOperationId":"get_chain_loyalty_transaction_list","summary":"Get a List of Chain Loyalty Transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/loyalty_transaction"}},"schemaId":"components/schemas/loyalty_transaction"},{"code":"422","description":"Validation error"}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/loyalty_transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/loyalty_transaction"}}},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chain-loyalty-programs/get_chain_loyalty_transaction_list"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/transactions"},{"label":"Get a list of loyalty notification templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/chain-loyalty-programs/get_chain_loyalty_notification_template_list","routeSlug":"/en/b2b-v1/openapi/chain-loyalty-programs/get_chain_loyalty_notification_template_list","metadata":{"seo":{"title":"Get a list of loyalty notification templates","description":"Get a list of loyalty notification templates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_chain_loyalty_notification_template_list","name":"Get a list of loyalty notification templates","isWebhook":false,"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1notification_message_templates~1programs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of loyalty notification templates","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"chain_id","in":"path","schemaId":"schema_286","description":"Chain ID","required":true}],"pointer":"/paths/~1chain~1{chain_id}~1loyalty~1notification_message_templates~1programs/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1chain~1{chain_id}~1loyalty~1notification_message_templates~1programs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chain/{chain_id}/loyalty/notification_message_templates/programs","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"chain_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/chain/{chain_id}/loyalty/notification_message_templates/programs","href":"chain-loyalty-programs/get_chain_loyalty_notification_template_list","openApiOperationId":"get_chain_loyalty_notification_template_list","summary":"Get a list of loyalty notification templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_406"}},"schemaId":"schema_406"},{"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/~1chain~1{chain_id}~1loyalty~1notification_message_templates~1programs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}}},{"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":"/chain-loyalty-programs/get_chain_loyalty_notification_template_list"}],"panels":[]}]},"httpPath":"/chain/{chain_id}/loyalty/notification_message_templates/programs"}],"content":{"contentType":"group","meta":{"name":"Chain Loyalty Programs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chain Loyalty Programs","showPageActions":true},{"nodeType":"markdoc","content":"Chain-level loyalty programs and transactions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/chain/{chain_id}/loyalty/abonements/{membership_id}/freeze","summary":"Freeze membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_memberships_freeze","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonements/{membership_id}/unfreeze","summary":"Unfreeze membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_memberships_unfreeze","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_balance","summary":"Change membership balance","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_memberships_set_balance","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonements/{membership_id}/set_period","summary":"Change membership validity period","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_memberships_set_period","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types","summary":"List membership types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_list","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types","summary":"Create membership type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_create","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","summary":"Get membership type details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_read","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","summary":"Update membership type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_update","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}","summary":"Delete membership type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_delete","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/clone","summary":"Clone membership type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_clone","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/restore","summary":"Restore deleted membership type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_restore","deprecated":false},{"title":"/chain/{chain_id}/loyalty/abonement_types/{loyalty_membership_type_id}/archive","summary":"Archive or unarchive membership type","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_membership_types_archive","deprecated":false},{"title":"/chain/{chain_id}/loyalty/certificate_types","summary":"List certificate types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_certificate_types_list","deprecated":false},{"title":"/chain/{chain_id}/loyalty/certificate_types","summary":"Create certificate type","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_certificate_types_create","deprecated":false},{"title":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","summary":"Get certificate type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_certificate_types_get","deprecated":false},{"title":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","summary":"Update certificate type","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_certificate_types_update","deprecated":false},{"title":"/chain/{chain_id}/loyalty/certificate_types/{type_id}","summary":"Delete certificate type","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/chain-loyalty-programs/chain_loyalty_certificate_types_delete","deprecated":false},{"title":"/chain/{chain_id}/loyalty/programs","summary":"Create a Chain Promotion","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chain-loyalty-programs/create_chain_loyalty_program","deprecated":false},{"title":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","summary":"Get a Chain Promotion","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-loyalty-programs/get_chain_loyalty_program","deprecated":false},{"title":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","summary":"Edit Chain Promotion","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chain-loyalty-programs/update_chain_loyalty_program","deprecated":false},{"title":"/chain/{chain_id}/loyalty/programs/{loyalty_program_id}","summary":"Delete Chain Promotion","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/chain-loyalty-programs/delete_chain_loyalty_program","deprecated":false},{"title":"/chain/{chain_id}/loyalty/transactions","summary":"Get a List of Chain Loyalty Transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-loyalty-programs/get_chain_loyalty_transaction_list","deprecated":false},{"title":"/chain/{chain_id}/loyalty/notification_message_templates/programs","summary":"Get a list of loyalty notification templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chain-loyalty-programs/get_chain_loyalty_notification_template_list","deprecated":false}]}]}]}]}},{"type":"group","label":"Fiscalization","link":"/en/b2b-v1/openapi/fiscalization","routeSlug":"/en/b2b-v1/openapi/fiscalization","items":[{"label":"Get fiscal transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/fiscalization/get_fiscal_transaction_list","routeSlug":"/en/b2b-v1/openapi/fiscalization/get_fiscal_transaction_list","metadata":{"seo":{"title":"Get fiscal transactions","description":"Filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_fiscal_transaction_list","name":"Get fiscal transactions","isWebhook":false,"pointer":"/paths/~1kkm_transactions~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get fiscal transactions","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":"Filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"page"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"editable_length"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of clients per page"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period start date"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period end date"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"kkm-transaction-types"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Types of all transactions with location account"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sales operation – Active for documents of type Visit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale return operation – Active for documents of type Visit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correction operation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift opening operation – Opens a new POS shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift closing operation – Closes the current POS shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get POS status – Retrieves the current status of the POS device"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get POS team status – Retrieves the status of all POS devices connected to the team"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correction operation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Print X-report – Prints a non-fiscal summary report of the current shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash deposit – Registers a cash-in transaction in the POS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash withdrawal – Registers a cash-out transaction in the POS"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statuses of All POS Operations"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connection error with POS – Unable to establish a connection with the POS device"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success – Operation completed successfully"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent for printing – The request has been sent to the POS and is waiting for print completion"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runtime error – An error occurred while processing the operation on the POS device"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status check error – Failed to retrieve the current status of the POS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Waiting for POS readiness – Operation is pending until the POS device becomes ready"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provision of services"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Arrival of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products write-off"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inventory"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consumables write-off"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deposit replenishment"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1kkm_transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_280","description":"Page number","example":1},{"name":"editable_length","in":"query","schemaId":"schema_280","description":"Number of customers per page","example":25},{"name":"type","in":"query","schemaId":"schema_280","description":"Type of transaction","example":20},{"name":"status","in":"query","schemaId":"schema_280","description":"Operation status","example":6},{"name":"start_date","in":"query","schemaId":"schema_280","description":"Period start date","example":20251201},{"name":"end_date","in":"query","schemaId":"schema_280","description":"Period end date","example":20251231}],"pointer":"/paths/~1kkm_transactions~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer access_token, User user_token"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1kkm_transactions~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/kkm_transactions/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[{"name":"page","in":"query","example":1,"schemaId":"schema_280"},{"name":"editable_length","in":"query","example":25,"schemaId":"schema_280"},{"name":"type","in":"query","example":20,"schemaId":"schema_280"},{"name":"status","in":"query","example":6,"schemaId":"schema_280"},{"name":"start_date","in":"query","example":20251201,"schemaId":"schema_280"},{"name":"end_date","in":"query","example":20251231,"schemaId":"schema_280"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/kkm_transactions/{location_id}","href":"fiscalization/get_fiscal_transaction_list","openApiOperationId":"get_fiscal_transaction_list","summary":"Get fiscal transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/kkm_transactions_response_data_type","exampleIds":["paths/~1kkm_transactions~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/kkm_transactions_response_data_type","exampleIds":["paths/~1kkm_transactions~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/~1kkm_transactions~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/kkm_transactions_response_data_type","exampleIds":["paths/~1kkm_transactions~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kkm_transactions_response_data_type","exampleIds":["paths/~1kkm_transactions~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":"/fiscalization/get_fiscal_transaction_list"}],"panels":[]}]},"httpPath":"/kkm_transactions/{location_id}"},{"label":"Print fiscal receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/fiscalization/print_fiscal_receipt","routeSlug":"/en/b2b-v1/openapi/fiscalization/print_fiscal_receipt","metadata":{"seo":{"title":"Print fiscal receipt","description":"Types of all transactions with location account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"print_fiscal_receipt","name":"Print fiscal receipt","isWebhook":false,"pointer":"/paths/~1kkm_transactions~1{location_id}~1print_document_bill/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Print fiscal receipt","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":"Types of all transactions with location account"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale operation (active for documents with types \"Visit\" and \"Client account replenishment\")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale return operation (active for documents with types \"Visit\" and \"Client account replenishment\")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correction operation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift opening operation – Opens a new POS shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shift closing operation – Closes the current POS shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get POS status – Retrieves the current status of the POS device"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get POS team status – Retrieves the status of all POS devices connected to the team"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correction operation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Print X-report – Prints a non-fiscal summary report of the current shift"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash deposit – Registers a cash-in transaction in the POS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash withdrawal – Registers a cash-out transaction in the POS"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provision of services"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Arrival of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Products write-off"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer of products"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inventory"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consumables write-off"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client account replenishment"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"Location ID","required":true}],"pointer":"/paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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/~1kkm_transactions~1{location_id}~1print_document_bill/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_407"}},"schemaId":"schema_407","pointer":"/paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/kkm_transactions/{location_id}/print_document_bill","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_407"}},"responseCodes":["200","401","403","404"],"pointer":"/kkm_transactions/{location_id}/print_document_bill","href":"fiscalization/print_fiscal_receipt","openApiOperationId":"print_fiscal_receipt","summary":"Print fiscal receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_407","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_407"}},"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/kkm_transactions_print_response_data_type","exampleIds":["paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/kkm_transactions_print_response_data_type","exampleIds":["paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/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/~1kkm_transactions~1{location_id}~1print_document_bill/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/kkm_transactions_print_response_data_type","exampleIds":["paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/kkm_transactions_print_response_data_type","exampleIds":["paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/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":"/fiscalization/print_fiscal_receipt"}],"panels":[]}]},"httpPath":"/kkm_transactions/{location_id}/print_document_bill"},{"label":"List request example","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/fiscalization/get_tax_system_list","routeSlug":"/en/b2b-v1/openapi/fiscalization/get_tax_system_list","metadata":{"seo":{"title":"List request example","description":"A list of tax systems and VAT available for a country can be obtained by requesting the country ID for which the list is to be obtained.The country ID can be obtained from list of countries."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_tax_system_list","name":"List request example","isWebhook":false,"pointer":"/paths/~1integration~1kkm~1references~1tax_system~1{country_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List request example","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 list of "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax systems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available for a country can be obtained by requesting the country ID for which the list is to be obtained."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country ID can be obtained from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#countries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of countries"},"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 list is an array of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#fiscalization-tax"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"tax systems"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a nested "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#fiscalization-vat"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for each tax system."},"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":"The taxation system"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of taxation system"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slug"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code name for the taxation system"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"vats"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of objects("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#fiscalization-vat"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vat"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[])"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of available VAT for the taxation system"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"name":"fiscalization-vat"}},"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":"VAT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has the following structure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Title VAT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"slug"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code name VAT"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"country_id","in":"path","schemaId":"schema_280","description":"Country ID","required":true,"example":1}],"pointer":"/paths/~1integration~1kkm~1references~1tax_system~1{country_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1integration~1kkm~1references~1tax_system~1{country_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integration/kkm/references/tax_system/{country_id}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"country_id","in":"path","required":true,"example":1,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/integration/kkm/references/tax_system/{country_id}","href":"fiscalization/get_tax_system_list","openApiOperationId":"get_tax_system_list","summary":"List request example"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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/tax_system_response_data__types","exampleIds":["paths/~1integration~1kkm~1references~1tax_system~1{country_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/tax_system_response_data__types","exampleIds":["paths/~1integration~1kkm~1references~1tax_system~1{country_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/~1integration~1kkm~1references~1tax_system~1{country_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tax_system_response_data__types","exampleIds":["paths/~1integration~1kkm~1references~1tax_system~1{country_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tax_system_response_data__types","exampleIds":["paths/~1integration~1kkm~1references~1tax_system~1{country_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":"/fiscalization/get_tax_system_list"}],"panels":[]}]},"httpPath":"/integration/kkm/references/tax_system/{country_id}"},{"label":"Example of a request in case of successful fiscalization or in case of an error","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/fiscalization/handle_fiscalization_callback","routeSlug":"/en/b2b-v1/openapi/fiscalization/handle_fiscalization_callback","metadata":{"seo":{"title":"Example of a request in case of successful fiscalization or in case of an error","description":"Example of a request in case of successful fiscalization or in case of an error"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"handle_fiscalization_callback","name":"Example of a request in case of successful fiscalization or in case of an error","isWebhook":false,"pointer":"/paths/~1integration~1kkm~1callback/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Example of a request in case of successful fiscalization or in case of an error","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}"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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":"Conetnt-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1integration~1kkm~1callback/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"schemaId":"schema_320","pointer":"/paths/~1integration~1kkm~1callback/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/integration/kkm/callback","servers":[{"url":"/_mock/en/b2b-v1/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_279"},{"name":"Conetnt-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_320"}},"responseCodes":["200","401","403","404"],"pointer":"/integration/kkm/callback","href":"fiscalization/handle_fiscalization_callback","openApiOperationId":"handle_fiscalization_callback","summary":"Example of a request in case of successful fiscalization or in case of an error"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_320","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","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":"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/~1integration~1kkm~1callback/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":"/fiscalization/handle_fiscalization_callback"}],"panels":[]}]},"httpPath":"/integration/kkm/callback"},{"label":"Example of a request for fiscalization of a document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/fiscalization/fiscalize_document","routeSlug":"/en/b2b-v1/openapi/fiscalization/fiscalize_document","metadata":{"seo":{"title":"Example of a request for fiscalization of a document","description":"Example of a request for fiscalization of a document"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fiscalize_document","name":"Example of a request for fiscalization of a document","isWebhook":false,"pointer":"/paths/~1https:~1~1your-api.url/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Example of a request for fiscalization of a document","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}"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1https:~1~1your-api.url/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/fiscalization_request_data_types"}},"schemaId":"components/schemas/fiscalization_request_data_types","pointer":"/paths/~1https:~1~1your-api.url/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/https://your-api.url","servers":[{"url":"/_mock/en/b2b-v1/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_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/fiscalization_request_data_types"}},"responseCodes":["200","401","403","404"],"pointer":"/https://your-api.url","href":"fiscalization/fiscalize_document","openApiOperationId":"fiscalize_document","summary":"Example of a request for fiscalization of a document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"components/schemas/fiscalization_request_data_types","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/fiscalization_request_data_types"}},"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":{"exampleIds":["paths/~1https:~1~1your-api.url/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1https:~1~1your-api.url/post/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/~1https:~1~1your-api.url/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1https:~1~1your-api.url/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1https:~1~1your-api.url/post/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":"/fiscalization/fiscalize_document"}],"panels":[]}]},"httpPath":"/https://your-api.url"}],"content":{"contentType":"group","meta":{"name":"Fiscalization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fiscalization","showPageActions":true},{"nodeType":"markdoc","content":"Tax system integration and KKM callbacks"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/kkm_transactions/{location_id}","summary":"Get fiscal transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fiscalization/get_fiscal_transaction_list","deprecated":false},{"title":"/kkm_transactions/{location_id}/print_document_bill","summary":"Print fiscal receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fiscalization/print_fiscal_receipt","deprecated":false},{"title":"/integration/kkm/references/tax_system/{country_id}","summary":"List request example","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fiscalization/get_tax_system_list","deprecated":false},{"title":"/integration/kkm/callback","summary":"Example of a request in case of successful fiscalization or in case of an error","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fiscalization/handle_fiscalization_callback","deprecated":false},{"title":"/https://your-api.url","summary":"Example of a request for fiscalization of a document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fiscalization/fiscalize_document","deprecated":false}]}]}]}]}},{"type":"group","label":"Utilities","link":"/en/b2b-v1/openapi/utilities","routeSlug":"/en/b2b-v1/openapi/utilities","items":[{"label":"Retrieve location subscription information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/utilities/get_location_subscription_information","routeSlug":"/en/b2b-v1/openapi/utilities/get_location_subscription_information","metadata":{"seo":{"title":"Retrieve location subscription information","description":"Retrieve location subscription information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_location_subscription_information","name":"Retrieve location subscription information","isWebhook":false,"pointer":"/paths/~1license~1{location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve location subscription information","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1license~1{location_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1license~1{location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/license/{location_id}","servers":[{"url":"/_mock/en/b2b-v1/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_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/license/{location_id}","href":"utilities/get_location_subscription_information","openApiOperationId":"get_location_subscription_information","summary":"Retrieve location subscription information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"schema_408","exampleIds":["paths/~1license~1{location_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_408","exampleIds":["paths/~1license~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/~1license~1{location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_408","exampleIds":["paths/~1license~1{location_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408","exampleIds":["paths/~1license~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":"/utilities/get_location_subscription_information"}],"panels":[]}]},"httpPath":"/license/{location_id}"},{"label":"Phone number format check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/utilities/phone_number_format_check","routeSlug":"/en/b2b-v1/openapi/utilities/phone_number_format_check","metadata":{"seo":{"title":"Phone number format check","description":"The transferred phone number is checked for compliance with Altegio rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"phone_number_format_check","name":"Phone number format check","isWebhook":false,"pointer":"/paths/~1validation~1validate_phone~1{phone}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phone number format check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The transferred phone number is checked for compliance with Altegio rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartner","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"phone","in":"path","schemaId":"schema_279","description":"Checked phone number","required":true}],"pointer":"/paths/~1validation~1validate_phone~1{phone}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1validation~1validate_phone~1{phone}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/validation/validate_phone/{phone}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"phone","in":"path","required":true,"schemaId":"schema_279"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/validation/validate_phone/{phone}","href":"utilities/phone_number_format_check","openApiOperationId":"phone_number_format_check","summary":"Phone number format check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":{"exampleIds":["paths/~1validation~1validate_phone~1{phone}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1validation~1validate_phone~1{phone}/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/~1validation~1validate_phone~1{phone}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1validation~1validate_phone~1{phone}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1validation~1validate_phone~1{phone}/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":"/utilities/phone_number_format_check"}],"panels":[]}]},"httpPath":"/validation/validate_phone/{phone}"},{"label":"Image upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/utilities/upload_image","routeSlug":"/en/b2b-v1/openapi/utilities/upload_image","metadata":{"seo":{"title":"Image upload","description":"The response object has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upload_image","name":"Image upload","isWebhook":false,"pointer":"/paths/~1images~1{entity}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Image upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response object has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image_binded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of linking images to an entity"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image_group"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image group object"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"entity name (team_member for team members, service for services)"},"children":[]}]}]}],"required":true,"example":"\"master\""}],"pointer":"/paths/~1images~1{entity}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"form-data","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1images~1{entity}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_409"}},"schemaId":"schema_409","pointer":"/paths/~1images~1{entity}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/images/{entity}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"example":"\"master\"","schemaId":"schema_279"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_409"}},"responseCodes":["200","401","403","404"],"pointer":"/images/{entity}","href":"utilities/upload_image","openApiOperationId":"upload_image","summary":"Image upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_409","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_409"}},"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":"schema_410","exampleIds":["paths/~1images~1{entity}/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_410","exampleIds":["paths/~1images~1{entity}/post/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/~1images~1{entity}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_410","exampleIds":["paths/~1images~1{entity}/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410","exampleIds":["paths/~1images~1{entity}/post/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":"/utilities/upload_image"}],"panels":[]}]},"httpPath":"/images/{entity}"},{"label":"Deleting images","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/utilities/delete_image","routeSlug":"/en/b2b-v1/openapi/utilities/delete_image","metadata":{"seo":{"title":"Deleting images","description":"The response object has the following fields:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_image","name":"Deleting images","isWebhook":false,"pointer":"/paths/~1images~1{entity}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deleting images","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":"The response object has the following fields:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletion result"},"children":[]}]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerPartnerUser","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entity","in":"path","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"entity name (team_member for team members, service for services)"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1images~1{entity}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","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_279","description":"form-data","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1images~1{entity}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_411"}},"schemaId":"schema_411","pointer":"/paths/~1images~1{entity}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/images/{entity}","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"entity","in":"path","required":true,"schemaId":"schema_279"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_411"}},"responseCodes":["200","401","403","404"],"pointer":"/images/{entity}","href":"utilities/delete_image","openApiOperationId":"delete_image","summary":"Deleting images"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"schemaId":"schema_411","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_411"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","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":"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/~1images~1{entity}/delete/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":"/utilities/delete_image"}],"panels":[]}]},"httpPath":"/images/{entity}"},{"label":"Get a list of location team members with their tip settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/utilities/get_team_member_tip_settings","routeSlug":"/en/b2b-v1/openapi/utilities/get_team_member_tip_settings","metadata":{"seo":{"title":"Get a list of location team members with their tip settings","description":"Get a list of location team members with their tip settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_team_member_tip_settings","name":"Get a list of location team members with their tip settings","isWebhook":false,"pointer":"/paths/~1tips~1{location_id}~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of location team members with their tip settings","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"location ID","required":true}],"pointer":"/paths/~1tips~1{location_id}~1settings/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1tips~1{location_id}~1settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tips/{location_id}/settings","servers":[{"url":"/_mock/en/b2b-v1/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_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/tips/{location_id}/settings","href":"utilities/get_team_member_tip_settings","openApiOperationId":"get_team_member_tip_settings","summary":"Get a list of location team members with their tip settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Collection of objects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings/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/~1tips~1{location_id}~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings/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":"/utilities/get_team_member_tip_settings"}],"panels":[]}]},"httpPath":"/tips/{location_id}/settings"},{"label":"Disable Tips for the team member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/utilities/disable_team_member_tips","routeSlug":"/en/b2b-v1/openapi/utilities/disable_team_member_tips","metadata":{"seo":{"title":"Disable Tips for the team member","description":"Disable Tips for the team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disable_team_member_tips","name":"Disable Tips for the team member","isWebhook":false,"pointer":"/paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disable Tips for the team member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"location_id","in":"path","schemaId":"schema_286","description":"location id","required":true},{"name":"master_tips_settings_id","in":"path","schemaId":"schema_286","description":"tip settings id","required":true}],"pointer":"/paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tips/{location_id}/settings/{master_tips_settings_id}/disable","servers":[{"url":"/_mock/en/b2b-v1/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_286"},{"name":"master_tips_settings_id","in":"path","required":true,"schemaId":"schema_286"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/tips/{location_id}/settings/{master_tips_settings_id}/disable","href":"utilities/disable_team_member_tips","openApiOperationId":"disable_team_member_tips","summary":"Disable Tips for the team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Tip settings object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/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/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/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":"/utilities/disable_team_member_tips"}],"panels":[]}]},"httpPath":"/tips/{location_id}/settings/{master_tips_settings_id}/disable"},{"label":"Enable Tips for the team member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v1/openapi/utilities/enable_team_member_tips","routeSlug":"/en/b2b-v1/openapi/utilities/enable_team_member_tips","metadata":{"seo":{"title":"Enable Tips for the team member","description":"Enable Tips for the team member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enable_team_member_tips","name":"Enable Tips for the team member","isWebhook":false,"pointer":"/paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable Tips for the team member","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}"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"master_tips_settings_id","in":"path","schemaId":"schema_286","description":"tip settings id","required":true},{"name":"location_id","in":"path","schemaId":"schema_280","description":"location ID","required":true}],"pointer":"/paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_279","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application/vnd.api.v2+json"},"children":[]}]}]}],"required":true},{"name":"Content-Type","in":"header","schemaId":"schema_279","description":"application/json","required":true},{"name":"Authorization","in":"header","schemaId":"schema_279","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/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tips/{location_id}/settings/{master_tips_settings_id}/enable","servers":[{"url":"/_mock/en/b2b-v1/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v1","description":"Production"}],"parameters":{"path":[{"name":"master_tips_settings_id","in":"path","required":true,"schemaId":"schema_286"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_280"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"schemaId":"schema_279"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_279"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_279"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/tips/{location_id}/settings/{master_tips_settings_id}/enable","href":"utilities/enable_team_member_tips","openApiOperationId":"enable_team_member_tips","summary":"Enable Tips for the team member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v1/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":"Tip settings object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/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/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tips_setting_response_data_types","exampleIds":["paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/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":"/utilities/enable_team_member_tips"}],"panels":[]}]},"httpPath":"/tips/{location_id}/settings/{master_tips_settings_id}/enable"}],"content":{"contentType":"group","meta":{"name":"Utilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Utilities","showPageActions":true},{"nodeType":"markdoc","content":"License info, phone validation, images, and tips"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/license/{location_id}","summary":"Retrieve location subscription information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/utilities/get_location_subscription_information","deprecated":false},{"title":"/validation/validate_phone/{phone}","summary":"Phone number format check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/utilities/phone_number_format_check","deprecated":false},{"title":"/images/{entity}","summary":"Image upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/utilities/upload_image","deprecated":false},{"title":"/images/{entity}","summary":"Deleting images","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/utilities/delete_image","deprecated":false},{"title":"/tips/{location_id}/settings","summary":"Get a list of location team members with their tip settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/utilities/get_team_member_tip_settings","deprecated":false},{"title":"/tips/{location_id}/settings/{master_tips_settings_id}/disable","summary":"Disable Tips for the team member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/utilities/disable_team_member_tips","deprecated":false},{"title":"/tips/{location_id}/settings/{master_tips_settings_id}/enable","summary":"Enable Tips for the team member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/utilities/enable_team_member_tips","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/auth_request":{"id":"components/schemas/auth_request","kind":"json-schema","title":"Root Type for auth_request","data":{"title":"Root Type for auth_request","required":["login","password"],"type":"object","properties":{"login":{"type":"string","description":"Phone number or Email"},"password":{"type":"string","description":"Password"}},"description":"User authorization","example":{"login":"testuser@alteg.io","password":"testpass"}}},"components/schemas/auth_response":{"id":"components/schemas/auth_response","kind":"json-schema","title":"Root Type for auth_response","data":{"title":"Root Type for auth_response","type":"object","properties":{"success":{"type":"boolean","description":"Request success status"},"data":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"integer","description":"User ID","format":"int32"},"user_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User_token of the user"},"children":[]}]}]}]},"name":{"type":"string","description":"Username"},"phone":{"type":"string","description":"User phone"},"login":{"type":"string","description":"User login"},"email":{"type":"string","description":"User mailing address"},"avatar":{"type":"string","description":"Path to the user's avatar file"},"is_approved":{"type":"boolean","description":"Is the user verified in the system"},"is_email_confirmed":{"type":"boolean","description":"Is the user email confirmed"}}},"meta":{"type":"array","description":"Metadata","items":{}}},"description":"User authorization","example":{"success":true,"data":{"id":123456,"user_token":"wec23fh8cDfFV4432fc352456","name":"James Smith","phone":"+13155550175","login":"j.smith","email":"j.smith@example.com","avatar":"https://assets.alteg.io/general/0/01/123456789098765_12345678909876.png","is_approved":true,"is_email_confirmed":false},"meta":[]}}},"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/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/company_create_request_data_types":{"id":"components/schemas/company_create_request_data_types","kind":"json-schema","title":"Root Type for company_create_request_data_types","data":{"title":"Root Type for company_create_request_data_types","type":"object","properties":{"title":{"type":"string","description":"location name"},"country_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the country in which the location is located ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#countries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method to get a list of countries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"city_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the city in which the location is located ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#cities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"method to get a list of cities"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"address":{"type":"string","description":"location address"},"site":{"type":"string","description":"location website"},"coordinate_lat":{"type":"number","description":"Latitude","format":"float"},"coordinate_lot":{"type":"number","description":"Longitude","format":"float"},"business_type_id":{"type":"number","description":"Business type"},"short_descr":{"type":"string","description":"location category"}},"description":"Create a location","example":{"title":"James Smith LLC","country_id":7,"city_id":2,"address":"New York, 787 Jackson Drive","site":"james-smith-company.com","coordinate_lat":40.73061,"coordinate_lot":-73.935242,"business_type_id":1,"short_descr":"Beauty studio"}}},"components/schemas/company_create_response_data_types":{"id":"components/schemas/company_create_response_data_types","kind":"json-schema","title":"Root Type for company_create_response_data_types","data":{"title":"Root Type for company_create_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Success status (true)"},"data":{"type":"object","properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"short_descr":{"type":"string","description":"location category"},"logo":{"type":"string","description":"Path to location logo image"},"active":{"type":"number","description":"Is the location active (presence of a paid license) (1 - active, 0 - inactive)"},"phone":{"type":"string","description":"location phone number"},"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":"Name of the country in which the location is located"},"city_id":{"type":"number","description":"City ID where the location is located"},"city":{"type":"string","description":"Name of the city where the location is located"},"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"},"app_ios":{"type":"string","description":"Link to iOS App"},"app_android":{"type":"string","description":"Link to Android App"},"currency_short_title":{"type":"string","description":"Abbreviated currency name"}},"description":"data object"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create a location","example":{"success":true,"data":{"id":1050,"title":"James Smith LLC","short_descr":"Beauty studio","logo":"https://app.alteg.io/images/no-master.png","active":1,"phone":"+13155550175","country_id":7,"schedule":"","country":"United States","city_id":181,"city":"New York","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,"app_ios":"","app_android":"","currency_short_title":"R"},"meta":[]}}},"components/schemas/company_get_response_data_types":{"id":"components/schemas/company_get_response_data_types","kind":"json-schema","title":"Root Type for company_get_response_data_types","data":{"title":"Root Type for company_get_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Success status (true)"},"data":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"country_id":{"type":"number","description":"Identifier of the country in which the location is located"},"country":{"type":"string","description":"Name of the country in which the location is located"},"city_id":{"type":"number","description":"City ID where the location is located"},"city":{"type":"string","description":"Name of the city where the location is located"},"timezone_name":{"type":"string","description":"timezone locations"},"address":{"type":"string","description":"Address where the location is located"},"zip":{"type":"string","description":"Zip code"},"social":{"type":"object","properties":{"telegram":{"type":"string","description":"Telegram"},"instagram":{"type":"string","description":"Instagram"},"vk":{"type":"string","description":"VK (social network)"},"facebook":{"type":"string","description":"Facebook"},"viber":{"type":"string","description":"Viber"},"whatsapp":{"type":"string","description":"WhatsApp"}},"description":"location social media"},"site":{"type":"string","description":"location website"},"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 the phone by 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"},"group_priority":{"type":"integer","description":"The higher the priority, the higher the location when displayed in the list of chain locations","format":"int32"},"push_notification_phone_confirm":{"oneOf":[{"type":"boolean"},{"type":"integer"}],"description":"Confirm client number to send push notifications (0/1 or boolean)"},"main_group_id":{"type":"number","description":"Main location chain ID"},"main_group":{"description":"Main location chain (object or empty array)","oneOf":[{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Chain ID"},"title":{"type":"string","description":"Chain name"}}},{"type":"array","maxItems":0}]},"groups":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All location chains. Only when show_groups=1 is set"},"children":[]}]}]}],"additionalProperties":{"type":"object","properties":{"id":{"type":"number","description":"Chain ID"},"title":{"type":"string","description":"Chain name"}}}},"bookforms":{"type":"array","description":"location online booking forms (widgets)","items":{"type":"object","properties":{"id":{"type":"number","description":"appointment form ID"},"title":{"type":"string","description":"appointment form name"},"is_default":{"type":"number","description":"Is this appointment form location default"},"url":{"type":"string","description":"appointment form url"}}}},"online_sales_form_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"appointment form url. Only if bookform_id is set"},"children":[]}]}]}]},"payment_policy":{"type":"object","description":"Currently enabled payment policy for the location","properties":{"type":{"type":"string","enum":["none","deposit","card_guarantee"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment policy type: none — disabled, deposit — prepaid deposit, card_guarantee — card guarantee"},"children":[]}]}]}]}}},"access":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access rights list. Only if my=1 is set"},"children":[]}]}]}]}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get location","example":{"success":true,"data":{"id":37532,"title":"James Smith LLC","country_id":7,"country":"United States","city_id":181,"city":"New York","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","zip":"11435","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"short_descr":"Beauty studio","social":{"facebook":"","instagram":"instagram.com/james_smith_company/","telegram":"","whatsapp":"","viber":""},"site":"james-smith-company.com","business_type_id":1,"description":"The <strong>James Smith</strong> location","phone_confirmation":true,"active_staff_count":2,"next_slot":"2026-03-23T10:10:00-05:00","group_priority":900,"push_notification_phone_confirm":1,"main_group_id":9206,"main_group":{"id":9206,"title":"James Smith LLC main location chain"},"groups":{"9206":{"id":9206,"title":"James Smith LLC main location chain"},"9207":{"id":9207,"title":"James Smith LLC extra location chain"}},"bookforms":[{"id":19203,"title":"James Smith LLC location appointment form","is_default":0,"url":"https://n19203.alteg.io/"}],"online_sales_form_url":"https://o1.alteg.io","payment_policy":{"type":"deposit"},"access":{}},"meta":[]}}},"components/schemas/response_errors_unauthorized_object":{"id":"components/schemas/response_errors_unauthorized_object","kind":"json-schema","title":"Response error message","data":{"title":"Response error message","type":"object","description":"Additional response data.","properties":{"code":{"type":"number","description":"Error number.","example":401},"message":{"type":"string","description":"Error message.","example":"Authentication needed"}}}},"components/schemas/401_unauthorized_response_legacy":{"id":"components/schemas/401_unauthorized_response_legacy","kind":"json-schema","title":"401_unauthorized_response_legacy","data":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/response_errors_unauthorized_object"},"meta":{"$ref":"#/components/schemas/response_meta_error_unauthorized_object"}}}},"components/schemas/response_errors_not_found_object":{"id":"components/schemas/response_errors_not_found_object","kind":"json-schema","title":"Response error message","data":{"title":"Response error message","type":"object","description":"Additional response data.","properties":{"code":{"type":"number","description":"Error number.","example":404},"message":{"type":"string","description":"Error message.","example":"Not found"}}}},"components/schemas/response_meta_error_not_found_object":{"id":"components/schemas/response_meta_error_not_found_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":"Not found"}}}},"components/schemas/404_not_found_response_legacy":{"id":"components/schemas/404_not_found_response_legacy","kind":"json-schema","title":"404_not_found_response_legacy","data":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/response_errors_not_found_object"},"meta":{"$ref":"#/components/schemas/response_meta_error_not_found_object"}}}},"components/schemas/company_put_request_data_types":{"id":"components/schemas/company_put_request_data_types","kind":"json-schema","title":"Root Type for company_put_request_data_types","data":{"title":"Root Type for company_put_request_data_types","type":"object","properties":{"title":{"type":"string","description":"location name"},"country_id":{"type":"number","description":"Country ID (has higher priority then country)"},"country":{"type":"string","description":"Country"},"city_id":{"type":"number","description":"City ID (has higher priority then city)"},"city":{"type":"string","description":"City"},"address":{"type":"string","description":"location address"},"zip":{"type":"string","description":"Zip code"},"phones":{"type":"array","items":{"type":"string"},"description":"location phone numbers"},"social":{"type":"object","properties":{"telegram":{"type":"string","description":"Telegram"},"instagram":{"type":"string","description":"Instagram"},"vk":{"type":"string","description":"VK (social network)"},"facebook":{"type":"string","description":"Facebook"},"viber":{"type":"string","description":"Viber"},"whatsapp":{"type":"string","description":"WhatsApp"}},"description":"location social media"},"site":{"type":"string","description":"location website"},"coordinate_lat":{"type":"number","description":"Latitude","format":"float"},"coordinate_lon":{"type":"number","description":"Longitude","format":"float"},"description":{"type":"string","description":"Description","format":"html"},"business_type_id":{"type":"number","description":"Business type","format":"int32"},"short_descr":{"type":"string","description":"Business category"}},"description":"Change location","example":{"title":"James Smith LLC","country":"United States","city":"New York","address":"New York, 787 Jackson Drive","zip":"11435","phones":["12125357710","12125357711"],"social":{"instagram":"instagram.com/james_smith_company/"},"site":"james-smith-company.com","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"description":"The <strong>James Smith</strong> location","business_type_id":1,"short_descr":"Beauty studio"}}},"components/schemas/company_put_response_data_types":{"id":"components/schemas/company_put_response_data_types","kind":"json-schema","title":"Root Type for company_put_response_data_types","data":{"title":"Root Type for company_put_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Success status (true)"},"data":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"country_id":{"type":"number","description":"Country ID"},"country":{"type":"string","description":"Country name"},"city_id":{"type":"number","description":"City ID"},"city":{"type":"string","description":"City name"},"timezone_name":{"type":"string","description":"Timezone name"},"address":{"type":"string","description":"location address"},"zip":{"type":"string","description":"Zip code"},"social":{"type":"object","additionalProperties":true,"properties":{"telegram":{"type":"string","description":"Telegram"},"instagram":{"type":"string","description":"Instagram"},"vk":{"type":"string","description":"VK (social network)"},"facebook":{"type":"string","description":"Facebook"},"viber":{"type":"string","description":"Viber"},"whatsapp":{"type":"string","description":"WhatsApp"}},"description":"location social media"},"site":{"type":"string","description":"location website"},"coordinate_lat":{"type":"number","description":"Latitude","format":"float"},"coordinate_lon":{"type":"number","description":"Longitude","format":"float"},"description":{"type":"string","description":"Description","format":"html"},"business_type_id":{"type":"number","description":"Business type","format":"int32"},"short_descr":{"type":"string","description":"Business category"},"phone_confirmation":{"type":"boolean","description":"Do I need to confirm my phone number via SMS when appointment?"},"group_priority":{"type":"integer","description":"The higher the priority, the higher the location when displayed in the list of chain locations","format":"int32"},"push_notification_phone_confirm":{"oneOf":[{"type":"boolean"},{"type":"integer"}],"description":"Confirm client number to send push notifications (0/1 or boolean)"},"main_group_id":{"type":"number","description":"Main location chain ID"},"main_group":{"description":"Main location chain (object or empty array)","oneOf":[{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Chain ID"},"title":{"type":"string","description":"Chain name"}}},{"type":"array","maxItems":0}]},"access":{"type":"object","additionalProperties":true,"description":"Access rights list"}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Change location","example":{"success":true,"data":{"id":37532,"title":"James Smith LLC","country_id":7,"country":"United States","city_id":181,"city":"New York","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","zip":"11435","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"short_descr":"Beauty studio","social":{"facebook":"","instagram":"instagram.com/james_smith_company/","telegram":"","whatsapp":"","viber":""},"site":"james-smith-company.com","business_type_id":1,"description":"The <strong>James Smith</strong> location","phone_confirmation":true,"group_priority":900,"push_notification_phone_confirm":1,"access":{}},"meta":[]}}},"components/schemas/service_categories_companyid_request_data_types":{"id":"components/schemas/service_categories_companyid_request_data_types","kind":"json-schema","title":"Root Type for service_categories_companyid_request_data_types","data":{"title":"Root Type for service_categories_companyid_request_data_types","type":"object","properties":{"title":{"type":"string","description":"Service category name"},"api_id":{"type":"string","description":"External Category ID"},"weight":{"type":"number","description":"Category weight (used to sort categories when displayed)"},"staff":{"type":"array","description":"List of IDs of team members providing services from the category","items":{"type":"number","description":"team member ID"}}},"description":"Create service category","example":{"title":"Haircut very feminine","api_id":"adw322","weight":111,"staff":[5006,8901]}}},"components/schemas/service_categories_companyid_response_data_types":{"id":"components/schemas/service_categories_companyid_response_data_types","kind":"json-schema","title":"Root Type for service_categories_companyid_response_data_types","data":{"title":"Root Type for service_categories_companyid_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"id":{"type":"number","description":"Category ID"},"salon_service_id":{"type":"number","description":"Category ID for the location on the chain"},"title":{"type":"string","description":"name of category"},"api_id":{"type":"string","description":"External Category ID"},"weight":{"type":"number","description":"Category weight (used to sort categories when displayed)"},"staff":{"type":"array","description":"List of team member IDs providing the service from the category","items":{"type":"number","description":"team member ID"}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create service category","example":{"success":true,"data":{"id":3,"salon_service_id":15,"title":"Haircut very feminine","api_id":"adw322","weight":111,"staff":[5006,8901]},"meta":[]}}},"components/schemas/services_list_response":{"id":"components/schemas/services_list_response","kind":"json-schema","title":"Root Type for services_list_response","data":{"title":"Root Type for services_list_response","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of services","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Service ID"},"salon_service_id":{"type":"number","description":"Service ID for a location on the chain"},"title":{"type":"string","description":"Service name"},"booking_title":{"type":"string","description":"Service name for booking"},"category_id":{"type":"number","description":"Identifier of the category in which the service consists"},"price_min":{"type":"number","description":"Minimum price for the service","format":"float"},"price_max":{"type":"number","description":"Maximum price for the service","format":"float"},"duration":{"type":"number","description":"Service duration in seconds, default is 3600","format":"float"},"technical_break_duration":{"oneOf":[{"type":"number"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break duration in seconds."},"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":"null = use location default"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value in multiples of 300 (5-minute intervals)"},"children":[]}]}]}]}]},"discount":{"type":"number","description":"Discount percentage","format":"float"},"comment":{"type":"string","description":"Comment on the service"},"weight":{"type":"number","description":"Service weight (used to sort categories when displayed)"},"active":{"type":"number","description":"1 - available for online booking, 0 - not available"},"api_id":{"type":"string","description":"External Service ID"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of services response","example":{"success":true,"data":[{"id":10279685,"salon_service_id":11486182,"title":"Service name","booking_title":"Service name","category_id":10279684,"price_min":0,"price_max":0,"duration":3600,"discount":0,"comment":"","weight":1,"active":1,"api_id":""}],"meta":[]}}},"components/schemas/services_companyid_request_data_types":{"id":"components/schemas/services_companyid_request_data_types","kind":"json-schema","title":"Root Type for services_companyid_request_data_types","data":{"title":"Root Type for services_companyid_request_data_types","type":"object","properties":{"title":{"type":"string","description":"Service name"},"category_id":{"type":"number","description":"Service Category ID"},"price_min":{"type":"number","description":"The minimum cost of the service","format":"float"},"price_max":{"type":"number","description":"Maximum cost of the service","format":"float"},"duration":{"type":"number","description":"Service duration, default is 3600 seconds","format":"float"},"technical_break_duration":{"oneOf":[{"type":"number","minimum":0,"maximum":3600},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break duration in seconds."},"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 not provided, defaults to null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null = use location default (Settings → Appointment Log → Technical Breaks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be in multiples of 300 (5-minute intervals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum value is 3600 (1 hour)"},"children":[]}]}]}]}]},"discount":{"type":"number","description":"Service discount","format":"float"},"comment":{"type":"string","description":"Comment on the service"},"weight":{"type":"number","description":"Service weight (used to sort services when displayed)"},"active":{"type":"number","description":"Is the service available for online booking? 1 - available, 0 not available."},"api_id":{"type":"string","description":"External Service ID"},"staff":{"type":"array","description":"team members who provide the service, along with the duration of the service for each team member","items":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"seance_length":{"type":"number","description":"The duration of the service (in multiples of 15 minutes)"}}}}},"description":"Create a service","example":{"title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"duration":3600,"discount":0,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":1796,"seance_length":3600},{"id":34006,"seance_length":3600}]}}},"components/schemas/services_companyid_response_data_types":{"id":"components/schemas/services_companyid_response_data_types","kind":"json-schema","title":"Root Type for services_companyid_response_data_types","data":{"title":"Root Type for services_companyid_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Service ID"},"salon_service_id":{"type":"number","description":"Service ID for a location on the chain"},"title":{"type":"string","description":"Service name"},"category_id":{"type":"number","description":"Identifier of the category in which the service consists"},"price_min":{"type":"number","description":"Minimum price for the service","format":"float"},"price_max":{"type":"number","description":"Maximum price for the service","format":"float"},"duration":{"type":"number","description":"Service duration, default is 3600 seconds","format":"float"},"technical_break_duration":{"oneOf":[{"type":"number"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break duration in seconds."},"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":"null = use location default (Settings → Appointment Log → Technical Breaks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value in multiples of 300 (5-minute intervals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum value is 3600 (1 hour)"},"children":[]}]}]}]}]},"discount":{"type":"number","description":"Discount","format":"float"},"comment":{"type":"string","description":"Comment on the service"},"weight":{"type":"number","description":"Service weight (used to sort categories when displayed)"},"active":{"type":"number","description":"1 - available for online booking, 0 - not available"},"api_id":{"type":"string","description":"External Service ID"},"staff":{"type":"array","description":"List of team members providing the service and session duration","items":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"seance_length":{"type":"number","description":"Service duration (multiple of 15 minutes)"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create a service","example":{"success":true,"data":{"id":83169,"salon_service_id":322888,"title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"duration":3600,"discount":0,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":1796,"seance_length":3600},{"id":34006,"seance_length":3600}]},"meta":[]}}},"components/schemas/company_companyid_service_categories_response200_data_types":{"id":"components/schemas/company_companyid_service_categories_response200_data_types","kind":"json-schema","title":"Root Type for company_companyid_service_categories_response200_data_types","data":{"title":"Root Type for company_companyid_service_categories_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of objects","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Category ID"},"salon_service_id":{"type":"number","description":"Category ID for the location on the chain"},"title":{"type":"string","description":"name of category"},"api_id":{"type":"string","description":"External Category ID"},"weight":{"type":"number","description":"Category weight (used to sort categories when displayed)"},"staff":{"type":"array","description":"List of team member IDs providing the service","items":{"type":"number","description":"team member ID"}},"is_chain":{"type":"boolean","description":"Whether category belongs to chain"}}}},"meta":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata (object with total_count or empty array)"},"children":[]}]}]}],"oneOf":[{"type":"object","properties":{"total_count":{"type":"number","description":"Number of categories found"}}},{"type":"array","maxItems":0,"description":"Empty array when no metadata"}]}},"description":"Get a list of service categories","example":{"success":true,"data":[{"id":345,"salon_service_id":353,"title":"Haircuts for men","api_id":"adw322","weight":10,"staff":[5006,8901,26514,26516,26519,26520]},{"id":3456,"salon_service_id":3252,"title":"Haircuts for women","api_id":"adw323","weight":9,"staff":[5006,8901]}],"meta":{"total_count":2}}}},"components/schemas/company_companyid_services_serviceid_response200_data_types":{"id":"components/schemas/company_companyid_services_serviceid_response200_data_types","kind":"json-schema","title":"Root Type for company_companyid_services_serviceid_response200_data_types","data":{"title":"Root Type for company_companyid_services_serviceid_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","description":"Service data object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Service ID"},"salon_service_id":{"type":"number","description":"Service ID for a location on the chain"},"title":{"type":"string","description":"Service name"},"category_id":{"type":"number","description":"Identifier of the category in which the service consists"},"price_min":{"type":"number","description":"Minimum price for the service","format":"float"},"price_max":{"type":"number","description":"Maximum price for the service","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"comment":{"type":"string","description":"Comment on the service"},"weight":{"type":"number","description":"Service weight (used to sort categories when displayed)"},"active":{"type":"number","description":"1 - available for online booking, 0 - not available"},"api_id":{"type":"string","description":"External Service ID"},"staff":{"type":"array","description":"List of team members providing the service and session duration","items":{"type":"object"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of services / specific service","example":{"success":true,"data":{"id":83169,"salon_service_id":433222,"title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"discount":0,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600}],"duration":3600,"is_online":true},"meta":[]}}},"components/schemas/services_change_companyid_request_data_types":{"id":"components/schemas/services_change_companyid_request_data_types","kind":"json-schema","title":"Root Type for services_change_companyid_request_data_types","data":{"type":"object","title":"Root Type for services_change_companyid_request_data_types","required":["title","category_id","price_min","price_max","duration","booking_title","is_multi","tax_variant","vat_id","is_need_limit_date","seance_search_start","seance_search_finish","step","seance_search_step"],"properties":{"title":{"type":"string","description":"Service name"},"booking_title":{"type":"string","description":"Service name for appointment"},"category_id":{"type":"number","description":"ID service category"},"price_min":{"type":"number","description":"Minimum cost of the service","format":"float"},"price_max":{"type":"number","description":"Maximum cost of the service","format":"float"},"duration":{"type":"number","description":"Service duration, default value is 3600"},"technical_break_duration":{"oneOf":[{"type":"number","minimum":0,"maximum":3600},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break duration in seconds."},"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 not provided, defaults to null"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null = use location default (Settings → Appointment Log → Technical Breaks)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be in multiples of 300 (5-minute intervals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum value is 3600 (1 hour)"},"children":[]}]}]}]}]},"discount":{"type":"number","description":"Service discount","format":"float"},"comment":{"type":"string","description":"Comment on the service"},"is_multi":{"type":"boolean","description":"false - Appointment, true - Event"},"tax_variant":{"type":"number","description":"Bill ID"},"vat_id":{"type":"number","description":"VAT ID"},"is_need_limit_date":{"type":"boolean","description":"The service is available for a limited time"},"date_from":{"type":"string","format":"date","description":"Service availability start date (YYYY-MM-DD)"},"date_to":{"type":"string","format":"date","description":"Service availability end date (YYYY-MM-DD)"},"seance_search_start":{"type":"number","description":"Start of period is the appointment available, in seconds"},"seance_search_finish":{"type":"number","description":"End of period is the appointment available, in seconds"},"step":{"type":"number","description":"Display interval of slots, in seconds"},"seance_search_step":{"type":"number","description":"Search interval of slots, in seconds"},"weight":{"type":"number","description":"Service weight (used to sort services when displayed)"},"active":{"type":"number","description":"1 - available for online booking, 0 - not available"},"api_id":{"type":"string","description":"External Service ID"},"staff":{"type":"array","description":"List of team members providing the service and session duration","items":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"seance_length":{"type":"number","description":"Service duration (multiple of 15 minutes)"}}}}},"description":"Change service","example":{"title":"Men's haircut","booking_title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"duration":3600,"discount":0,"tax_variant":1,"vat_id":3,"is_multi":false,"is_need_limit_date":true,"date_from":"2022-09-19","date_to":"2022-09-30","seance_search_start":36000,"seance_search_finish":84600,"step":300,"seance_search_step":900,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":1796,"seance_length":3600},{"id":34006,"seance_length":3600}]}}},"components/schemas/services_change_companyid_response_data_types":{"id":"components/schemas/services_change_companyid_response_data_types","kind":"json-schema","title":"Root Type for services_change_companyid_response_data_types","data":{"title":"Root Type for services_change_companyid_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"title":{"type":"string","description":"Service name"},"booking_title":{"type":"string","description":"Service name for appointment"},"category_id":{"type":"number","description":"ID service category"},"price_min":{"type":"number","description":"Minimum cost of the service","format":"float"},"price_max":{"type":"number","description":"Maximum cost of the service","format":"float"},"duration":{"type":"number","description":"Service duration, default value is 3600"},"technical_break_duration":{"oneOf":[{"type":"number"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break duration in seconds."},"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":"null = use location default"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value in multiples of 300 (5-minute intervals)"},"children":[]}]}]}]}]},"discount":{"type":"number","description":"Service discount","format":"float"},"comment":{"type":"string","description":"Comment on the service"},"is_multi":{"type":"boolean","description":"false - Appointment, true - Event"},"tax_variant":{"type":"number","description":"Bill ID"},"vat_id":{"type":"number","description":"VAT ID"},"is_need_limit_date":{"type":"boolean","description":"The service is available for a limited time"},"date_from":{"type":"string","format":"date","description":"Service availability start date (YYYY-MM-DD)"},"date_to":{"type":"string","format":"date","description":"Service availability end date (YYYY-MM-DD)"},"seance_search_start":{"type":"number","description":"Start of period is the appointment available, in seconds"},"seance_search_finish":{"type":"number","description":"End of period is the appointment available, in seconds"},"step":{"type":"number","description":"Display interval of slots, in seconds"},"seance_search_step":{"type":"number","description":"Search interval of slots, in seconds"},"weight":{"type":"number","description":"Service weight (used to sort services when displayed)"},"active":{"type":"number","description":"1 - available for online booking, 0 - not available"},"api_id":{"type":"string","description":"External Service ID"},"print_title":{"type":"string","description":"Service title for printing"},"service_type":{"type":"number","description":"Service type"},"api_service_id":{"type":"number","description":"External API service ID"},"repeat_visit_days_step":{"type":["string","null"],"description":"Repeat visit days step"},"schedule_template_type":{"type":"number","description":"Schedule template type"},"online_invoicing_status":{"type":"number","description":"Online invoicing status"},"is_abonement_autopayment_enabled":{"type":"number","description":"Is membership autopayment enabled (1/0)"},"autopayment_before_visit_time":{"type":"number","description":"Autopayment before visit time"},"abonement_restriction_value":{"type":"number","description":"Membership restriction value"},"is_chain":{"type":"boolean","description":"Is chain service"},"is_price_managed_only_in_chain":{"type":"boolean","description":"Is price managed only in chain"},"is_comment_managed_only_in_chain":{"type":"boolean","description":"Is comment managed only in chain"},"price_prepaid_amount":{"type":"number","description":"Prepaid amount"},"price_prepaid_percent":{"type":"number","description":"Prepaid percent"},"id":{"type":"number","description":"Service ID"},"salon_service_id":{"type":"number","description":"Location service ID"},"prepaid":{"type":"string","description":"Prepaid status (forbidden/optional/required)"},"capacity":{"type":"number","description":"Service capacity"},"image_group":{"type":"array","description":"Image group","items":{"type":"object"}},"dates":{"type":"array","description":"Service dates","items":{"type":"object"}},"resources":{"type":"array","description":"Service resources","items":{"type":"object"}},"is_online":{"type":"boolean","description":"Is available for online booking"},"staff":{"type":"array","description":"List of team members providing the service and session duration","items":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"seance_length":{"type":"number","description":"Service duration (multiple of 15 minutes)"},"technological_card_id":{"type":["number","null"],"description":"Technological card ID"}}}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Change service","example":{"success":true,"data":{"title":"Men's haircut","booking_title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"duration":3600,"discount":0,"tax_variant":1,"vat_id":3,"is_multi":false,"is_need_limit_date":true,"date_from":"2022-09-19","date_to":"2022-09-30","seance_search_start":36000,"seance_search_finish":84600,"step":300,"seance_search_step":900,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":1796,"seance_length":3600},{"id":34006,"seance_length":3600}]},"meta":[]}}},"components/schemas/company_companyid_service_categories_response403_data_types":{"id":"components/schemas/company_companyid_service_categories_response403_data_types","kind":"json-schema","title":"Root Type for company_companyid_service_categories_response403_data_types","data":{"title":"Root Type for company_companyid_service_categories_response403_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"string","description":"is null"},"meta":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"description":"Metadata (error message)"}},"description":"Getting a list of service categories","example":{"success":false,"meta":{"message":"It is necessary to renew the license in the branch with id: {company_id}"}}}},"components/schemas/company_companyid_service_categories_response404_data_types":{"id":"components/schemas/company_companyid_service_categories_response404_data_types","kind":"json-schema","title":"Root Type for company_companyid_service_categories_response403_data_types","data":{"title":"Root Type for company_companyid_service_categories_response403_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"string","description":"is null"},"meta":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"errors":{"type":"array","description":"List of error messages","items":{"type":"object","properties":{"message":{"type":"string"}}}}},"description":"Metadata (contains possible error messages)"}},"description":"Getting a list of service categories","example":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"Location not specified."},{"message":"Location not found."},{"message":"Service category does not exist."},{"message":"Team Member not found."}]}}}},"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/master_service_link":{"id":"components/schemas/master_service_link","kind":"json-schema","title":"Object of model \"Service Team Member\"","data":{"title":"Object of model \"Service Team Member\"","type":"object","additionalProperties":true,"properties":{"service_id":{"type":"number","description":"ID of service."},"master_id":{"type":"number","description":"ID of team member."},"length":{"type":"number","description":"Duration of service provision by the specified team member in seconds."},"technological_card_id":{"type":"number","description":"ID of technological card."},"api_id":{"type":"string","description":"External API identifier."},"is_online":{"type":"boolean","description":"Whether the service is available for online booking."},"is_offline_records_allowed":{"type":"boolean","description":"Whether offline appointments are allowed for this service-team member link."},"price":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Custom price for this team member providing the service."}},"example":{"service_id":123,"master_id":123,"length":3600,"technological_card_id":123,"api_id":"","is_online":true,"is_offline_records_allowed":true,"price":null}}},"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/service_title":{"id":"components/schemas/service_title","kind":"json-schema","title":"Root Type for ServiceTitle","data":{"title":"Root Type for ServiceTitle","type":"object","properties":{"id":{"type":"integer","description":"Service ID","format":"int32"},"title":{"type":"string","description":"Service name"}},"description":"Service name","example":{"id":123456,"title":"Service name"}}},"components/schemas/service_category_title":{"id":"components/schemas/service_category_title","kind":"json-schema","title":"Root Type for ServiceCategoryTitle","data":{"title":"Root Type for ServiceCategoryTitle","type":"object","properties":{"id":{"type":"integer","description":"Service Category ID","format":"int32"},"title":{"type":"string","description":"Service category name"},"services":{"type":"array","description":"Services in the category (on request)","items":{"$ref":"#/components/schemas/service_title"}}},"description":"Service category name","example":{"id":41,"title":"Service category","services":[{"id":52,"title":"Service 1"},{"id":45,"title":"Service 2"}]}}},"components/schemas/staff_list_response":{"id":"components/schemas/staff_list_response","kind":"json-schema","title":"Staff List Response","data":{"title":"Staff List Response","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of team members","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"integer","description":"Team member ID"},"api_id":{"type":["integer","null"],"description":"External API ID (for integrations)"},"name":{"type":"string","description":"Team member name"},"specialization":{"type":"string","description":"Team member specialization/title"},"rating":{"type":"number","description":"Average rating score"},"show_rating":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether to show rating (1 = show, 0 = hide)"},"children":[]}]}]}]},"user_id":{"type":["integer","null"],"description":"Linked user account ID"},"has_access_timetable":{"type":"boolean","description":"Whether team member has access to timetable management"},"avatar":{"type":"string","description":"URL to small avatar image"},"avatar_big":{"type":"string","description":"URL to large avatar image"},"comments_count":{"type":"integer","description":"Number of comments/reviews"},"votes_count":{"type":"integer","description":"Number of rating votes"},"bookable":{"type":"boolean","description":"Whether team member is available for online booking"},"image_group":{"type":"array","description":"Additional images","items":{"type":"object"}},"information":{"type":"string","description":"Additional information/bio"},"position_id":{"type":"integer","description":"Position/role ID"},"schedule_till":{"type":"string","format":"date","description":"Schedule available until date (YYYY-MM-DD)"},"weight":{"type":"integer","description":"Sort order weight"},"fired":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fired status (1 = fired, 0 = active)"},"children":[]}]}]}]},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status flag (1 = removed, 0 = active)"},"children":[]}]}]}]},"hidden":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hidden from online booking (1 = hidden, 0 = visible)"},"children":[]}]}]}]},"user":{"type":"array","description":"Linked user data","items":{"type":"object"}},"prepaid":{"type":"string","description":"Prepayment requirement (forbidden, allowed, required)"},"position":{"description":"Position object or empty array if unassigned","oneOf":[{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"}}},{"type":"array","maxItems":0}]}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of team members for a location","example":{"success":true,"data":[{"id":2940951,"api_id":null,"name":"John Smith","specialization":"Hair Stylist","rating":4.8,"show_rating":1,"user_id":null,"has_access_timetable":false,"avatar":"https://be.cdn.alteg.io/images/no-master-sm.png","avatar_big":"https://be.cdn.alteg.io/images/no-master.png","comments_count":15,"votes_count":20,"bookable":true,"image_group":[],"information":"Senior stylist with 10 years experience","position_id":1,"schedule_till":"2026-12-31","weight":100,"fired":0,"status":0,"hidden":0,"user":[],"prepaid":"forbidden","position":{"id":1,"title":"Senior Stylist"}}],"meta":[]}}},"components/schemas/staff_companyid_request_data_types":{"id":"components/schemas/staff_companyid_request_data_types","kind":"json-schema","title":"Root Type for staff_companyid_request_data_types","data":{"title":"Root Type for staff_companyid_request_data_types","type":"object","properties":{"name":{"type":"string","description":"team member name"},"specialization":{"type":"string","description":"team member specialization"},"weight":{"type":"number","description":"team member weight. team members are sorted by weight on exit, heavier first"},"information":{"type":"string","description":"team member information (HTML format)"},"api_id":{"type":"string","description":"External team member ID"},"hidden":{"type":"number","description":"Display status in online appointment, 1 - hidden, 0 - not hidden"},"fired":{"type":"number","description":"the team member's dismissal status, 1 - dismissed, 0 - not dismissed"},"user_id":{"type":"number","description":"Linked user ID, 0 - unlink user"},"has_access_timetable":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the team member has access to the appointment calendar (can have working hours set)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the team member can be assigned schedules and appear in booking."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default for new team members), schedule-related operations will fail."},"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 may be limited by your subscription plan."},"children":[]}]}]}],"example":true},"is_paid_staff":{"type":"boolean","description":"Whether the team member is a paid staff member (optional)"},"is_included_in_payment_policy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the team member is included in the location''s active payment policy scope (optional)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Toggling this field requires the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_policy_update_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission; otherwise the request fails with 403."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field is silently ignored when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_policy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is disabled for the location or no active payment policy exists."},"children":[]}]}]}]}},"description":"Add new team member","example":{"name":"Basil","specialization":"the hairdresser","weight":10,"information":"Trimming with three hands","api_id":"42","hidden":0,"fired":0,"user_id":123,"has_access_timetable":true,"is_paid_staff":false,"is_included_in_payment_policy":true}}},"components/schemas/company_companyid_staff_staffid_response_data_types":{"id":"components/schemas/company_companyid_staff_staffid_response_data_types","kind":"json-schema","title":"Root Type for company_companyid_staff_staffid_response_data_types","data":{"title":"Root Type for company_companyid_staff_staffid_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","description":"Team member data object","additionalProperties":true,"properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"team member name"},"company_id":{"type":"number","description":"location ID"},"specialization":{"type":"string","description":"team member specialization"},"position":{"description":"Team member's position (object when assigned, null or empty array when unassigned)","oneOf":[{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Job ID"},"title":{"type":"string","description":"Job title"}}},{"type":"array","maxItems":0,"description":"Empty array when no position assigned"},{"type":"null","description":"Null when no position assigned"}]},"avatar":{"type":"string","description":"Path to team member avatar file"},"avatar_big":{"type":"string","description":"The path to the team member's avatar file in a higher resolution"},"fired":{"type":"number","description":"Whether the team member was fired, 1 - fired, 0 - not fired"},"status":{"type":"number","description":"Is the team member removed, 1 - removed, 0 - not removed"},"hidden":{"type":"number","description":"Whether the team member is hidden for online appointment, 1 - hidden, 0 - not hidden"},"user_id":{"type":["number","null"],"description":"team member's linked user ID"},"is_paid_staff":{"type":"boolean","description":"Whether the team member is a paid staff member counted in license price"},"is_included_in_payment_policy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the team member is included in the location''s active payment policy scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always returned. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_policy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature is disabled for the location or no active payment policy exists."},"children":[]}]}]}]}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a List of team members / Specific team member","example":{"success":true,"data":{"id":1001539,"name":"team member 1","company_id":176275,"specialization":"team member","position":{"id":1,"title":"Administrator"},"avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","fired":0,"status":0,"hidden":0,"user_id":12345,"is_paid_staff":false,"is_included_in_payment_policy":true},"meta":[]}}},"components/schemas/company_companyid_staff_staffid_response_data_types_deprecated":{"id":"components/schemas/company_companyid_staff_staffid_response_data_types_deprecated","kind":"json-schema","title":"Root Type for company_companyid_staff_staffid_response_data_types_deprecated","data":{"title":"Root Type for company_companyid_staff_staffid_response_data_types_deprecated","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":"team member ID"},"api_id":{"type":"string","description":"team member External ID"},"name":{"type":"string","description":"team member name"},"specialization":{"type":"string","description":"team member socialization"},"position":{"oneOf":[{"type":"object","properties":{"id":{"type":"number","description":"Job ID"},"title":{"type":"string","description":"Job Title"}}},{"type":"array","maxItems":0}],"description":"team member's position (empty array if not set)"},"show_rating":{"type":"number","description":"Whether to show the team member's rating (1 - show, 0 - do not show)"},"rating":{"type":"number","description":"team member Rating"},"votes_count":{"type":"number","description":"Number of votes that rated a team member"},"user_id":{"type":["number","null"],"description":"team member's linked user ID"},"avatar":{"type":"string","description":"Path to team member avatar file"},"avatar_big":{"type":"string","description":"The path to the team member's avatar file in a higher resolution"},"comments_count":{"type":"number","description":"Number of comments to the team member"},"weight":{"type":"string","description":"team member weight. team members are sorted by weight on exit, heavier first"},"information":{"type":"string","description":"Additional information about the team member (HTML format)"},"hidden":{"type":"string","description":"team member display status in online appointment booking, 1 - hidden, 0 - not hidden"},"fired":{"type":"string","description":"the team member's dismissal status, 1 - dismissed, 0 - not dismissed"},"status":{"type":"string","description":"team member deletion status, 1 - deleted, 0 - not deleted"},"image_group":{"oneOf":[{"type":"object"}],"properties":{"id":{"type":"integer","format":"int32"},"entity":{"type":"string"},"entity_id":{"type":"integer","format":"int32"},"images":{"type":"object","properties":{"sm":{"type":"object","properties":{"id":{"type":"integer"},"path":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"},"type":{"type":"string"},"image_group_id":{"type":"integer","format":"int32"},"version":{"type":"string"}}},"norm":{"type":"object","properties":{"id":{"type":"integer"},"path":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"},"type":{"type":"string"},"image_group_id":{"type":"integer","format":"int32"},"version":{"type":"string"}}},"origin":{"type":"object","properties":{"id":{"type":"integer"},"path":{"type":"string"},"width":{"type":"string"},"height":{"type":"string"},"type":{"type":"string"},"image_group_id":{"type":"integer","format":"int32"},"version":{"type":"string"}}}}}},"description":"Group of images of a team member"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Obsolete. Get a list of team members / specific team member","example":{"success":true,"data":[{"id":17969,"name":"Basil","specialization":"the hairdresser","position":{"id":1,"title":"Administrator"},"show_rating":0,"rating":0,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20151018220924_4963.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20151018220924_4963.jpg","comments_count":0,"weight":"10","information":"<span><span><span>&nbsp;</span></span></span>","hidden":"0","fired":"0","status":"0","image_group":{"id":72250,"entity":"master","entity_id":26427,"images":{"sm":{"id":186817,"path":"https://app.alteg.io/uploads/masters/sm/9/90/9041171cfdabe4c_20170327202542.jpeg","width":"100","height":"100","type":"jpeg","image_group_id":72250,"version":"sm"},"norm":{"id":186818,"path":"https://app.alteg.io/uploads/masters/norm/a/aa/aa37b29b7eb322d_20170327202542.jpeg","width":"180","height":"220","type":"jpeg","image_group_id":72250,"version":"norm"},"origin":{"id":186819,"path":"https://app.alteg.io/uploads/masters/origin/6/65/654dbeb4ea0bbc3_20170327202542.jpeg","width":"800","height":"600","type":"jpeg","image_group_id":72250,"version":"origin"}}}},{"id":34006,"api_id":"42","name":"Denis","specialization":"the hairdresser","position":{},"show_rating":0,"rating":0,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20151116091208_4369.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20151116091208_4369.jpg","comments_count":0,"weight":"9","information":"<span><span>&nbsp;</span></span>","hidden":"0","fired":"0","status":"0","image_group":{}},{"id":13616,"name":"Alexander","specialization":"the hairdresser","position":{},"show_rating":0,"rating":4.76921,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20251112123913_5162.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20251112123913_5162.jpg","comments_count":26,"weight":"8","information":"<span><span><span>&nbsp;</span></span></span>","hidden":"0","fired":"0","status":"0","image_group":{}}],"meta":[]}}},"components/schemas/position_compact":{"id":"components/schemas/position_compact","kind":"json-schema","title":"Object of model \"Position\"","data":{"title":"Object of model \"Position\"","description":"Data for an existing position in a chain.","type":"object","properties":{"id":{"type":"number","description":"ID of a position."},"title":{"type":"string","description":"Title of a position."}},"example":{"id":123,"title":"Position"}}},"components/schemas/master_with_position":{"id":"components/schemas/master_with_position","kind":"json-schema","title":"Object of model \"Team Member with Position\"","data":{"title":"Object of model \"Team Member with Position\"","type":"object","properties":{"id":{"type":"number","description":"ID of a team member."},"name":{"type":"string","description":"Name of a team member."},"company_id":{"type":"number","description":"ID of a location, where team member was created."},"specialization":{"type":"string","description":"Specialization of a team member."},"avatar":{"type":"string","description":"Link to the avatar of a team member (small)."},"avatar_big":{"type":"string","description":"Link to the avatar of a team member (original)."},"position":{"type":["object","null"],"description":"Position of a team member.","allOf":[{"$ref":"#/components/schemas/position_compact"}]},"is_paid_staff":{"type":"boolean","description":"Whether the team member is a paid staff member counted in license price."}},"example":{"id":123,"name":"John Johnson","company_id":123,"specialization":"Master","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Position"},"is_paid_staff":false}}},"components/schemas/company_companyid_staff_staffid_response403_data_types":{"id":"components/schemas/company_companyid_staff_staffid_response403_data_types","kind":"json-schema","title":"Root Type for company_companyid_staff_staffid_response403_data_types","data":{"title":"Root Type for company_companyid_staff_staffid_response403_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (false)"},"data":{"type":"string","description":"Contains null"},"meta":{"type":"object","properties":{"message":{"type":"string"}},"description":"Metadata (contains an error message)"}},"description":"Get a List of team members / Specific team member","example":{"success":false,"meta":{"message":"It is necessary to renew the license in the branch with id: {company_id}"}}}},"components/schemas/company_companyid_staff_staffid_response404_data_types":{"id":"components/schemas/company_companyid_staff_staffid_response404_data_types","kind":"json-schema","title":"Root Type for company_companyid_staff_staffid_response404_data_types","data":{"title":"Root Type for company_companyid_staff_staffid_response404_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (false)"},"meta":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}}},"description":"Metadata (contains an error message)"}},"description":"Get a List of team members / Specific team member","example":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"Location not specified."},{"message":"Team Member not listed"},{"message":"Team Member with ID {staff_id} was not found in branch {company_id}."}]}}}},"components/schemas/staff_position":{"id":"components/schemas/staff_position","kind":"json-schema","title":"staff_position","data":{"description":"Team member's position (object when assigned, null or empty array when unassigned)","oneOf":[{"type":"object","required":["id","title"],"properties":{"id":{"type":"number","description":"position id"},"title":{"type":"string","description":"job title"}}},{"type":"array","maxItems":0,"description":"Empty array when no position assigned"},{"type":"null","description":"Null when no position assigned"}],"example":{"id":123,"title":"Job title"}}},"components/schemas/company_staff_position_list_data_type":{"id":"components/schemas/company_staff_position_list_data_type","kind":"json-schema","title":"company_staff_position_list_data_type","data":{"required":["data","meta","success"],"type":"object","properties":{"data":{"type":"array","description":"Array of objects with data","items":{"$ref":"#/components/schemas/staff_position"}},"meta":{"type":"array","description":"Metadata (contains the number of posts found)","items":{"type":"object"}},"success":{"type":"boolean","description":"Execution success status (true)"}},"description":""}},"components/schemas/position":{"id":"components/schemas/position","kind":"json-schema","title":"Object of model \"Position\"","data":{"title":"Object of model \"Position\"","description":"Data for an existing position in a chain.","type":"object","properties":{"id":{"type":"number","description":"ID of a position."},"chain_id":{"type":"number","description":"ID of a chain, where position was created."},"title":{"type":"string","description":"Title of a position."},"description":{"type":"string","description":"Description of a position."},"services_binding_type":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of binding of services to a position:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - binding disabled;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - strict binding."},"children":[]}]}]}],"enum":[0,2]},"rules_required_fields":{"type":"array","description":"Fields required to be filled for a team member to be able to be linked to a position.","items":{"type":"string"}},"only_chain_appointment":{"type":"boolean","description":"Availability of linking a team member to a position only in a chain."}},"example":{"id":123,"chain_id":123,"title":"Position","description":"Position description","services_binding_type":0,"rules_required_fields":["employee_name","surname","middle_name","date_admission","date_registration_end","phone_number","citizenship","sex","identity_document","tax_id","number_insurance_certificates"],"only_chain_appointment":false}}},"components/schemas/clients_companyid_response_deprecated_data_types":{"id":"components/schemas/clients_companyid_response_deprecated_data_types","kind":"json-schema","title":"Root Type for clients_companyid_response_deprecated_data_types","data":{"title":"Root Type for clients_companyid_response_deprecated_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":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Customer phone"},"email":{"type":"string","description":"Client Email"},"categories":{"type":"array","description":"Client categories","items":{"type":"object","properties":{"id":{"type":"integer","description":"Category ID"},"title":{"type":"string","description":"name of category"},"color":{"type":"string","description":"Category color"}}}},"gender_id":{"type":"number","description":"Gender identifier, 0 - unknown, 1 - male, 2 - female"},"gender":{"type":"string","description":"Gender name"},"discount":{"type":"number","description":"Discount"},"importance_id":{"type":"integer","description":"Client priority level (0 - none, 1 - bronze, 2 - silver, 3 - gold)"},"importance":{"type":"string","description":"Client priority level name"},"card":{"type":"number","description":"Client card number"},"birth_date":{"type":"string","description":"Client's date of birth","format":"date"},"comment":{"type":"string","description":"Customer comment"},"sms_check":{"type":"number","description":"1 - Happy Birthday by SMS, 0 - do not congratulate"},"sms_not":{"type":"number","description":"1 - Exclude the client from SMS mailings, 0 - do not exclude"},"spent":{"type":"number","description":"How much money spent in the location at the time of adding"},"balance":{"type":"number","description":"Client balance"},"visits":{"type":"number","description":"Number of visits"},"last_change_date":{"type":"string","description":"Last modified date","format":"date-time"},"custom_fields":{"type":"object","properties":{},"description":"Additional client fields"}}}},"meta":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"total_count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the page number and number of clients per page)"}},"description":"Obsolete. Get a list of clients","example":{"success":true,"data":[{"id":66,"name":"Customer","phone":13155550177,"email":"asdfgh@g.com","categories":[{"id":3,"title":"Black list","color":"#0f0f0f"},{"id":4,"title":"VIP","color":"#e8d313"}],"gender_id":0,"gender":"unknown","discount":10,"importance_id":3,"importance":"Gold","card":123456789,"birth_date":"2026-09-21","comment":"test","sms_check":1,"sms_not":0,"spent":71842,"balance":0,"visits":34,"last_change_date":"2026-02-01T12:00:00-0500","custom_fields":{}},{"id":16,"name":"James","phone":13155550178,"email":"","categories":{},"gender_id":0,"gender":"unknown","discount":0,"importance_id":0,"importance":"No importance class","card":"","birth_date":null,"comment":"","sms_check":0,"sms_not":0,"spent":0,"balance":0,"visits":3,"last_change_date":"2026-04-01T12:00:00-0500","custom_fields":{}}],"meta":{"page":1,"total_count":8}}}},"components/schemas/company_companyid_clients_search_request_data_types":{"id":"components/schemas/company_companyid_clients_search_request_data_types","kind":"json-schema","title":"Root Type for company_cpmpanuid_clients_search_request_data_types","data":{"title":"Root Type for company_cpmpanuid_clients_search_request_data_types","type":"object","properties":{"page":{"type":"number","description":"Page number"},"page_size":{"type":"number","description":"The number of output lines per page. Maximum 200. (Default 25)"},"fields":{"type":"array","description":"Fields to be returned in the response","items":{"type":"string"}},"order_by":{"type":"string","description":"What field to sort by","enum":["id","name","phone","email","discount","first_visit_date","last_visit_date","sold_amount","visit_count"]},"order_by_direction":{"type":"string","description":"How to sort (ascending / descending)","enum":["ASC","DESC"]},"operation":{"type":"string","description":"Type of transaction","enum":["AND","OR"]},"filters":{"type":"array","description":"Filters for searching by customers","items":{"type":"object","properties":{"type":{"type":"string"},"state":{"type":"object","properties":{"value":{"type":"array","items":{"type":"number"}}},"description":"Filter type"}}}}},"description":"Get a list of clients","example":{"page":1,"page_size":3,"fields":["id","name"],"order_by":"name","order_by_direction":"desc","operation":"AND","filters":[{"type":"id","state":{"value":[1,2,3]}},{"type":"sold_amount","state":{"from":0,"to":100.77}},{"type":"quick_search","state":{"value":"James Smith"}},{"type":"importance","state":{"value":[0,1,2,3]}},{"type":"has_mobile_app","state":{"value":true}},{"type":"category","state":{"value":[1,7]}},{"type":"has_passteam_card","state":{"value":true}},{"type":"passteam_card_ids","state":{"value":["111122223333aaaabbbbcccc"]}},{"type":"birthday","state":{"from":"1990-01-01 00:00:00","to":"2000-01-01 23:59:59"}},{"type":"gender","state":{"value":[0,1,2]}},{"type":"record","state":{"staff":{"value":[1,2]},"service":{"value":[2,3]},"service_category":{"value":[4,5]},"status":{"value":[1]},"created":{"from":"2026-01-01 00:00:00","to":"2026-01-01 23:59:59"},"records_count":{"from":1,"to":99999},"sold_amount":{"from":1.001,"to":99999.09}}},{"type":"client","state":{"id":{"value":[1,2,3]},"birthday":{"from":"1990-01-01 00:00:00","to":"2000-01-01 23:59:59"}}},{"type":"sale","state":{"abonement_balance":{"from":2,"to":3}}}]}}},"components/schemas/company_companyid_clients_search_response_data_types":{"id":"components/schemas/company_companyid_clients_search_response_data_types","kind":"json-schema","title":"Root Type for company_companyid_clients_search_response_data_types","data":{"title":"Root Type for company_companyid_clients_search_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":{"name":{"type":"string","description":"Client name"},"id":{"type":"number","description":"Client ID"}}}},"meta":{"type":"object","properties":{"total_count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of clients found)"}},"description":"Get a list of clients","example":{"success":true,"data":[{"name":"James Smith","id":2},{"name":"Taylor Reed","id":3},{"name":"James Smith","id":1}],"meta":{"total_count":908}}}},"components/schemas/company_companyid_clients_search_response400_data_types":{"id":"components/schemas/company_companyid_clients_search_response400_data_types","kind":"json-schema","title":"Root Type for company_companyid_clients_search_response400_data_types","data":{"title":"Root Type for company_companyid_clients_search_response400_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (false)"},"data":{"type":"string","description":"Contains null"},"meta":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"string"}}}}},"description":"Metadata (contains an error message)"}},"description":"Get a list of clients","example":{"success":false,"meta":{"message":"Invalid filter value","errors":{"filters":["Invalid filter state value"]}}}}},"components/schemas/company_companyid_clients_search_response402_data_types":{"id":"components/schemas/company_companyid_clients_search_response402_data_types","kind":"json-schema","title":"Root Type for company_companyid_clients_search_response402_data_types","data":{"title":"Root Type for company_companyid_clients_search_response402_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (false)"},"data":{"type":"string","description":"Contains null"},"meta":{"type":"object","properties":{"message":{"type":"string"}},"description":"Metadata (contains an error message)"}},"description":"Get a list of clients","example":{"success":false,"meta":{"message":"It is necessary to renew the license in the branch with id: {company_id}"}}}},"components/schemas/company_companyid_clients_search_response404_data_types":{"id":"components/schemas/company_companyid_clients_search_response404_data_types","kind":"json-schema","title":"Root Type for company_companyid_clients_search_response404_data_types","data":{"title":"Root Type for company_companyid_clients_search_response404_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (false)"},"meta":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}}},"description":"Metadata (contains an error message)"}},"description":"Get a list of clients","example":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"Location not specified."},{"filters":["Invalid filter state value"]}]}}}},"components/schemas/client_comment_file_dto":{"id":"components/schemas/client_comment_file_dto","kind":"json-schema","title":"Object of model \"File in a client details\"","data":{"title":"Object of model \"File in a client details\"","description":"Data for an existing file in a client details.","type":"object","properties":{"link":{"type":"string","description":"Download link for a file in a client details."},"filename":{"type":"string","description":"Original filename for a file in a client details."}},"example":{"link":"https://api.alteg.io/client_files/download/123/123/","filename":"file.pdf"}}},"components/schemas/user_name_avatar":{"id":"components/schemas/user_name_avatar","kind":"json-schema","title":"Object of model \"User with name and avatar\"","data":{"title":"Object of model \"User with name and avatar\"","description":"Data for an existing user.","type":"object","properties":{"id":{"type":"number","description":"ID of a user."},"name":{"type":"string","description":"Name of a user."},"avatar":{"type":"string","description":"Avatar of a user."}},"example":{"id":123,"name":"John Johnson","avatar":"https://api.alteg.io/images/avatar.png"}}},"components/schemas/client_comment_container":{"id":"components/schemas/client_comment_container","kind":"json-schema","title":"Object of model \"Comment for a client\"","data":{"title":"Object of model \"Comment for a client\"","description":"Data for an existing comment for a client.","type":"object","properties":{"id":{"type":"number","description":"ID of a comment for a client."},"create_date":{"type":"string","description":"Datetime of a comment for a client created.","format":"date-time"},"update_date":{"type":"string","description":"Datetime of a comment for a client last updated.","format":"date-time"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of a comment for a client:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - text comment;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - uploaded file."},"children":[]}]}]}],"enum":["default","file"]},"text":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text of a comment for a client ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = \"default\", for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = \"file\" the text is returned empty)."},"children":[]}]}]}]},"files":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files in a client details that triggered the comment creation ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = \"file\", for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = \"default\" the files array is returned empty)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/client_comment_file_dto"}},"user":{"type":["object","null"],"description":"User created a comment for a client or uploaded files in a client details.","allOf":[{"$ref":"#/components/schemas/user_name_avatar"}]}},"example":{"id":123,"create_date":"2026-01-01T12:12:12-05:00","update_date":"2026-01-01T12:12:12-05:00","type":"default","text":"Comment for a client","files":[],"user":{"id":123,"name":"John Johnson","avatar":"https://api.alteg.io/images/avatar.png"}}}},"components/schemas/response_meta_count_object":{"id":"components/schemas/response_meta_count_object","kind":"json-schema","title":"Meta object with response results count","data":{"title":"Meta object with response results count","type":"object","description":"Additional response data.","properties":{"count":{"type":"number","description":"Response data objects count.","example":10}}}},"components/schemas/clients_files_clientid_reaponse_data_types":{"id":"components/schemas/clients_files_clientid_reaponse_data_types","kind":"json-schema","title":"Root Type for clients_files_clientid_reaponse_data_types","data":{"title":"Root Type for clients_files_clientid_reaponse_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":"File ID"},"client_id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"File name with extension"},"description":{"type":"string","description":"File Description"},"date_create":{"type":"string","description":"File upload date in ISO8601 format","format":"date-time"},"extension":{"type":"string","description":"File name extension"},"mime":{"type":"string","description":"MIME file type"},"link":{"type":"string","description":"File download link"},"user_name":{"type":"string","description":"The name of the user who uploaded the file"},"user_avatar":{"type":"string","description":"Avatar of the user who uploaded the file"},"size":{"type":"string","description":"Formatted file size string"},"can_edit":{"type":"boolean","description":"Is there a right to change and delete the file? true - there is a right, false - there is no right"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of files)"}},"description":"Sample Request to Get a List of Client Files","example":{"success":true,"data":[{"id":123,"client_id":123456,"name":"test.txt","description":"","date_create":"2026-01-01T12:00:00-0500","extension":"txt","mime":"text/plain","link":"/client_files/download/456/123/","user_name":"Victor Sitnikov","user_avatar":"/images/no-master.png","size":"9 B","can_edit":false},{"id":789,"client_id":123456,"name":"photo.jpg","description":"","date_create":"2026-01-30T12:30:00-0500","extension":"jpg","mime":"image/jpeg","link":"/client_files/download/456/789/","user_name":"Victor Sitnikov","user_avatar":"/images/no-master.png","size":"96.65 KB","can_edit":true}],"meta":{"count":2}}}},"components/schemas/client_visits_history_goods_transaction_good":{"id":"components/schemas/client_visits_history_goods_transaction_good","kind":"json-schema","title":"The object of the model \"Sold product in the history of customer visits\"","data":{"title":"The object of the model \"Sold product in the history of customer visits\"","description":"Data of the product sold.","type":"object","properties":{"id":{"type":"number","description":"Product ID."},"title":{"type":"string","description":"Name of product."},"amount":{"type":"number","description":"Number of products sold."},"unit":{"type":"string","description":"Unit of measure for the product sold."},"cost_per_unit":{"type":"number","description":"Unit price without discount."},"first_cost":{"type":"number","description":"Price of the whole product without discount."},"discount_percent":{"type":"number","description":"Percent discount."},"cost_to_pay":{"type":"number","description":"Price of the product including the discount."},"paid_sum":{"type":"number","description":"Price of the product including the discount."},"payment_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit payment status:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is not paid, no payments were made for the visit;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_not_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is partially paid;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is paid in full, there is no overpayment;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_over"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - there is an overpayment for the visit."},"children":[]}]}]}],"enum":["not_paid","paid_not_full","paid_full","paid_over"]}},"example":{"id":123,"title":"My product","amount":-1,"unit":"PCS.","cost_per_unit":1000,"first_cost":-1000,"discount_percent":0,"cost_to_pay":1000,"paid_sum":1000,"payment_status":"paid_full"}}},"components/schemas/company_minimal":{"id":"components/schemas/company_minimal","kind":"json-schema","title":"Model object \"Location, minimum information\"","data":{"title":"Model object \"Location, minimum information\"","type":"object","properties":{"id":{"type":"number","description":"ID of the location location."},"title":{"type":"string","description":"Name of location."}},"example":{"id":123,"title":"My branch office."}}},"components/schemas/client_visits_history_goods_transaction":{"id":"components/schemas/client_visits_history_goods_transaction","kind":"json-schema","title":"The object of the model \"Sale of goods in the history of visits to the client\"","data":{"title":"The object of the model \"Sale of goods in the history of visits to the client\"","description":"Product sales data.","type":"object","properties":{"id":{"type":"number","description":"Identifier of the transaction for the sale of products."},"comment":{"type":"string","description":"A comment."},"date":{"type":"string","description":"Date of sale.","format":"date-time"},"visit_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit ID. Equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there is no connection to the visit."},"children":[]}]}]}]},"record_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment ID. Equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if there is no link to the appointment."},"children":[]}]}]}]},"goods":{"type":"array","description":"List of products sold.","items":{"$ref":"#/components/schemas/client_visits_history_goods_transaction_good"}},"staff":{"type":"object","description":"team member who sold the product.","allOf":[{"$ref":"#/components/schemas/master_with_position"}]},"company":{"type":"object","description":"Minimum information about the store where the product was sold.","allOf":[{"$ref":"#/components/schemas/company_minimal"}]}},"example":{"id":123,"comment":"Comment to the sale of products","date":"2026-01-31T12:34:56-05:00","visit_id":0,"record_id":0,"goods":[{"id":123,"title":"My product","amount":-1,"unit":"PCS.","cost_per_unit":1000,"first_cost":-1000,"discount_percent":0,"cost_to_pay":1000,"paid_sum":1000,"payment_status":"paid_full"}],"staff":{"id":123,"name":"James Smith","company_id":123,"specialization":"Master","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"team member"}},"company":{"id":123,"title":"My branch office."}}}},"components/schemas/client_visits_history_record_service_consumable":{"id":"components/schemas/client_visits_history_record_service_consumable","kind":"json-schema","title":"Model object \"Consumable in service\"","data":{"title":"Model object \"Consumable in service\"","description":"Consumable data.","type":"object","properties":{"title":{"type":"string","description":"Consumable name."},"amount":{"type":"number","description":"Quantity of the item in the unit of measure selected by the user."},"cost_per_unit":{"type":"number","description":"Cost per item."},"unit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the item`s unit of measurement."},"children":[]}]}]}]}},"example":{"title":"My consumable","amount":1,"cost_per_unit":1000,"unit":"PCS."}}},"components/schemas/client_visits_history_record_service":{"id":"components/schemas/client_visits_history_record_service","kind":"json-schema","title":"Model object \"Service in customer`s history appointment\"","data":{"title":"Model object \"Service in customer`s history appointment\"","description":"Service data.","type":"object","properties":{"id":{"type":"number","description":"Service identifier."},"title":{"type":"string","description":"Name of service."},"first_cost":{"type":"number","description":"Price of service without discount."},"discount_percent":{"type":"number","description":"Percent discount."},"cost_to_pay":{"type":"number","description":"The cost of the service including the discount."},"paid_sum":{"type":"number","description":"The amount that was paid by the customer."},"payment_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit payment status:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is not paid, no payments were made for the visit;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_not_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is partially paid;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is paid in full, there is no overpayment;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_over"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - there is an overpayment for the visit."},"children":[]}]}]}],"enum":["not_paid","paid_not_full","paid_full","paid_over"]},"consumables":{"type":"array","description":"Product consumables attached to this service.","items":{"$ref":"#/components/schemas/client_visits_history_record_service_consumable"}}},"example":{"id":123,"title":"My service","first_cost":1000,"discount_percent":0,"cost_to_pay":1000,"paid_sum":1000,"payment_status":"paid_full","consumables":[{"title":"My consumable","amount":1,"cost_per_unit":1000,"unit":"PCS."}]}}},"components/schemas/tips_reduce":{"id":"components/schemas/tips_reduce","kind":"json-schema","title":"Model object \"Presence of tip without amount\"","data":{"title":"Model object \"Presence of tip without amount\"","type":"object","description":"Information about the availability of tips to the team member. The model is used when the current user is not the team member of the appointment.","properties":{"has_tips":{"type":"boolean","description":"Is there a tip in this appointment."},"sum":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tip amount is not counted and is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"example":{"has_tips":false,"sum":null}}},"components/schemas/tips_reduce_with_full_info":{"id":"components/schemas/tips_reduce_with_full_info","kind":"json-schema","title":"Total tip model object","data":{"title":"Total tip model object","type":"object","description":"Information about the amount of all tips to the team member. Used if the current user is the team member of this appointment.","properties":{"has_tips":{"type":"boolean","description":"Is there a tip in this appointment."},"sum":{"type":["number","null"],"description":"Amount of tip."}},"example":{"has_tips":false,"sum":1000}}},"components/schemas/comer":{"id":"components/schemas/comer","kind":"json-schema","title":"Visitor model object","data":{"title":"Visitor model object","type":"object","properties":{"id":{"type":"number","description":"Visitor ID."},"title":{"type":"string","description":"Visitor name."},"slug":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visitor type:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - person;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - pet;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vehicle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - a vehicle."},"children":[]}]}]}],"enum":["person","pet","vehicle"]}},"example":{"id":123,"title":"James Smith","slug":"person"}}},"components/schemas/client_visits_history_record":{"id":"components/schemas/client_visits_history_record","kind":"json-schema","title":"The object of the model \"Appointment in the history of visits to the client\"","data":{"title":"The object of the model \"Appointment in the history of visits to the client\"","description":"Client appointment data.","type":"object","properties":{"id":{"type":"number","description":"Appointment ID."},"comment":{"type":"string","description":"A comment."},"date":{"type":"string","description":"Date of appointment.","format":"date-time"},"visit_id":{"type":"number","description":"Visit ID."},"attendance":{"type":"number","description":"Appointment status in visit"},"services":{"type":"array","description":"Services in appointment.","items":{"$ref":"#/components/schemas/client_visits_history_record_service"}},"staff":{"type":"object","description":"team member who provided the service.","allOf":[{"$ref":"#/components/schemas/master_with_position"}]},"company":{"type":"object","description":"Minimum information about the store where the item was sold.","allOf":[{"$ref":"#/components/schemas/company_minimal"}]},"tips":{"type":"object","description":"Tipping data. Different models are used depending on whether the current user is the team member in the appointment.","oneOf":[{"$ref":"#/components/schemas/tips_reduce"},{"$ref":"#/components/schemas/tips_reduce_with_full_info"}]},"comer":{"type":"object","description":"Visitor data. If the visitor is not specified, then the field is not displayed.","allOf":[{"$ref":"#/components/schemas/comer"}]}},"example":{"id":123,"comment":"Comment to post","date":"2026-01-31T12:34:56-05:00","visit_id":123,"attendance":1,"services":[{"id":123,"title":"My service","first_cost":1000,"discount_percent":0,"cost_to_pay":1000,"paid_sum":1000,"payment_status":"paid_full","consumables":[{"title":"My consumable","amount":1,"cost_per_unit":1000,"unit":"PCS."}]}],"staff":{"id":123,"name":"James Smith","company_id":123,"specialization":"Master","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"team member"}},"company":{"id":123,"title":"My branch office."},"tips":{"has_tips":false,"sum":null},"comer":{"id":123,"title":"James Smith","slug":"person"}}}},"components/schemas/client_visits_history":{"id":"components/schemas/client_visits_history","kind":"json-schema","title":"Customer History Model Object","data":{"title":"Customer History Model Object","description":"Data on customer visits, including appointments and product sales.","type":"object","properties":{"goods_transactions":{"type":"array","description":"List of product sales transactions.","items":{"$ref":"#/components/schemas/client_visits_history_goods_transaction"}},"records":{"type":"array","description":"List of customer appointments.","items":{"$ref":"#/components/schemas/client_visits_history_record"}}},"example":{"goods_transactions":[{"id":123,"comment":"Comment to the sale of goods","date":"2026-01-31T12:34:56-05:00","visit_id":0,"record_id":0,"goods":[{"id":123,"title":"My product","amount":-1,"unit":"PCS.","cost_per_unit":1000,"first_cost":-1000,"discount_percent":0,"cost_to_pay":1000,"paid_sum":1000,"payment_status":"paid_full"}],"staff":{"id":123,"name":"James Smith","company_id":123,"specialization":"Master","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"team member"}},"company":{"id":123,"title":"My branch office."}}],"records":[{"id":123,"comment":"Comment to post","date":"2026-01-31T12:34:56-05:00","visit_id":123,"attendance":1,"services":[{"id":123,"title":"My service","first_cost":1000,"discount_percent":0,"cost_to_pay":1000,"paid_sum":1000,"payment_status":"paid_full","consumables":[{"title":"My consumable","amount":1,"cost_per_unit":1000,"unit":"PCS."}]}],"staff":{"id":123,"name":"James Smith","company_id":123,"specialization":"Master","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"team member"}},"company":{"id":123,"title":"My branch office."},"tips":{"has_tips":false,"sum":null},"comer":{"id":123,"title":"James Smith","slug":"person"}}]}}},"components/schemas/response_meta_date_paginator_object":{"id":"components/schemas/response_meta_date_paginator_object","kind":"json-schema","title":"An object of date-based pagination information.","data":{"title":"An object of date-based pagination information.","description":"Page navigation information containing information about the current, next, and previous pages.\nThe data is sorted and paginated by date in descending order.\n","type":"object","properties":{"dateCursor":{"type":"object","description":"Pagination information.","properties":{"previous":{"type":"object","description":"Information about the previous page.","properties":{"to":{"type":["string","null"],"description":"Up to which date, inclusive, the data on the previous page is filtered.","format":"date"},"from":{"type":["string","null"],"description":"From what date the data on the previous page is filtered.","format":"date"},"count":{"type":["number","null"],"description":"Number of items on the previous page."}}},"current":{"type":"object","description":"Information about the current page.","properties":{"to":{"type":["string","null"],"description":"Up to which date, inclusive, the data on the current page is filtered.","format":"date"},"from":{"type":["string","null"],"description":"From what date the data on the current page is filtered.","format":"date"},"count":{"type":["number","null"],"description":"Number of items on the current page."}}},"next":{"type":"object","description":"Information about the previous page.","properties":{"to":{"type":["string","null"],"description":"Up to which date, inclusive, the data on the next page is filtered.","format":"date"},"from":{"type":["string","null"],"description":"From what date the data on the next page is filtered.","format":"date"},"count":{"type":["number","null"],"description":"Number of items on the next page."}}}}}},"example":{"dateCursor":{"previous":{"to":"2022-01-31","from":"2022-01-20","count":7},"current":{"to":"2022-01-19","from":"2022-01-15","count":25},"next":{"to":"2022-01-14","from":"2022-01-05","count":25}}}}},"components/schemas/company_company_id_users_response_data_types":{"id":"components/schemas/company_company_id_users_response_data_types","kind":"json-schema","title":"company_company_id_users_response_data_types","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Response status."},"data":{"type":"array","description":"Response data.","items":{"type":"object","properties":{"id":{"type":"number","description":"User ID"},"name":{"type":"string","description":"User name"},"phone":{"type":"string","description":"User phone"},"email":{"type":"string","description":"User email"},"information":{"type":"string","description":"User information"},"is_approved":{"type":"boolean","description":"Whether the user accepted the invitation to manage the location"},"is_non_deletable":{"type":"boolean","description":"Whether the user is non-deletable"}}}},"meta":{"type":"object","properties":{"count":{"type":"number","description":"Number of users found"}},"description":"Additional response data."}},"description":"Get location users","example":{"success":true,"data":[{"id":10,"name":"Bob","phone":"+13155550184","email":"test@gmail.com","information":"manager","is_approved":false,"is_non_deletable":false},{"id":11,"name":"Oliver","phone":"+13155550185","email":"test@gmail.com","information":"Administrator","is_approved":true,"is_non_deletable":true}],"meta":{"count":2}}}},"components/schemas/company_users_deprecated_response_data_types":{"id":"components/schemas/company_users_deprecated_response_data_types","kind":"json-schema","title":"Root Type for company_users_deprecated_response_data_types","data":{"title":"Root Type for company_users_deprecated_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":"User ID"},"firstname":{"type":"string","description":"Username"},"login":{"type":"string","description":"user login for authorization in the system (for authorization, you can also use the phone and email fields as a login)"},"email":{"type":"string","description":"User mailing address"},"phone":{"type":"string","description":"User phone"},"information":{"type":"string","description":"User information"},"access":{"type":"object","properties":{"stat_access":{"type":"boolean","description":"true - there is access to analytics, false - no access"},"schedule_edit_access":{"type":"boolean","description":"true - there is access to the team member's work schedule in the log, false - no access"},"client_phones_access":{"type":"boolean","description":"true - there is access to phone numbers in the list of clients, false - no access"},"clients_access":{"type":"boolean","description":"true - there is access to the client base, false - no access"},"settings_access":{"type":"boolean","description":"true - there is access to the settings section, false - no access"},"edit_records_access":{"type":"boolean","description":"true - there is access to change records, false - no access"},"timetable_access":{"type":"boolean","description":"true - there is access to the appointment log, false - no access"},"billing_access":{"type":"boolean","description":"true - there is access to billing (balance menu section), false - no access"},"users_access":{"type":"boolean","description":"true - there is access to user management, false - no access"},"excel_access":{"type":"boolean","description":"1 - there is access to unloading the list of clients in Excel, 0 - no access"},"finances_access":{"type":"boolean","description":"true - there is access to finances, false - no access"},"storages_access":{"type":"boolean","description":"true - there is access to the inventory, false - no access"},"send_sms":{"type":"boolean","description":"true - there is access to SMS distribution to clients, false - no access"},"master_id":{"type":"number","description":"0 - if the user can view the schedule and records of all team members, otherwise only the team member whose ID is specified"}},"description":"Object of user access rights to system modules"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get location users","example":{"success":true,"data":[{"id":224348,"firstname":"James","login":"j.smith","email":"j.smith@example.com","phone":"+13155550175","information":"Test user","access":{"stat_access":true,"schedule_edit_access":false,"client_phones_access":false,"clients_access":false,"settings_access":false,"edit_records_access":false,"timetable_access":true,"billing_access":false,"users_access":false,"excel_access":false,"finances_access":false,"storages_access":false,"send_sms":true,"master_id":0}},{"id":11,"firstname":"James","login":"j.smith","email":"j.smith@example.com","phone":"+13155550175","information":"Test user","access":{"stat_access":true,"schedule_edit_access":true,"client_phones_access":true,"clients_access":true,"settings_access":true,"edit_records_access":true,"timetable_access":true,"billing_access":true,"users_access":false,"excel_access":true,"finances_access":true,"storages_access":true,"send_sms":true,"master_id":0}}],"meta":[]}}},"components/schemas/user_permissions_response_data_types":{"id":"components/schemas/user_permissions_response_data_types","kind":"json-schema","title":"Root Type for user_permissions_response_data_types","data":{"title":"Root Type for user_permissions_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"timetable":{"type":"object","properties":{"timetable_access":{"type":"boolean","description":"true - there is access to the appointment log, false - no access"},"master_id":{"type":"number","description":"0 - if the user can view the schedule and records of all team members, otherwise only the team member whose ID is specified"},"position_id":{"type":"number","description":"0 - if the user can view the schedule and records of all team members, otherwise only the position whose ID is specified"},"last_days_count":{"type":"number","description":"0 - do not restrict access to schedule history and records"},"schedule_edit_access":{"type":"boolean","description":"true - there is access to the team member's work schedule in the log, false - no access"},"timetable_phones_access":{"type":"boolean","description":"true - there is access to the phone number in the appointment log, false - no access"},"timetable_transferring_record_access":{"type":"boolean","description":"true - there is access to transferring records, false - no access"},"timetable_statistics_access":{"type":"boolean","description":"true - there is access to view statistics, false - no access"},"timetable_waiting_list_access":{"type":"boolean","description":"true - there is access to waiting list, false - no access"}},"description":"Appointment log"},"record_form":{"type":"object","properties":{"record_form_access":{"type":"boolean","description":"true - there is access to the appointment form, false - no access"},"record_form_client_access":{"type":"boolean","description":"true - there is access to customer data, false - no access"},"records_autocomplete_access":{"type":"boolean","description":"true - there is access to the drop-down list with customer data, false - no access"},"create_records_access":{"type":"boolean","description":"true - there is access to create appointments, false - no access to Create appointments"},"edit_records_access":{"type":"boolean","description":"true - there is access to change records, false - no access"},"edit_records_attendance_access":{"type":"boolean","description":"true - there is access to records with visit status \"customer arrived\", false - no access"},"records_services_cost_access":{"type":"boolean","description":"true - there is access to change the cost of services, false - no access"},"records_services_discount_access":{"type":"boolean","description":"true - there is access to change discounts for services, false - no access"},"record_edit_full_paid_access":{"type":"boolean","description":"true - there is access to edit the paid post, false - no access"},"delete_records_access":{"type":"boolean","description":"true - there is access to delete the appointment, false - no access"},"delete_customer_came_records_access":{"type":"boolean","description":"true - there is access to delete records with the \"client has arrived\" status, false - no access"},"delete_paid_records_access":{"type":"boolean","description":"true - there is access to delete paid appointments, false - no access"},"records_goods_access":{"type":"boolean","description":"true - there is access to product sales, false - no access"},"records_goods_create_transaction_access":{"type":"boolean","description":"true - there is access to create commodity transactions, false - no access"},"records_goods_create_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - access to create commodity transactions for all time, >= 0 - access to create commodity transactions for the specified number of days in the past"},"children":[]}]}]}]},"records_goods_edit_transaction_access":{"type":"boolean","description":"true - there is access to editing commodity transactions, false - no access"},"records_goods_edit_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - there is access to editing commodity transactions for all time, >= 0 - access to editing commodity transactions for the specified number of days in the past''"},"children":[]}]}]}]},"records_goods_cost_access":{"type":"boolean","description":"true - there is access to change the cost of products, false - no access"},"records_goods_discount_access":{"type":"boolean","description":"true - there is access to change product discounts, false - no access"},"records_finances_access":{"type":"boolean","description":"true - there is access to payment, false - no access"},"records_finances_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - there is access to making payments in records for the whole time, >= 0 - access to making payments in records for the specified number of days in the past"},"children":[]}]}]}]},"records_finances_pay_from_deposits_access":{"type":"boolean","description":"true - there is access to making payments in records from the client's personal account, false - no access"},"records_group_id_access":{"type":"boolean","description":"true - there is access to client data over the chain, false - no access"},"records_group_id":{"type":"number","description":"ID of the chain to which there is access to customer data"},"record_form_client_add_access":{"type":"boolean","description":"true - there is access to add clients from appointment form, false - no access"},"records_autocomplete_phone_access":{"type":"boolean","description":"true - there is access to phone autocomplete in appointment form, false - no access"},"assistants_management_access":{"type":"boolean","description":"true - there is access to manage assistants, false - no access"},"assistants_reward_share_edit_access":{"type":"boolean","description":"true - there is access to edit assistant reward share, false - no access"},"records_edit_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - access to edit appointments for all time, >= 0 - access to edit appointments for the specified number of days in the past"},"children":[]}]}]}]},"records_edit_date_and_master_access":{"type":"boolean","description":"true - there is access to edit appointment date and team member, false - no access"},"records_edit_duration_access":{"type":"boolean","description":"true - there is access to edit appointment duration, false - no access"},"records_edit_comment_access":{"type":"boolean","description":"true - there is access to edit appointment comment, false - no access"},"records_edit_services_access":{"type":"boolean","description":"true - there is access to edit appointment services, false - no access"},"records_consumables_edit_access":{"type":"boolean","description":"true - there is access to edit appointment consumables, false - no access"},"record_edit_full_paid_client_came_access":{"type":"boolean","description":"true - there is access to edit fully paid appointments with client arrived status, false - no access"},"record_edit_full_paid_client_confirm_access":{"type":"boolean","description":"true - there is access to edit fully paid appointments with client confirmed status, false - no access"},"custom_fields_client_values_read_access":{"type":"boolean","description":"true - there is access to read client custom field values, false - no access"},"custom_fields_client_values_edit_access":{"type":"boolean","description":"true - there is access to edit client custom field values, false - no access"},"custom_fields_record_values_read_access":{"type":"boolean","description":"true - there is access to read appointment custom field values, false - no access"},"custom_fields_record_values_edit_access":{"type":"boolean","description":"true - there is access to edit appointment custom field values, false - no access"}},"description":"Appointment window"},"finances":{"type":"object","properties":{"finances_access":{"type":"boolean","description":"true - there is access to finances, false - no access"},"finances_accounts_ids":{"type":"array","description":"array of IDs to selected checkouts","items":{"type":"object"}},"finances_transactions_access":{"type":"boolean","description":"true - there is access to view funds movements, false - no access"},"finances_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - access to view funds movements for the whole time, >= 0 - access to view funds movements for the specified number of days in the past"},"children":[]}]}]}]},"finances_create_transactions_access":{"type":"boolean","description":"true - there is access to create transactions, false - no access"},"finances_create_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - there is access to create transactions for all time, >= 0 - access to create transactions for the specified number of days in the past"},"children":[]}]}]}]},"finances_edit_transactions_access":{"type":"boolean","description":"true - there is access to editing transactions, false - no access"},"finances_edit_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - there is access to editing transactions for all time, >= 0 - access to editing transactions for the specified number of days in the past"},"children":[]}]}]}]},"finances_delete_transactions_access":{"type":"boolean","description":"true - there is access to delete transactions, false - no access"},"finances_transactions_excel_access":{"type":"boolean","description":"true - there is access to unloading cash flows in Excel, false - no access"},"finances_expenses_ids":{"type":"array","description":"true - there is access to transfers between location accounts, false - no access","items":{"type":"object"}},"finances_accounts_access":{"type":"boolean","description":"true - there is access to accounts and location accounts, false - no access"},"finances_accounts_limited_access":{"type":"boolean","description":"true - there is limited access to accounts, false - no access"},"finances_accounts_banalce_access":{"type":"boolean","description":"true - there is access to the balance, false - no access"},"finances_suppliers_read_access":{"type":"boolean","description":"true - there is access to counterparties, false - no access"},"finances_suppliers_create_access":{"type":"boolean","description":"true - there is access to create counterparties, false - no access"},"finances_suppliers_update_access":{"type":"boolean","description":"true - there is access to change counterparties, false - no access"},"finances_suppliers_delete_access":{"type":"boolean","description":"true - there is access to deleting counterparties, false - no access"},"finances_suppliers_excel_access":{"type":"boolean","description":"true - there is access to export to Excel, false - no access"},"finances_expenses_read_access":{"type":"boolean","description":"true - there is access to the payment item, false - no access"},"expenses_read_access":{"type":"boolean","description":"true - there is access to the payment item, false - no access"},"finances_expenses_create_access":{"type":"boolean","description":"true - there is access to create a payment item, false - no access"},"expenses_create_access":{"type":"boolean","description":"true - there is access to create a payment item, false - no access"},"finances_expenses_update_access":{"type":"boolean","description":"true - there is access to change the payment item, false - no access"},"expenses_update_access":{"type":"boolean","description":"true - there is access to change the payment item, false - no access"},"finances_expenses_delete_access":{"type":"boolean","description":"true - there is access to deleting a payment item, false - no access"},"expenses_delete_access":{"type":"boolean","description":"true - there is access to deleting a payment item, false - no access"},"finances_kkm_transactions_access":{"type":"boolean","description":"true - there is access to operations with KKM, false - no access"},"kkm_transactions_accounts_access":{"type":"boolean","description":"true - there is access to operations with KKM, false - no access"},"finances_kkm_settings_read_access":{"type":"boolean","description":"true - access to KKM settings, false - no access"},"kkm_settings_reed_access":{"type":"boolean","description":"true - access to KKM settings, false - no access"},"finances_kkm_settings_update_access":{"type":"boolean","description":"true - there is access to change KKM, false - no access"},"kkm_settings_update_access":{"type":"boolean","description":"true - there is access to change KKM, false - no access"},"finances_settings_invoicing_read_access":{"type":"boolean","description":"true - there is access to online payments, false - no access"},"finances_settings_invoicing_update_access":{"type":"boolean","description":"true - there is access to change online payments, false - no access"},"settings_invoicing_read_access":{"type":"boolean","description":"true - there is access to online payments, false - no access"},"settings_invoicing_update_access":{"type":"boolean","description":"true - there is access to change online payments, false - no access"},"finances_options_read_access":{"type":"boolean","description":"true - there is access to payment settings, false - no access"},"options_read_access":{"type":"boolean","description":"true - there is access to read payment options, false - no access"},"finances_options_update_access":{"type":"boolean","description":"true - there is access to change payment settings, false - no access"},"options_update_access":{"type":"boolean","description":"true - there is access to change payment settings, false - no access"},"finances_salary_schemes_access":{"type":"boolean","description":"true - there is access to payroll schemes, false - no access"},"finances_salary_calc_access":{"type":"boolean","description":"true - there is access to payroll, false - no access"},"finances_salary_not_limitation_today_access":{"type":"boolean","description":"true - there is access to payroll, false - access to payroll for the current day"},"finances_payroll_calculation_create_access":{"type":"boolean","description":"true - there is access to payroll, false - no access"},"finances_payroll_calculation_create_not_limitation_today_access":{"type":"boolean","description":"true - there is access to payroll, false - access to payroll for the current day"},"finances_salary_access_master_checkbox":{"type":"boolean","description":"true - only a specific team member has access to payroll, false - full access"},"finances_salary_access_master_id":{"type":"number","description":"ID of the team member to whom you have access to payroll"},"get_salary_access_master_id":{"type":"number","description":"ID of the team member to whom you have access to payroll"},"finances_salary_master_not_limitation_today_access":{"type":"boolean","description":"true - do not restrict to the current day, false - access only for today"},"finances_payroll_calculation_create_by_master_access":{"type":"boolean","description":"true - there is access to payroll for a specific team member, false - no restrictions"},"calculation_create_by_master_not_limitation_today_access":{"type":"boolean","description":"true - there is access to payroll, false - no access"},"finances_period_report_access":{"type":"boolean","description":"true - there is access to the report for the period, false - no access"},"finances_period_report_excel_access":{"type":"boolean","description":"true - there is access to uploading a report for the period to Excel, false - no access"},"finances_year_report_access":{"type":"boolean","description":"true - there is access to the annual report, false - no access"},"finances_year_report_excel_access":{"type":"boolean","description":"true - there is access to exporting the annual report to Excel, false - no access"},"finances_print_check_access":{"type":"boolean","description":"true - there is access to receipt printing, false - no access"},"finances_z_report_access":{"type":"boolean","description":"true - there is access to the daily location account report, false - no access"},"finances_z_report_no_limit_today_access":{"type":"boolean","description":"true - there is access to the location account report, false - access to the location account report for the current day"},"finances_z_report_excel_access":{"type":"boolean","description":"true - there is access to export to Excel, false - no access"},"payment_policy_read_access":{"type":"boolean","description":"true - there is access to read the payment policy, false - no access"},"payment_policy_update_access":{"type":"boolean","description":"true - there is access to change the payment policy, false - no access"}},"description":"Section Finance"},"clients":{"type":"object","properties":{"clients_access":{"type":"boolean","description":"true - there is access to the client base, false - no access"},"client_phones_access":{"type":"boolean","description":"true - there is access to phone numbers in the list of clients, false - no access"},"clients_phones_email_access":{"type":"boolean","description":"true - there is access to phone numbers and emails in the list of clients, false - no access"},"clients_card_phone_access":{"type":"boolean","description":"true - there is access to phones in the client card, false - no access"},"clients_delete_access":{"type":"boolean","description":"true - there is access to delete clients, false - no access"},"clients_excel_access":{"type":"boolean","description":"true - there is access to unloading the list of clients in Excel, false - no access"},"excel_access":{"type":"boolean","description":"1 - there is access to unloading the list of clients in Excel, 0 - no access"},"client_comments_list_access":{"type":"boolean","description":"true - there is access to view comments, false - no access"},"client_comments_add_access":{"type":"boolean","description":"true - there is access to add comments, false - no access"},"client_comments_own_edit_access":{"type":"boolean","description":"true - you have access to change/delete your comments, false - no access"},"client_comments_other_edit_access":{"type":"boolean","description":"true - there is access to change/delete other people's comments, false - no access"},"client_files_list_access":{"type":"boolean","description":"true - there is access to view and download files, false - no access"},"client_files_upload_access":{"type":"boolean","description":"true - there is access to upload files, false - no access"},"client_files_delete_access":{"type":"boolean","description":"true - there is access to delete files, false - no access"},"clients_visit_master_id":{"type":"number","description":"ID of the team member by which you can see the clients who visited the team member, 0 - no restrictions"},"get_visit_master_id":{"type":"number","description":"ID of the team member by which you can see the clients who visited the team member, 0 - no restrictions"},"clients_phones_access":{"type":"boolean","description":"true - there is access to client phones, false - no access"},"clients_edit_access":{"type":"boolean","description":"true - there is access to edit clients, false - no access"},"clients_deposits_access":{"type":"boolean","description":"true - there is access to client accounts, false - no access"},"clients_deposits_create_access":{"type":"boolean","description":"true - there is access to create client accounts, false - no access"},"clients_deposits_history_access":{"type":"boolean","description":"true - there is access to client account history, false - no access"},"clients_deposits_topup_access":{"type":"boolean","description":"true - there is access to top up client accounts, false - no access"},"clients_loyalty_read_access":{"type":"boolean","description":"true - there is access to read client loyalty data, false - no access"},"clients_loyalty_settings_access":{"type":"boolean","description":"true - there is access to client loyalty settings, false - no access"},"clients_card_comment_access":{"type":"boolean","description":"true - there is access to view client card comments, false - no access"},"clients_card_comment_edit_access":{"type":"boolean","description":"true - there is access to edit client card comments, false - no access"},"clients_surname_middle_name_access":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true - there is access to view client surname and middle_name, false - no access"},"children":[]}]}]}]},"clients_surname_patronymic_access":{"type":"boolean","description":"true - there is access to view client surname and legacy middle-name field, false - no access"},"clients_surname_middle_name_edit_access":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true - there is access to edit client surname and middle_name, false - no access"},"children":[]}]}]}]},"clients_surname_patronymic_edit_access":{"type":"boolean","description":"true - there is access to edit client surname and legacy middle-name field, false - no access"},"clients_show_attendance_history_access":{"type":"boolean","description":"true - there is access to show client attendance history, false - no access"}},"description":"Section Clients"},"dashboard":{"type":"object","properties":{"dashboard_access":{"type":"boolean","description":"true - there is access to the overview section, false - no access"},"dash_access":{"type":"boolean","description":"true - there is access to the summary section, false - no access"},"dash_phones_access":{"type":"boolean","description":"true - there is access to display phone numbers in the summary, false - no access"},"dash_records_access":{"type":"boolean","description":"true - there is access to view the list of records, false - no access"},"dash_records_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - access to view the list of records for all time, >= 0 - access to view the list of records for the specified number of days in the past"},"children":[]}]}]}]},"dash_records_excel_access":{"type":"boolean","description":"true - there is access to unload the list of records in Excel, false - no access"},"dash_records_phones_access":{"type":"boolean","description":"true - there is access to display phone numbers in appointments, false - no access"},"dash_message_access":{"type":"boolean","description":"true - there is access to view message details, false - no access"},"dash_message_excel_access":{"type":"boolean","description":"true - there is access to unload message details in Excel, false - no access"},"dash_message_phones_access":{"type":"boolean","description":"true - there is access to show phone numbers in messages, false - no access"},"dash_reviews_access":{"type":"boolean","description":"true - there is access to view reviews, false - no access"},"dash_reviews_delete_access":{"type":"boolean","description":"true - there is access to delete reviews, false - no access"},"dashboard_calls_access":{"type":"boolean","description":"true - there is access to the calls section, false - no access"},"dashboard_calls_excel_access":{"type":"boolean","description":"true - there is access to unloading Excel calls, false - no access"},"dashboard_calls_phones_access":{"type":"boolean","description":"true - clients have access to view the phone number, false - no access"},"security_access":{"type":"boolean","description":"true - there is access to security settings, false - no access"},"security_2fa_access":{"type":"boolean","description":"true - there is access to 2FA security settings, false - no access"},"security_data_changes_access":{"type":"boolean","description":"true - there is access to view data changes in security log, false - no access"},"security_employee_changes_access":{"type":"boolean","description":"true - there is access to view employee changes in security log, false - no access"},"security_export_import_access":{"type":"boolean","description":"true - there is access to export/import security logs, false - no access"},"security_logins_access":{"type":"boolean","description":"true - there is access to view login history in security log, false - no access"}},"description":"Section Overview"},"notification":{"type":"object","properties":{"notification":{"type":"boolean","description":"true - access to Notifications, false - no access"},"web_push":{"type":"boolean","description":"true - there is access to show Push notifications about posts in the Web version, false - no access"},"web_phone_push":{"type":"boolean","description":"true - there is access to show Push notifications about calls in the Web version, false - no access"},"notification_sms_ending_license":{"type":"boolean","description":"true - there is access to send SMS notifications about imminent license expiration, false - no access"},"notification_sms_low_balance":{"type":"boolean","description":"true - there is access to send SMS notifications about low balance, false - no access"},"notification_email_ending_license":{"type":"boolean","description":"true - there is access to send Email notifications about imminent license expiration, false - no access"}},"description":"Notification settings"},"loyalty":{"type":"object","properties":{"loyalty_access":{"type":"boolean","description":"true - there is access to loyalty, false - no access"},"has_loyalty_access":{"type":"boolean","description":"true - there is access to loyalty, false - no access"},"loyalty_cards_manual_transactions_access":{"type":"boolean","description":"true - there is access to manual replenishment/withdrawal from loyalty cards, false - no access"},"has_loyalty_cards_manual_transactions_access":{"type":"boolean","description":"true - there is access to manual replenishment/withdrawal from loyalty cards, false - no access"},"loyalty_certificate_and_abonement_manual_transactions_access":{"type":"boolean","description":"true - there is access to payment with a certificate and a membership without a code, false - no access"},"loyalty_abonement_balance_edit_access":{"type":"boolean","description":"true - there is access to edit membership balance, false - no access"},"loyalty_abonement_history_access":{"type":"boolean","description":"true - there is access to membership history, false - no access"},"loyalty_abonement_period_edit_access":{"type":"boolean","description":"true - there is access to edit membership period, false - no access"},"loyalty_cards_issue_and_removal_access":{"type":"boolean","description":"true - there is access to issue and remove loyalty cards, false - no access"},"loyalty_certificate_balance_edit_access":{"type":"boolean","description":"true - there is access to edit gift card balance, false - no access"},"loyalty_certificate_period_edit_access":{"type":"boolean","description":"true - there is access to edit gift card period, false - no access"}},"description":"Section Loyalty"},"storages":{"type":"object","properties":{"storages_access":{"type":"boolean","description":"true - there is access to the inventory, false - no access"},"storages_ids":{"type":"array","description":"true - there is access to the selected warehouses, false - no access","items":{"type":"object"}},"storages_transactions_access":{"type":"boolean","description":"true - there is access to view product movements, false - no access"},"storages_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - access to view product movements for all time, >= 0 - access to view product movements for the specified number of days in the past"},"children":[]}]}]}]},"storages_move_goods_access":{"type":"boolean","description":"true - there is access to moving products between warehouses, false - no access"},"storages_create_transactions_access":{"type":"boolean","description":"true - there is access to create commodity transactions, false - no access"},"storages_create_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - there is access to the creation of commodity transactions for the entire time, >= 0 - access to the creation of commodity transactions for the specified number of days in the past"},"children":[]}]}]}]},"storages_create_transactions_buy_access":{"type":"boolean","description":"true - there is access to registering the arrival of products, false - no access"},"storages_create_transactions_sale_access":{"type":"boolean","description":"true - there is access to registration of sales of products, false - no access"},"storages_edit_transactions_access":{"type":"boolean","description":"true - there is access to editing commodity transactions, false - no access"},"storages_edit_last_days_count":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-1 - there is access to editing commodity transactions for the whole time, >= 0 - access to editing commodity transactions for the specified number of days in the past"},"children":[]}]}]}]},"storages_edit_transactions_buy_access":{"type":"boolean","description":"true - there is access to registering the arrival of products, false - no access"},"storages_edit_transactions_sale_access":{"type":"boolean","description":"true - there is access to registration of sales of products, false - no access"},"storages_delete_transactions_access":{"type":"boolean","description":"true - there is access to deleting commodity transactions, false - no access"},"storages_transactions_excel_access":{"type":"boolean","description":"true - there is access to unloading product movements in Excel, false - no access"},"storages_transactions_types":{"type":"array","description":"true - there is access to unloading product movements in Excel, false - no access","items":{"type":"object"}},"storages_inventory_access":{"type":"boolean","description":"true - there is access to the inventory, false - no access"},"storages_inventory_create_edit_access":{"type":"boolean","description":"true - there is access to create and edit inventory, false - no access"},"storages_inventory_delete_access":{"type":"boolean","description":"true - there is access to deleting inventory, false - no access"},"storages_inventory_excel_access":{"type":"boolean","description":"true - there is access to unloading inventory in Excel, false - no access"},"storages_remnants_report_access":{"type":"boolean","description":"true - there is access to the stock balance report, false - no access"},"storages_remnants_report_excel_access":{"type":"boolean","description":"true - there is access to unloading balances in Excel, false - no access"},"storages_sales_report_access":{"type":"boolean","description":"true - there is access to the sales report, false - no access"},"storages_sales_report_excel_access":{"type":"boolean","description":"true - there is access to download sales report in Excel, false - no access"},"storages_consumable_report_access":{"type":"boolean","description":"true - there is access to the consumable write-off report, false - no access"},"storages_consumable_report_excel_access":{"type":"boolean","description":"true - there is access to downloading a report on writing off consumables in Excel, false - no access"},"storages_write_off_report_access":{"type":"boolean","description":"true - there is access to the write-off report, false - no access"},"storages_write_off_report_excel_access":{"type":"boolean","description":"true - there is access to unloading a report on the write-off of products in Excel, false - no access"},"storages_turnover_report_access":{"type":"boolean","description":"true - there is access to the turnover report, false - no access"},"storages_turnover_report_excel_access":{"type":"boolean","description":"true - there is access to download the turnover report in Excel, false - no access"},"storages_goods_crud_access":{"type":"boolean","description":"true - there is access to product management, false - no access"},"storages_goods_create_access":{"type":"boolean","description":"true - there is access to create products, false - no access"},"storages_goods_update_access":{"type":"boolean","description":"true - there is access to change products, false - no access"},"storages_goods_title_edit_access":{"type":"boolean","description":"true - there is access to the name, Article, Barcode, false - no access"},"storages_goods_category_edit_access":{"type":"boolean","description":"true - there is access to categories, false - no access"},"storages_goods_selling_price_edit_access":{"type":"boolean","description":"true - there is access to sell prices, false - no access"},"storages_goods_cost_price_edit_access":{"type":"boolean","description":"true - there is access to the cost, false - no access"},"storages_goods_units_edit_access":{"type":"boolean","description":"true - there is access to units of measurement, false - no access"},"storages_goods_critical_balance_edit_access":{"type":"boolean","description":"true - there is access to critical balances, Desired balance, false - no access"},"storages_goods_masses_edit_access":{"type":"boolean","description":"true - there is access to the mass, false - no access"},"storages_goods_comment_edit_access":{"type":"boolean","description":"true - there is access to comments, false - no access"},"storages_goods_archive_access":{"type":"boolean","description":"true - there is access to archiving and restoring products, false - no access"},"storages_goods_delete_access":{"type":"boolean","description":"true - there is access to delete products, false - no access"},"storages_limited_access":{"type":"boolean","description":"true - there is limited access to inventory, false - no access"},"storages_goods_prime_cost_view_access":{"type":"boolean","description":"true - there is access to view product prime cost, false - no access"}},"description":"Section Inventory"},"settings":{"type":"object","properties":{"settings_access":{"type":"boolean","description":"true - there is access to the settings section, false - no access"},"settings_basis_access":{"type":"boolean","description":"true - there is access to the General section, false - no access"},"settings_information_access":{"type":"boolean","description":"true - there is access to the Information section, false - no access"},"users_access":{"type":"boolean","description":"true - there is access to user management, false - no access"},"delete_users_access":{"type":"boolean","description":"true - there is access to delete users, false - no access"},"create_users_access":{"type":"boolean","description":"true - there is access to adding users, false - no access"},"edit_users_access":{"type":"boolean","description":"true - there is access to user rights management, false - no access"},"limited_users_access":{"type":"boolean","description":"true - there is access to rights management within its own set of rights, false - no access"},"settings_services_access":{"type":"boolean","description":"true - there is access to the Services section, false - no access"},"settings_services_create_access":{"type":"boolean","description":"true - there is access to create services, false - no access"},"services_edit":{"type":"boolean","description":"true - there is access to editing services, false - no access"},"settings_services_edit_title_access":{"type":"boolean","description":"true - there is access to service names and a name for online booking, false - no access"},"settings_services_relation_category_access":{"type":"boolean","description":"true - there is access to service categories, false - no access"},"settings_services_edit_price_access":{"type":"boolean","description":"true - there is access to service prices, false - no access"},"settings_services_edit_image_access":{"type":"boolean","description":"true - there is access to image uploads and changes, false - no access"},"settings_services_edit_online_seance_date_time_access":{"type":"boolean","description":"true - there is access to displaying services in the widget, false - no access"},"settings_services_edit_online_pay_access":{"type":"boolean","description":"true - there is access to online payment for the service, false - no access"},"settings_services_edit_services_related_resource_access":{"type":"boolean","description":"true - there is access to the service resources, false - no access"},"settings_positions_read":{"type":"boolean","description":"true - there is access to the position section, false - no access"},"settings_positions_create":{"type":"boolean","description":"true - there is access to create posts, false - no access"},"settings_positions_delete":{"type":"boolean","description":"true - there is access to delete posts, false - no access"},"edit_master_service_and_duration":{"type":"boolean","description":"true - there is access to change team member services and their duration, false - no access"},"tech_card_edit":{"type":"boolean","description":"true - there is access to change the technological map, false - no access"},"services_delete":{"type":"boolean","description":"true - there is access to delete services, false - no access"},"settings_master_access":{"type":"boolean","description":"true - there is access to the team members section, false - no access"},"master_create":{"type":"boolean","description":"true - there is access to create team members, false - no access"},"master_edit":{"type":"boolean","description":"true - there is access to edit team members, false - no access"},"master_delete":{"type":"boolean","description":"true - there is access to delete team members, false - no access"},"settings_master_dismiss_access":{"type":"boolean","description":"true - there is access to dismiss team members, false - no access"},"schedule_edit":{"type":"boolean","description":"true - there is access to editing the work schedule, false - no access"},"settings_notifications_access":{"type":"boolean","description":"true - there is access to the Sms notification section, false - no access"},"settings_email_notifications_access":{"type":"boolean","description":"true - there is access to the Email notification section, false - no access"},"settings_template_notifications_access":{"type":"boolean","description":"true - there is access to the Notification types section, false - no access"},"webhook_read_access":{"type":"boolean","description":"true - there is access to change WebHook settings, false - no access"},"settings_clients_labels_access":{"type":"boolean","description":"true - there is access to client tags/labels settings, false - no access"},"settings_close_docs_access":{"type":"boolean","description":"true - there is access to close documents, false - no access"},"settings_user_notifications_access":{"type":"boolean","description":"true - there is access to user notifications settings, false - no access"},"is_salon_tips_manager":{"type":"boolean","description":"true - user is a tips manager, false - not a tips manager"}},"description":"Section Settings"},"security":{"type":"object","properties":{"security_access":{"type":"boolean","description":"true - there is access to security settings, false - no access"},"security_2fa_access":{"type":"boolean","description":"true - there is access to 2FA security settings, false - no access"},"security_data_changes_access":{"type":"boolean","description":"true - there is access to view data changes in security log, false - no access"},"security_employee_changes_access":{"type":"boolean","description":"true - there is access to view employee changes in security log, false - no access"},"security_export_import_access":{"type":"boolean","description":"true - there is access to export/import security logs, false - no access"},"security_logins_access":{"type":"boolean","description":"true - there is access to view login history in security log, false - no access"}},"description":"Section Security"},"comers":{"type":"object","properties":{"comers_access":{"type":"boolean","description":"true - there is access to visitors section, false - no access"},"comers_info_vehicle_view_access":{"type":"boolean","description":"true - there is access to view vehicle information for visitors, false - no access"},"comers_info_vehicle_edit_access":{"type":"boolean","description":"true - there is access to edit vehicle information for visitors, false - no access"}},"description":"Section Visitors"},"other":{"type":"object","properties":{"stat_access":{"type":"boolean","description":"true - there is access to analytics, false - no access"},"analytics_constructor_access":{"type":"boolean","description":"true - there is access to analytics constructor, false - no access"},"billing_access":{"type":"boolean","description":"true - there is access to billing (balance menu section), false - no access"},"billing_invoices_access":{"type":"boolean","description":"true - there is access to billing invoices, false - no access"},"send_sms":{"type":"boolean","description":"true - there is access to SMS distribution to clients, false - no access"},"auth_enable_check_ip":{"type":"boolean","description":"true - there is access to the location only from IP addresses (v4, v6), false - no access"},"auth_list_allowed_ip":{"type":"array","description":"list of IP addresses","items":{"type":"object"}},"salon_to_salon_group_add_access":{"type":"boolean","description":"true - there is access to add locations to location groups, false - no access"},"is_salon_tips_manager":{"type":"boolean","description":"true - user is a tips manager, false - not a tips manager"}},"description":"Access to analytics, billing, SMS mailings and enabling access to a location by IP address"},"reports":{"type":"object","properties":{"reports_access":{"type":"boolean","description":"true - there is access to the Reports section, false - no access"},"reports_basic_metrics_access":{"type":"boolean","description":"true - there is access to basic metrics reports (overview, day and period reports), false - no access"},"reports_admins_access":{"type":"boolean","description":"true - there is access to administrators statistics reports, false - no access"}},"description":"Section Reports"},"online_record":{"type":"object","properties":{"online_record_access":{"type":"boolean","description":"true - there is access to online booking, false - no access"},"online_record_privacy_policy_access":{"type":"boolean","description":"true - there is access to privacy policy settings for online booking, false - no access"}},"description":"Section Online Booking"},"security_access":{"type":"boolean","description":"true - there is access to security settings, false - no access"},"security_2fa_access":{"type":"boolean","description":"true - there is access to 2FA security settings, false - no access"},"security_data_changes_access":{"type":"boolean","description":"true - there is access to view data changes in security log, false - no access"},"security_employee_changes_access":{"type":"boolean","description":"true - there is access to view employee changes in security log, false - no access"},"security_export_import_access":{"type":"boolean","description":"true - there is access to export/import security logs, false - no access"},"security_logins_access":{"type":"boolean","description":"true - there is access to view login history in security log, false - no access"}},"description":"Object with access rights categories"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of rights","example":{"success":true,"data":{"timetable":{"timetable_access":true,"master_id":1000238,"position_id":0,"last_days_count":1000,"schedule_edit_access":true,"timetable_phones_access":true,"timetable_transferring_record_access":true,"timetable_statistics_access":true,"timetable_waiting_list_access":false},"record_form":{"record_form_access":true,"record_form_client_access":true,"records_autocomplete_access":true,"create_records_access":true,"edit_records_access":true,"edit_records_attendance_access":true,"records_services_cost_access":true,"records_services_discount_access":true,"record_edit_full_paid_access":true,"delete_records_access":true,"delete_customer_came_records_access":true,"delete_paid_records_access":true,"records_goods_access":true,"records_goods_create_transaction_access":true,"records_goods_create_last_days_count":-1,"records_goods_edit_transaction_access":true,"records_goods_edit_last_days_count":-1,"records_goods_cost_access":true,"records_goods_discount_access":true,"records_finances_access":true,"records_finances_last_days_count":-1,"records_finances_pay_from_deposits_access":true,"records_group_id_access":true,"records_group_id":134178,"record_form_client_add_access":true,"records_autocomplete_phone_access":true,"assistants_management_access":true,"assistants_reward_share_edit_access":true,"records_edit_last_days_count":-1,"records_edit_date_and_master_access":true,"records_edit_duration_access":true,"records_edit_comment_access":true,"records_edit_services_access":true,"records_consumables_edit_access":true,"record_edit_full_paid_client_came_access":true,"record_edit_full_paid_client_confirm_access":true,"custom_fields_client_values_read_access":true,"custom_fields_client_values_edit_access":true,"custom_fields_record_values_read_access":true,"custom_fields_record_values_edit_access":true},"finances":{"finances_access":true,"finances_accounts_ids":[],"finances_transactions_access":true,"finances_last_days_count":-1,"finances_create_transactions_access":true,"finances_create_last_days_count":-1,"finances_edit_transactions_access":true,"finances_edit_last_days_count":-1,"finances_delete_transactions_access":true,"finances_transactions_excel_access":true,"finances_expenses_ids":[],"finances_accounts_access":true,"finances_accounts_limited_access":false,"finances_accounts_banalce_access":true,"finances_suppliers_read_access":true,"finances_suppliers_create_access":true,"finances_suppliers_update_access":true,"finances_suppliers_delete_access":true,"finances_suppliers_excel_access":true,"finances_expenses_read_access":true,"expenses_read_access":true,"finances_expenses_create_access":true,"expenses_create_access":true,"finances_expenses_update_access":true,"expenses_update_access":true,"finances_expenses_delete_access":true,"expenses_delete_access":true,"finances_kkm_transactions_access":true,"kkm_transactions_accounts_access":true,"finances_kkm_settings_read_access":true,"kkm_settings_reed_access":true,"finances_kkm_settings_update_access":true,"kkm_settings_update_access":true,"finances_settings_invoicing_read_access":true,"settings_invoicing_read_access":true,"finances_settings_invoicing_update_access":true,"settings_invoicing_update_access":true,"finances_options_read_access":true,"options_read_access":true,"finances_options_update_access":true,"options_update_access":true,"finances_salary_schemes_access":true,"finances_salary_calc_access":true,"finances_salary_not_limitation_today_access":true,"finances_payroll_calculation_create_access":true,"finances_payroll_calculation_create_not_limitation_today_access":true,"finances_salary_access_master_checkbox":true,"finances_salary_access_master_id":1000237,"get_salary_access_master_id":1000237,"finances_salary_master_not_limitation_today_access":true,"finances_payroll_calculation_create_by_master_access":true,"calculation_create_by_master_not_limitation_today_access":true,"finances_period_report_access":true,"finances_period_report_excel_access":true,"finances_year_report_access":true,"finances_year_report_excel_access":true,"finances_print_check_access":true,"finances_z_report_access":true,"finances_z_report_no_limit_today_access":true,"finances_z_report_excel_access":true},"clients":{"clients_access":true,"client_phones_access":true,"clients_phones_email_access":true,"clients_card_phone_access":true,"clients_delete_access":true,"clients_excel_access":true,"excel_access":true,"client_comments_list_access":true,"client_comments_add_access":true,"client_comments_own_edit_access":true,"client_comments_other_edit_access":true,"client_files_list_access":true,"client_files_upload_access":true,"client_files_delete_access":true,"clients_visit_master_id":0,"get_visit_master_id":0,"clients_phones_access":true,"clients_edit_access":true,"clients_deposits_access":true,"clients_deposits_create_access":true,"clients_deposits_history_access":true,"clients_deposits_topup_access":true,"clients_loyalty_read_access":true,"clients_loyalty_settings_access":true,"clients_card_comment_access":true,"clients_card_comment_edit_access":true,"clients_surname_middle_name_access":true,"clients_surname_middle_name_edit_access":true,"clients_show_attendance_history_access":true},"dashboard":{"dashboard_access":true,"dash_access":true,"dash_phones_access":true,"dash_records_access":true,"dash_records_last_days_count":-1,"dash_records_excel_access":true,"dash_records_phones_access":true,"dash_message_access":true,"dash_message_excel_access":true,"dash_message_phones_access":true,"dash_reviews_access":true,"dash_reviews_delete_access":true,"dashboard_calls_access":true,"dashboard_calls_excel_access":true,"dashboard_calls_phones_access":true},"notification":{"notification":true,"web_push":true,"web_phone_push":true,"notification_sms_ending_license":true,"notification_sms_low_balance":true,"notification_email_ending_license":true},"loyalty":{"loyalty_access":true,"has_loyalty_access":true,"loyalty_cards_manual_transactions_access":true,"has_loyalty_cards_manual_transactions_access":true,"loyalty_certificate_and_abonement_manual_transactions_access":true,"loyalty_abonement_balance_edit_access":true,"loyalty_abonement_history_access":true,"loyalty_abonement_period_edit_access":true,"loyalty_cards_issue_and_removal_access":true,"loyalty_certificate_balance_edit_access":true,"loyalty_certificate_period_edit_access":true},"storages":{"storages_access":true,"storages_ids":[],"storages_transactions_access":true,"storages_last_days_count":-1,"storages_move_goods_access":true,"storages_create_transactions_access":true,"storages_create_last_days_count":-1,"storages_create_transactions_buy_access":true,"storages_create_transactions_sale_access":true,"storages_edit_transactions_access":true,"storages_edit_last_days_count":-1,"storages_edit_transactions_buy_access":true,"storages_edit_transactions_sale_access":true,"storages_delete_transactions_access":true,"storages_transactions_excel_access":true,"storages_transactions_types":[],"storages_inventory_access":true,"storages_inventory_create_edit_access":true,"storages_inventory_delete_access":true,"storages_inventory_excel_access":true,"storages_remnants_report_access":true,"storages_remnants_report_excel_access":true,"storages_sales_report_access":true,"storages_sales_report_excel_access":true,"storages_consumable_report_access":true,"storages_consumable_report_excel_access":true,"storages_write_off_report_access":true,"storages_write_off_report_excel_access":true,"storages_turnover_report_access":true,"storages_turnover_report_excel_access":true,"storages_goods_crud_access":true,"storages_goods_create_access":true,"storages_goods_update_access":true,"storages_goods_title_edit_access":true,"storages_goods_category_edit_access":true,"storages_goods_selling_price_edit_access":true,"storages_goods_cost_price_edit_access":true,"storages_goods_units_edit_access":true,"storages_goods_critical_balance_edit_access":true,"storages_goods_masses_edit_access":true,"storages_goods_comment_edit_access":true,"storages_goods_archive_access":true,"storages_goods_delete_access":true,"storages_limited_access":false,"storages_goods_prime_cost_view_access":true},"settings":{"settings_access":true,"settings_basis_access":true,"settings_information_access":true,"users_access":true,"delete_users_access":true,"create_users_access":true,"edit_users_access":true,"limited_users_access":false,"settings_services_access":true,"settings_services_create_access":true,"services_edit":true,"settings_services_edit_title_access":true,"settings_services_relation_category_access":true,"settings_services_edit_price_access":true,"settings_services_edit_image_access":true,"settings_services_edit_online_seance_date_time_access":true,"settings_services_edit_online_pay_access":true,"settings_services_edit_services_related_resource_access":true,"settings_positions_read":true,"settings_positions_create":true,"settings_positions_delete":true,"edit_master_service_and_duration":true,"tech_card_edit":true,"services_delete":true,"settings_master_access":true,"master_create":true,"master_edit":true,"master_delete":true,"settings_master_dismiss_access":true,"schedule_edit":true,"settings_notifications_access":true,"settings_email_notifications_access":true,"settings_template_notifications_access":true,"webhook_read_access":true,"settings_clients_labels_access":true,"settings_close_docs_access":true,"settings_user_notifications_access":true,"is_salon_tips_manager":false},"comers":{"comers_access":false,"comers_info_vehicle_view_access":false,"comers_info_vehicle_edit_access":false},"other":{"stat_access":true,"billing_access":true,"send_sms":true,"salon_to_salon_group_add_access":true,"analytics_constructor_access":true,"billing_invoices_access":true,"auth_enable_check_ip":false,"auth_list_allowed_ip":[]},"reports":{"reports_access":true,"reports_basic_metrics_access":true,"reports_admins_access":true},"online_record":{"online_record_access":true,"online_record_privacy_policy_access":true},"security_access":false,"security_2fa_access":false,"security_data_changes_access":false,"security_employee_changes_access":false,"security_export_import_access":false,"security_logins_access":false},"meta":[]}}},"components/schemas/user_permission_type":{"id":"components/schemas/user_permission_type","kind":"json-schema","title":"Model object \"Permission type\"","data":{"title":"Model object \"Permission type\"","description":"Data on the permission type","type":"object","properties":{"slug":{"type":"string","description":"Name of the type","enum":["has_access","has_group_access","has_limited_access","has_allowed_ids","has_limited_today","has_limited_by_own_access","last_days_count","allowed_ids","allowed_id","allowed_ip"]},"all_access_value":{"type":["string","null"],"description":"A value that grants full access for this type of permission (can be number, string, or boolean)"},"no_access_value":{"type":["string","null"],"description":"A value that completely takes away access for this type of permission (can be number, string, or boolean)"}},"example":{"slug":"has_group_access","all_access_value":true,"no_access_value":false}}},"components/schemas/user_permission_option":{"id":"components/schemas/user_permission_option","kind":"json-schema","title":"Model object \"Permission option\"","data":{"title":"Model object \"Permission option\"","description":"Data on the permission option","type":"object","properties":{"title":{"type":"string","description":"Title of the option"},"value":{"type":"number","description":"Value of the option"},"is_disabled":{"type":"boolean","description":"Availability of the option for use"}},"example":{"title":"All positions","value":0,"is_disabled":false}}},"components/schemas/user_permission_with_children":{"id":"components/schemas/user_permission_with_children","kind":"json-schema","title":"Model object \"Permission with nested permissions\"","data":{"title":"Model object \"Permission with nested permissions\"","description":"Data on the permission with nested permissions","type":"object","properties":{"slug":{"type":"string","description":"Name of the permission"},"title":{"type":"string","description":"Title of the permission"},"type":{"type":"object","description":"Data about the type of permission","allOf":[{"$ref":"#/components/schemas/user_permission_type"}]},"options":{"type":["array","null"],"description":"Options list of the permission","items":{"$ref":"#/components/schemas/user_permission_option"}},"hint":{"type":"string","description":"Text hint on the use of the permission"},"is_recommended":{"type":"boolean","description":"Is the permission recommended or optional"},"is_editable":{"type":"boolean","description":"Is the permission available for editing"},"default_value":{"type":["string","null"],"description":"Value of the permission by default (can be number, string, or boolean)"},"entity_name":{"type":["string","null"],"description":"The name of the entity to which this permission belongs"},"is_paid":{"type":"boolean","description":"Whether the permission is only available for paid staff members"},"is_paid_only":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the permission can only be assigned to paid staff members. Only applicable when the location has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_paid_rights_model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" enabled"},"children":[]}]}]}]},"children":{"type":["array","null"],"description":"Nested permissions (recursive structure, same schema as parent)","items":{"type":"object","description":"Nested permission object (same structure as UserPermissionWithChildren)"}}},"example":{"slug":"timetable_access","title":"Appointment calendar","hint":"","is_recommended":true,"is_editable":true,"is_paid":false,"is_paid_only":false,"default_value":true,"entity_name":null,"children":[{"slug":"timetable_position_id","title":"View the schedule and post records","hint":"","is_recommended":true,"is_editable":true,"default_value":null,"entity_name":"position","children":null,"options":[{"title":"All positions","value":0,"is_disabled":false},{"title":"Administrator","value":1234,"is_disabled":false}],"type":{"slug":"allowed_id","all_access_value":"0","no_access_value":"0"}}],"options":null,"type":{"slug":"has_group_access","all_access_value":true,"no_access_value":false}}}},"components/schemas/user_role_with_salon_and_user":{"id":"components/schemas/user_role_with_salon_and_user","kind":"json-schema","title":"Model object \"User role\"","data":{"title":"Model object \"User role\"","description":"Data on the user role","type":"object","properties":{"slug":{"type":"string","description":"Name of the role","enum":["worker","administrator","accountant","manager","owner","free_readonly","free_readonly_admin"]},"title":{"type":"string","description":"Title of the role"},"description":{"type":"string","description":"Description of the role"},"weight":{"type":"number","description":"Role weight which determines the number of available permissions"},"user_permissions":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of permissions for this role"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned in response only if corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present in request."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/user_permission_with_children"}}},"example":{"slug":"staff_member","title":"team member","description":"Provides services","weight":1,"user_permissions":[{"slug":"timetable_access","title":"Appointment calendar","hint":"","is_recommended":true,"is_editable":true,"default_value":true,"entity_name":null,"children":[{"slug":"timetable_position_id","title":"View the schedule and post records","hint":"","is_recommended":true,"is_editable":true,"default_value":null,"entity_name":"position","children":null,"options":[{"title":"All positions","value":0,"is_disabled":false},{"title":"Administrator","value":1234,"is_disabled":false}],"type":{"slug":"allowed_id","all_access_value":"0","no_access_value":"0"}}],"options":null,"type":{"slug":"has_group_access","all_access_value":true,"no_access_value":false}}]}}},"components/schemas/user_permission_value":{"id":"components/schemas/user_permission_value","kind":"json-schema","title":"Model object \"Permission value\"","data":{"title":"Model object \"Permission value\"","description":"Data on the permission value","type":"object","properties":{"slug":{"type":"string","description":"Name of permission"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array"},{"type":"null"}],"description":"Value of permission (can be number, string, boolean, or array)"}},"example":{"slug":"timetable_access","value":true}}},"components/schemas/user_role_permissions":{"id":"components/schemas/user_role_permissions","kind":"json-schema","title":"Model object \"Permissions and user role\"","data":{"title":"Model object \"Permissions and user role\"","description":"Data on the permissions and user role","type":"object","properties":{"user_role":{"type":"string","description":"Name of role","enum":["worker","administrator","accountant","manager","owner","free_readonly","free_readonly_admin"]},"staff_id":{"type":["number","null"],"description":"team member ID linked to user"},"is_editable":{"type":"boolean","description":"Are the permissions and role available for editing"},"has_any_paid_permission":{"type":["boolean","null"],"description":"Whether the user has at least one paid permission assigned"},"user_permissions":{"type":"array","description":"List of user permissions values","items":{"$ref":"#/components/schemas/user_permission_value"}}},"example":{"is_editable":true,"staff_id":12345,"user_role":"owner","has_any_paid_permission":null,"user_permissions":[{"slug":"timetable_access","value":true},{"slug":"timetable_position_id","value":0},{"slug":"auth_list_allowed_ip","value":""}]}}},"components/schemas/user_invite_response_data_types":{"id":"components/schemas/user_invite_response_data_types","kind":"json-schema","title":"Root Type for user_invite_response_data_types","data":{"title":"Root Type for user_invite_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Send success status (true)"},"data":{"type":"string","description":"Is null"},"meta":{"type":"object","properties":{"message":{"type":"string"}},"description":"Metadata (contains a message that the data has been saved)"}},"description":"Create and Send an Invitation","example":{"success":true,"meta":{"message":"Saved"}}}},"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/records_companyid_response_data-types":{"id":"components/schemas/records_companyid_response_data-types","kind":"json-schema","title":"Root Type for records_companyid_response_data-types","data":{"title":"Root Type for records_companyid_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":"Appointment ID"},"company_id":{"type":"number","description":"location ID"},"staff_id":{"type":"number","description":"team member ID"},"services":{"type":"array","description":"Array of objects with services in the appointment","items":{"type":"object","properties":{"id":{"type":"number","description":"Service ID"},"title":{"type":"string","description":"Service name"},"cost":{"type":"number","description":"The total cost of the service","format":"float"},"cost_to_pay":{"type":"number","description":"Amount to pay (cost minus discounts/deposits)","format":"float"},"manual_cost":{"type":"number","description":"Manual price","format":"float"},"cost_per_unit":{"type":"number","description":"Unit cost","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"first_cost":{"type":"number","description":"Initial cost of the service (excluding discounts)","format":"float"},"amount":{"type":"number","description":"Quantity"},"assistants":{"type":["array","null"],"description":"Array of assistant team members for this service","items":{"type":"object"}}}}},"goods_transactions":{"type":"array","description":"Array of commodity transactions","items":{"type":"object"}},"staff":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"api_id":{"type":["string","null"],"description":"team member External ID"},"name":{"type":"string","description":"team member name"},"specialization":{"type":"string","description":"team member specialization"},"position":{"type":["object","array"],"properties":{"id":{"type":"number","description":"Job ID"},"title":{"type":"string","description":"Job title"},"services_binding_type":{"type":"number","description":"Services binding type"}},"description":"team member's position"},"avatar":{"type":"string","description":"The path to the file with the team member's avatar"},"avatar_big":{"type":"string","description":"Let to the file with the team member's profile picture in high resolution"},"rating":{"type":"number","description":"team member Rating"},"votes_count":{"type":"number","description":"Number of votes that rated the team member"}},"description":"team member data object"},"client":{"type":["object","null"],"description":"Customer data (may be empty)","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client first name"},"surname":{"type":"string","description":"Client surname"},"middle_name":{"type":"string","description":"Client middle name"},"patronymic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client middle name (legacy field name; same value as middle_name)"},"children":[]}]}]}]},"display_name":{"type":"string","description":"Client display name"},"comment":{"type":"string","description":"Client comment"},"phone":{"type":"string","description":"Client phone number"},"card":{"type":"string","description":"Client card number"},"email":{"type":"string","description":"Client email"},"success_visits_count":{"type":"number","description":"Number of successful visits"},"fail_visits_count":{"type":"number","description":"Number of failed visits"},"discount":{"type":"number","description":"Client discount"},"is_new":{"type":"boolean","description":"Is new client flag"},"custom_fields":{"type":["object","array"],"description":"Client custom fields (object keyed by field code, or empty array when none)","items":{"type":"object"}},"gender":{"type":"number","description":"Client gender (0 - not specified, 1 - male, 2 - female)"},"sex":{"type":"number","description":"Client sex (alias for gender: 0 - not specified, 1 - male, 2 - female)"},"birthday":{"type":"string","description":"Client birthday"},"client_tags":{"type":"array","description":"Client tags","items":{"type":"object"}},"phone_country_id":{"type":"number","description":"Phone country ID"}}},"date":{"type":"string","description":"Session date","format":"date-time"},"datetime":{"type":"string","description":"Session date in ISO","format":"date-time"},"create_date":{"type":"string","description":"Session creation date","format":"date-time"},"comment":{"type":"string","description":"Appointment Comment"},"online":{"type":"boolean","description":"(Read only) Whether the appointment is online or not (false if the appointment was made by an administrator)"},"visit_attendance":{"type":"number","description":"Visit status, 2 - The user confirmed the appointment, 1 - The user came, the services were provided, 0 - the user is waiting, -1 - the user did not come to the visit"},"attendance":{"type":"number","description":"Appointment status, 2 - User confirmed the appointment, 1 - The user has arrived, services have been rendered, 0 - the user is waiting, -1 - the user has not come to visit"},"confirmed":{"type":"number","description":"Appointment confirmation status, 0 - not confirmed, 1 - confirmed"},"seance_length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Includes technical_break_duration. Equal to the sum of services plus the technical break."},"children":[]}]}]}]},"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Alias of seance_length. Includes technical_break_duration."},"children":[]}]}]}]},"sms_before":{"type":"number","description":"Whether to send an SMS reminder to the client (if the client is specified)"},"sms_now":{"type":"number","description":"Did you send SMS when adding an appointment"},"sms_now_text":{"type":"string","description":"SMS text"},"email_now":{"type":"number","description":"Has an email notification been sent?"},"notified":{"type":"number","description":"Flag for confirmation of the appointment by the location administrator, if the client asked to confirm the appointment"},"master_request":{"type":"number","description":"Indicates whether a specific team member was selected for the appointment. Set to false if the \"any team member\" option was chosen"},"api_id":{"type":"string","description":"External appointment ID"},"from_url":{"type":"string","description":"From which page the transition was made to complete the appointment (website, VK application, etc.)"},"review_requested":{"type":"number","description":"Flag for requesting visit feedback from the client"},"is_remind_sms_sent":{"type":"boolean","description":"Has reminder SMS been sent"},"visit_id":{"type":"number","description":"Visit ID"},"created_user_id":{"type":"number","description":"ID of the user who created the appointment"},"deleted":{"type":"boolean","description":"(Read only) Whether the appointment was deleted (true if deleted)"},"paid_full":{"type":"number","description":"Flag, whether the appointment is paid in full (1 - if paid in full)"},"prepaid":{"type":"boolean","description":"Is online payment available"},"prepaid_confirmed":{"type":"boolean","description":"Online payment status"},"last_change_date":{"type":"string","description":"The date and time when the appointment was last modified","format":"date-time"},"custom_color":{"type":"string","description":"Log appointment color"},"custom_font_color":{"type":"string","description":"(Only when reading) Write font color"},"record_labels":{"type":"array","description":"Post categories","items":{"type":"object"}},"activity_id":{"type":"integer","description":"Group event ID","format":"int32"},"custom_fields":{"type":["object","array"],"description":"Custom fields (object or empty array)"},"documents":{"type":"array","description":"Array of documents","items":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Document Type"},"storage_id":{"type":"number","description":"Inventory ID"},"user_id":{"type":"number","description":"ID of the user who created the document"},"company_id":{"type":"number","description":"location ID"},"number":{"type":"number","description":"Document Number"},"comment":{"type":"string","description":"Document comment"},"date_created":{"type":"string","description":"Document creation date","format":"date-time"},"category_id":{"type":"integer","description":"Product category ID","format":"int32"},"visit_id":{"type":"integer","description":"Visit ID"},"record_id":{"type":"integer","description":"Appointment ID"},"type_title":{"type":"string","description":"The name of the entity to which the document belongs"},"is_sale_bill_printed":{"type":"boolean","description":"Is the sales receipt printed?"}}}},"sms_remain_hours":{"type":["number","null"],"description":"How many hours before the start of the visit to send an SMS with a reminder"},"email_remain_hours":{"type":["number","null"],"description":"How many hours before the start of the visit to send a reminder email"},"bookform_id":{"type":"number","description":"Online Appointment Form ID"},"record_from":{"type":"string","description":"Name of online registration form"},"is_mobile":{"type":"number","description":"Type of device used to register (0 - appointment created by administrator, via web version or mobile app for administrators, 1 - Mobile browser, online appointment widget, 2 - Desktop browser, online appointment widget)"},"is_sale_bill_printed":{"type":"boolean","description":"Is the sales receipt printed?"},"consumables":{"type":"array","description":"Consumable Array","items":{"type":"object"}},"finance_transactions":{"type":"array","description":"Array of financial transactions","items":{"type":"object"}},"acceptance_free":{"type":["boolean","null"],"description":"Acceptance free flag"},"clients_count":{"type":"number","description":"Number of clients in appointment"},"comer":{"type":["boolean","null"],"description":"Comer flag"},"is_update_blocked":{"type":"boolean","description":"Update blocked flag"},"payment_status":{"type":["string","number"],"description":"Payment status"},"resource_instance_ids":{"type":"array","description":"Resource instance IDs","items":{"type":"number"}},"short_link":{"type":"string","description":"Short link to appointment"},"technical_break_duration":{"type":"number","description":"Technical break duration in seconds"}}}},"meta":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"total_count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the page number and the number of appointments per page)"}},"description":"Get list of appointments","example":{"success":true,"data":[{"id":2,"company_id":4564,"staff_id":9,"services":[{"id":1,"title":"Hair extension","cost":100,"manual_cost":100,"cost_per_unit":100,"discount":0,"first_cost":100,"amount":1}],"goods_transactions":[],"staff":{"id":9,"name":"Alex Taylor","specialization":"hair extension","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-01-16T20:35:11-0500","comment":"do not write down","online":false,"visit_attendance":0,"attendance":0,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":0,"api_id":"","from_url":"","review_requested":0,"visit_id":8262996,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-16T20:35:15-0500","custom_color":"","custom_font_color":"","record_labels":[],"activity_id":0,"custom_fields":{},"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"sms_remain_hours":5,"email_remain_hours":1,"bookform_id":0,"record_from":"","is_mobile":0,"is_sale_bill_printed":false,"consumables":[],"finance_transactions":[]},{"id":9,"company_id":4564,"staff_id":49,"services":[],"goods_transactions":[],"staff":{"id":49,"name":"Sam Carter","specialization":"stylist","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-01-16T20:35:11-0500","comment":"","online":true,"visit_attendance":1,"attendance":1,"confirmed":1,"seance_length":10800,"length":10800,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":1,"api_id":"","from_url":"","review_requested":0,"visit_id":8262996,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-09T20:45:30-0500","custom_color":"f44336","custom_font_color":"#ffffff","record_labels":[{"id":67345,"title":"the team member is not important","color":"#009800","icon":"unlock","font_color":"#ffffff"},{"id":104474,"title":"important category","color":"#3b2c54","icon":"star","font_color":"#ffffff"}],"activity_id":0,"custom_fields":{},"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"consumables":[],"finance_transactions":[]}],"meta":{"page":1,"total_count":10}}}},"components/schemas/records_companyid_request_data_types":{"id":"components/schemas/records_companyid_request_data_types","kind":"json-schema","title":"Create or Update Appointment Request","data":{"title":"Create or Update Appointment Request","type":"object","oneOf":[{"title":"Standard Appointment","required":["staff_id","services","client","datetime","seance_length"],"properties":{"activity_id":{"type":"integer","enum":[0]}}},{"title":"Group Event Appointment","required":["activity_id","client"],"properties":{"activity_id":{"type":"integer","minimum":1}}}],"properties":{"activity_id":{"type":"integer","minimum":0,"default":0,"description":"Group Event ID. Required for a Group Event Appointment; omit it or use 0 for a standard Appointment. When updating, the value must match the current Appointment."},"staff_id":{"type":"number","description":"team member ID"},"services":{"type":"array","description":"Service parameters (id, cost, discount)","items":{"type":"object","properties":{"id":{"type":"number","description":"Service ID"},"first_cost":{"type":"number","description":"Initial cost of the service"},"discount":{"type":"number","description":"Service discount"},"cost":{"type":"number","description":"The total cost of the service","format":"float"}}}},"client":{"type":"object","properties":{"phone":{"type":"string","description":"Customer phone number"},"name":{"type":"string","description":"Client name"},"email":{"type":"string","description":"Client Email"}},"description":"Client parameters (phone, name, email)"},"save_if_busy":{"type":"boolean","description":"Whether to keep the appointment if the time is busy or non-working, or give an error"},"datetime":{"type":"string","description":"Date and time of appointment","format":"date-time"},"seance_length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Includes technical_break_duration. To add a technical break without reducing the service time, increase seance_length by the break delta."},"children":[]}]}]}]},"send_sms":{"type":"boolean","description":"Whether to send SMS with the details of the appointment to the client"},"comment":{"type":"string","description":"Appointment Comment"},"sms_remain_hours":{"type":"number","description":"Specifies how many hours before the visit an SMS reminder should be sent to the client. Set to 0 if no reminder is needed."},"email_remain_hours":{"type":"number","description":"Specifies how many hours before the visit an email reminder should be sent to the client. Set to 0 if no reminder is needed."},"attendance":{"type":"number","description":"Appointment status (2 - User confirmed the appointment, 1 - User came, services provided, 0 - user waiting, -1 - user did not show)"},"api_id":{"type":"string","description":"External system ID"},"custom_color":{"type":"string","description":"Appointment color"},"record_labels":{"type":"array","description":"Array of post category IDs","items":{"type":"string"}},"technical_break_duration":{"oneOf":[{"type":"number","minimum":0,"maximum":3600},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break duration in seconds."},"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":"Must be in multiples of 300 (5-minute intervals)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum value is 3600 (1 hour)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or not provided, uses location default from Settings → Appointment Log → Technical Breaks"},"children":[]}]}]}]}]},"custom_fields":{"type":"object","properties":{"my_custom_field":{"type":"integer","format":"int32"},"some_another_field":{"type":"array","items":{"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Appointment Field values keyed by field code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Business User must have both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields_record_values_read_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields_record_values_edit_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When updating an Appointment, supplying"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not make the request partial: resend the required main fields"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the applicable Appointment type."},"children":[]}]}]}]}},"description":"Request body for creating or fully updating an Appointment.","example":{"staff_id":8886,"services":[{"id":331,"first_cost":9000,"discount":50,"cost":4500},{"id":333,"first_cost":2000,"discount":10,"cost":1800}],"client":{"phone":"+13155550175","name":"James Smith","email":"j.smith@example.com"},"save_if_busy":false,"datetime":"2026-09-21T23:00:00.000-05:00","seance_length":3600,"send_sms":true,"comment":"test appointment!","sms_remain_hours":6,"email_remain_hours":24,"attendance":1,"api_id":"777","custom_color":"f44336","record_labels":["67345","104474"],"custom_fields":{"my_custom_field":123,"some_another_field":["first value","second value"]}}}},"components/schemas/record_companyid_response_data_types":{"id":"components/schemas/record_companyid_response_data_types","kind":"json-schema","title":"Root Type for record_companyid_response_data_types","data":{"title":"Root Type for record_companyid_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"id":{"type":"number","description":"Appointment ID"},"company_id":{"type":"number","description":"location ID"},"staff_id":{"type":"number","description":"team member ID"},"services":{"type":"array","description":"Array of objects with services in the appointment","items":{"type":"object","properties":{"id":{"type":"number","description":"Service ID"},"title":{"type":"string","description":"Service name"},"cost":{"type":"number","description":"The total cost of the service","format":"float"},"cost_to_pay":{"type":"number","description":"Amount to pay (cost minus discounts/deposits)","format":"float"},"manual_cost":{"type":"number","description":"Manual price","format":"float"},"cost_per_unit":{"type":"number","description":"Unit cost","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"first_cost":{"type":"number","description":"Initial cost of the service (excluding discounts)","format":"float"},"amount":{"type":"number","description":"Quantity"},"assistants":{"type":["array","null"],"description":"Array of assistant team members for this service","items":{"type":"object"}},"staff_service_link":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team member service link configuration; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not set"},"children":[]}]}]}],"properties":{"length":{"type":"number","description":"Service duration in seconds"}}},"company_service_link":{"type":"object","description":"Location service link configuration","properties":{"price_min":{"type":"number","description":"Minimum price"},"price_max":{"type":"number","description":"Maximum price"}}}}}},"goods_transactions":{"type":"array","description":"Array of commodity transactions","items":{"type":"object"}},"staff":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"api_id":{"type":["string","null"],"description":"team member External ID"},"name":{"type":"string","description":"team member name"},"specialization":{"type":"string","description":"team member specialization"},"position":{"type":["object","array"],"properties":{"id":{"type":"number","description":"Job ID"},"title":{"type":"string","description":"Job title"},"services_binding_type":{"type":"number","description":"Services binding type"}},"description":"team member's position"},"avatar":{"type":"string","description":"The path to the file with the team member's avatar"},"avatar_big":{"type":"string","description":"Let to the file with the team member's profile picture in high resolution"},"rating":{"type":"number","description":"team member Rating"},"votes_count":{"type":"number","description":"Number of votes that rated the team member"}},"description":"team member data object"},"client":{"type":["object","null"],"description":"Customer data (may be empty)","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client first name"},"surname":{"type":"string","description":"Client surname"},"middle_name":{"type":"string","description":"Client middle name"},"patronymic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client middle name (legacy field name; same value as middle_name)"},"children":[]}]}]}]},"display_name":{"type":"string","description":"Client display name"},"comment":{"type":"string","description":"Client comment"},"phone":{"type":"string","description":"Client phone number"},"card":{"type":"string","description":"Client card number"},"email":{"type":"string","description":"Client email"},"success_visits_count":{"type":"number","description":"Number of successful visits"},"fail_visits_count":{"type":"number","description":"Number of failed visits"},"discount":{"type":"number","description":"Client discount"},"is_new":{"type":"boolean","description":"Is new client flag"},"custom_fields":{"type":["object","array"],"description":"Client custom fields (object keyed by field code, or empty array when none)","items":{"type":"object"}},"gender":{"type":"number","description":"Client gender (0 - not specified, 1 - male, 2 - female)"},"sex":{"type":"number","description":"Client sex (alias for gender: 0 - not specified, 1 - male, 2 - female)"},"birthday":{"type":"string","description":"Client birthday"},"client_tags":{"type":"array","description":"Client tags","items":{"type":"object"}},"phone_country_id":{"type":"number","description":"Phone country ID"}}},"date":{"type":"string","description":"Session date","format":"date-time"},"datetime":{"type":"string","description":"Session date in ISO","format":"date-time"},"create_date":{"type":"string","description":"Session creation date","format":"date-time"},"comment":{"type":"string","description":"Appointment Comment"},"online":{"type":"boolean","description":"(Read only) Whether the appointment is online or not (false if the appointment was made by an administrator)"},"visit_attendance":{"type":"number","description":"Visit status, 2 - The user confirmed the appointment, 1 - The user came, the services were provided, 0 - the user is waiting, -1 - the user did not come to the visit"},"attendance":{"type":"number","description":"Appointment status, 2 - User confirmed the appointment, 1 - The user has arrived, services have been rendered, 0 - the user is waiting, -1 - the user has not come to visit"},"confirmed":{"type":"number","description":"Appointment confirmation status, 0 - not confirmed, 1 - confirmed"},"seance_length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Includes technical_break_duration. Equal to the sum of services plus the technical break."},"children":[]}]}]}]},"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Alias of seance_length. Includes technical_break_duration."},"children":[]}]}]}]},"sms_before":{"type":"number","description":"Whether to send an SMS reminder to the client (if the client is specified)"},"sms_now":{"type":"number","description":"Did you send SMS when adding an appointment"},"sms_now_text":{"type":"string","description":"SMS text"},"email_now":{"type":"number","description":"Has an email notification been sent?"},"notified":{"type":"number","description":"Flag for confirmation of the appointment by the location administrator, if the client asked to confirm the appointment"},"master_request":{"type":"number","description":"Indicates whether a specific team member was selected for the appointment. Set to false if the \"any team member\" option was chosen"},"api_id":{"type":"string","description":"External appointment ID"},"from_url":{"type":"string","description":"From which page the transition was made to complete the appointment (website, VK application, etc.)"},"review_requested":{"type":"number","description":"Flag for requesting visit feedback from the client"},"is_remind_sms_sent":{"type":"boolean","description":"Has reminder SMS been sent"},"visit_id":{"type":"number","description":"Visit ID"},"created_user_id":{"type":"number","description":"ID of the user who created the appointment"},"deleted":{"type":"boolean","description":"(Read only) Whether the appointment was deleted (true if deleted)"},"paid_full":{"type":"number","description":"Flag, whether the appointment is paid in full (1 - if paid in full)"},"prepaid":{"type":"boolean","description":"Is online payment available"},"prepaid_confirmed":{"type":"boolean","description":"Online payment status"},"last_change_date":{"type":"string","description":"The date and time when the appointment was last modified","format":"date-time"},"custom_color":{"type":"string","description":"Log appointment color"},"custom_font_color":{"type":"string","description":"(Only when reading) Write font color"},"record_labels":{"type":"array","description":"Array of appointment categories","items":{"type":"object","properties":{"id":{"type":"integer","description":"Category ID"},"title":{"type":"string","description":"name of category"},"color":{"type":"string","description":"Category color"},"icon":{"type":"string","description":"Icon"},"font_color":{"type":"string","description":"Category font color"}}}},"activity_id":{"type":"number","description":"Group event ID"},"custom_fields":{"type":["object","array"],"description":"Custom appointment fields (object or empty array)"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Document Type"},"storage_id":{"type":"number","description":"Inventory ID"},"user_id":{"type":"number","description":"ID of the user who created the document"},"company_id":{"type":"number","description":"location ID"},"number":{"type":"number","description":"Document Number"},"comment":{"type":"string","description":"Document comment"},"date_created":{"type":"string","description":"Document creation date","format":"date-time"},"category_id":{"type":"integer","description":"Product category ID","format":"int32"},"visit_id":{"type":"integer","description":"Visit ID"},"record_id":{"type":"integer","description":"Appointment ID"},"type_title":{"type":"string","description":"The name of the entity to which the document belongs"},"is_sale_bill_printed":{"type":"boolean","description":"Is the sales receipt printed?"}}}},"sms_remain_hours":{"type":["number","null"],"description":"How many hours before the start of the visit to send an SMS with a reminder"},"email_remain_hours":{"type":["number","null"],"description":"How many hours before the start of the visit to send a reminder email"},"bookform_id":{"type":"number","description":"Online Appointment Form ID"},"record_from":{"type":"string","description":"Name of online registration form"},"is_mobile":{"type":"number","description":"Type of device used to register (0 - appointment created by administrator, via web version or mobile app for administrators, 1 - Mobile browser, online appointment widget, 2 - Desktop browser, online appointment widget)"},"is_sale_bill_printed":{"type":"boolean","description":"Is the sales receipt printed?"},"consumables":{"type":"array","description":"Consumable Array","items":{"type":"object","properties":{"id":{"type":"number","description":"Transaction ID"},"document_id":{"type":"integer","description":"Document ID"},"type_id":{"type":"number","description":"Transaction type"},"company_id":{"type":"number","description":"location ID"},"good_id":{"type":"number","description":"Item ID"},"amount":{"type":"number","description":"Quantity of products"},"cost_per_unit":{"type":"number","description":"Unit price","format":"double"},"discount":{"type":"number","description":"Discount"},"cost":{"type":"number","description":"the total cost","format":"double"},"unit_id":{"type":"number","description":"Unit ID"},"operation_unit_type":{"type":"number","description":"Unit type: 1 - for sale, 2 - for write-off"},"storage_id":{"type":"number","description":"Inventory ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"create_date":{"type":"string","description":"Transaction creation date","format":"date-time"},"comment":{"type":"string","description":"A comment"},"service_id":{"type":"number","description":"Service ID"},"user_id":{"type":"number","description":"User ID"},"deleted":{"type":"boolean","description":"Status deleted transaction, 1 - if deleted"},"pkg_amount":{"type":"number","description":"Number of packages"}}}},"finance_transactions":{"type":"array","description":"Array of financial transactions","items":{"type":"object","properties":{"id":{"type":"number","description":"Financial transaction ID"},"document_id":{"type":"number","description":"Document ID"},"date":{"type":"string","description":"date of creation","format":"date-time"},"type_id":{"type":"number","description":"Payment item type"},"expense_id":{"type":"number","description":"Payment Item ID"},"account_id":{"type":"number","description":"Checkout ID"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"comment":{"type":"string","description":"A comment"},"item_id":{"type":"number","description":"Item ID (0 if item is a category)"},"target_type_id":{"type":"integer","format":"int32"},"record_id":{"type":"number","description":"Appointment ID"},"goods_transaction_id":{"type":"number","description":"Commodity transaction ID"},"expense":{"type":"object","properties":{"id":{"type":"number","description":"Payment Item ID"},"title":{"type":"string","description":"Name of payment item"}},"description":"Payment item"},"account":{"type":"object","properties":{"id":{"type":"number","description":"Checkout ID"},"title":{"type":"string","description":"Location account name"}},"description":"Location account"},"client":{"type":"object","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Customer phone"}}},"master":{"type":"array","description":"team members","items":{"type":"object"}},"supplier":{"type":"array","description":"Suppliers","items":{"type":"object"}}}}},"acceptance_free":{"type":["boolean","null"],"description":"Acceptance free flag"},"clients_count":{"type":"number","description":"Number of clients in appointment"},"comer":{"type":["boolean","null"],"description":"Comer flag"},"comer_person_info":{"type":["object","null"],"description":"Comer person information"},"is_update_blocked":{"type":"boolean","description":"Update blocked flag"},"payment_status":{"type":["string","number"],"description":"Payment status"},"resource_instance_ids":{"type":"array","description":"Resource instance IDs","items":{"type":"number"}},"short_link":{"type":"string","description":"Short link to appointment"},"technical_break_duration":{"type":"number","description":"Technical break duration in seconds"}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get an Appointment","example":{"success":true,"data":{"id":2,"company_id":4564,"staff_id":9,"services":[{"id":1,"title":"Hair extension","cost":100,"manual_cost":100,"cost_per_unit":100,"discount":0,"first_cost":100,"amount":1}],"goods_transactions":[],"staff":{"id":9,"name":"Alex Taylor","specialization":"hair extension","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"client":{"id":18936825,"name":"lx","phone":"+13155550175","card":"","email":"client@example.com","success_visits_count":37,"fail_visits_count":3},"clients_count":1,"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-01-17T19:41:44-0500","comment":"do not write down","visit_attendance":0,"attendance":0,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":0,"api_id":"","from_url":"","review_requested":0,"visit_id":8263004,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-17T19:44:14-0500","custom_color":"f44336","custom_font_color":"#ffffff","record_labels":[{"id":67345,"title":"the team member is not important","color":"#009800","icon":"unlock","font_color":"#ffffff"},{"id":104474,"title":"interesting category","color":"#3b2c54","icon":"star","font_color":"#ffffff"}],"activity_id":0,"custom_fields":{},"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":1073232,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"sms_remain_hours":5,"email_remain_hours":1,"bookform_id":0,"record_from":"","is_mobile":0,"is_sale_bill_printed":false,"consumables":[{"id":2173068,"document_id":8174153,"type_id":2,"company_id":4564,"good_id":4853087,"amount":-1,"cost_per_unit":0.03,"discount":0,"cost":0.03,"unit_id":216761,"operation_unit_type":2,"storage_id":91548,"supplier_id":0,"client_id":0,"master_id":0,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"","service_id":1,"user_id":1073232,"deleted":false,"pkg_amount":0}],"finance_transactions":[{"id":6024243,"document_id":8174152,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":90459,"amount":100,"client_id":18936825,"master_id":0,"supplier_id":0,"comment":"","item_id":1,"target_type_id":1,"record_id":2,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":90459,"title":"Main location account"},"client":{"id":18936825,"name":"lx","phone":"+13155550175"},"master":[],"supplier":[]}]},"meta":[]}}},"components/schemas/record_companyid_response201_data_types":{"id":"components/schemas/record_companyid_response201_data_types","kind":"json-schema","title":"Root Type for record_companyid_response201_data_types","data":{"title":"Root Type for record_companyid_response201_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Success status (true)"},"data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Service ID"},"first_cost":{"type":"number","description":"Initial cost of the service (excluding discounts)","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"cost":{"type":"number","description":"The total cost of the service","format":"float"}}}},"client":{"type":"object","properties":{"phone":{"type":"string","description":"Customer phone"},"name":{"type":"string","description":"Client name"},"email":{"type":"string","description":"Client Email"}}},"clients_count":{"type":"number","description":"Number of occupied places in a group appointment"},"staff":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"team member name"},"spec":{"type":"string","description":"team member specialization"}}},"datetime":{"type":"string","description":"Session date","format":"date-time"},"seance_length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Includes technical_break_duration. Equal to the sum of services plus the technical break."},"children":[]}]}]}]},"create_date":{"type":"string","description":"date of creation","format":"date-time"},"comment":{"type":"string","description":"Appointment Comment"},"confirmed":{"type":"number","description":"Is the appointment verified?"},"sms_before":{"type":"number","description":"Whether to send an SMS reminder to the client (if the client is specified)"},"sms_now":{"type":"number","description":"Did you send SMS when adding an appointment"},"sms_now_text":{"type":"string","description":"SMS text"},"email_now":{"type":"number","description":"Has an email notification been sent?"},"notified":{"type":"number","description":"Flag for confirmation of the appointment by the location administrator, if the client asked to confirm the appointment"},"master_request":{"type":"number","description":"Indicates whether a specific team member was selected for the appointment. Set to false if the \"any team member\" option was chosen"},"api_id":{"type":"string","description":"External appointment ID"},"from_url":{"type":"string","description":"From which page the transition was made to complete the appointment (website, VK application, etc.)"},"review_requested":{"type":"number","description":"Flag for requesting visit feedback from the client"},"activity_id":{"type":"number","description":"Group  event ID"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Document type"},"storage_id":{"type":"number","description":"Inventory ID"},"user_id":{"type":"number","description":"ID of the user who created the document"},"company_id":{"type":"number","description":"location ID"},"number":{"type":"number","description":"Document Number"},"comment":{"type":"string","description":"Document comment"},"date_created":{"type":"string","description":"Document creation date","format":"date-time"},"category_id":{"type":"integer","description":"Product category ID","format":"int32"},"visit_id":{"type":"integer","description":"Visit ID"},"record_id":{"type":"integer","description":"Appointment ID"},"type_title":{"type":"string","description":"The name of the entity to which the document belongs"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Edit Appointment","example":{"success":true,"data":{"id":999,"services":[{"id":331,"first_cost":9000,"discount":50,"cost":4500},{"id":333,"first_cost":2000,"discount":10,"cost":1800}],"client":{"phone":"+13155550175","name":"James Smith","email":"j.smith@example.com"},"clients_count":1,"staff":{"id":8886,"name":"Alice Smith","spec":"stylist"},"datetime":"2026-09-21T23:00:00.000-05:00","seance_length":3600,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"test appointment!","visit_attendance":1,"confirmed":1,"sms_before":6,"sms_now":1,"sms_now_text":"","email_now":1,"notified":0,"master_request":1,"api_id":"","from_url":"","review_requested":0,"activity_id":0,"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}]},"meta":[]}}},"components/schemas/400_bad_request_response":{"id":"components/schemas/400_bad_request_response","kind":"json-schema","title":"400_bad_request_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/visits_visitid_data_types":{"id":"components/schemas/visits_visitid_data_types","kind":"json-schema","title":"Root Type for visits_visitid_data_types","data":{"title":"Root Type for visits_visitid_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"attendance":{"type":"number","description":"Visit status"},"datetime":{"type":"string","description":"Date of visit","format":"date-time"},"comment":{"type":"integer","description":"A comment","format":"int32"},"records":{"type":"array","description":"Appointment array","items":{"type":"object","properties":{"id":{"type":"number","description":"Appointment ID"},"company_id":{"type":"number","description":"location ID"},"staff_id":{"type":"number","description":"team member ID"},"services":{"type":"array","description":"Services Array","items":{"type":"object"}},"events":{"type":"array","items":{"type":"object"}},"goods_transactions":{"type":"array","description":"Array of commodity transactions","items":{"type":"object"}},"staff":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"team member name"},"specialization":{"type":"string","description":"team member specialization"},"position":{"type":"object","properties":{"id":{"type":"number","description":"Job ID"},"title":{"type":"string","description":"Job Title"}},"description":"team member's position"},"avatar":{"type":"string","description":"The path to the file with the team member's avatar"},"avatar_big":{"type":"string","description":"Path to a file with a higher resolution team member avatar"},"rating":{"type":"number","description":"Rating","format":"double"},"votes_count":{"type":"number","description":"Number of votes that rated the team member"}},"description":"team member Information"},"client":{"type":"object","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Customer phone number"},"card":{"type":"string","description":"Client card number"},"email":{"type":"string","description":"Client's email address"},"success_visits_count":{"type":"number","description":"Number of customer visits, in the \"Customer arrived\" status"},"fail_visits_count":{"type":"number","description":"Number of canceled customer visits"}},"description":"Client Information"},"date":{"type":"string","description":"Date of visit","format":"date-time"},"datetime":{"type":"string","description":"Date of visit in ISO format","format":"date-time"},"create_date":{"type":"string","description":"Date the visit was created","format":"date-time"},"comment":{"type":"string","description":"Commentary on the visit"},"online":{"type":"boolean","description":"(Read only) Whether the appointment is online or not (false if the appointment was made by an administrator)"},"visit_attendance":{"type":"number","description":"Visit status"},"attendance":{"type":"number","description":"Status of the appointment in the visit"},"confirmed":{"type":"number","description":"Is the appointment verified?"},"seance_length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Includes technical_break_duration. Equal to the sum of services plus the technical break."},"children":[]}]}]}]},"length":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment duration in seconds. Alias of seance_length. Includes technical_break_duration."},"children":[]}]}]}]},"sms_before":{"type":"number","description":"Whether to send an SMS reminder to the client (if the client is specified)"},"sms_now":{"type":"number","description":"Did you send SMS when adding an appointment"},"sms_now_text":{"type":"string","description":"SMS text"},"email_now":{"type":"number","description":"Has an email notification been sent?"},"notified":{"type":"number","description":"Flag for confirmation of the appointment by the location administrator, if the client asked to confirm the appointment"},"master_request":{"type":"number","description":"Indicates whether a specific team member was selected for the appointment. Set to false if the \"any team member\" option was chosen"},"api_id":{"type":"string","description":"External appointment ID"},"from_url":{"type":"string","description":"From which page the transition was made to complete the appointment (website, VK application, etc.)"},"review_requested":{"type":"number","description":"Flag for requesting visit feedback from the client"},"activity_id":{"type":"number","description":"Group event ID"},"documents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Document type"},"storage_id":{"type":"number","description":"Inventory ID"},"user_id":{"type":"number","description":"ID of the user who created the document"},"company_id":{"type":"number","description":"location ID"},"number":{"type":"number","description":"Document Number"},"comment":{"type":"string","description":"Document comment"},"date_created":{"type":"string","description":"Document creation date","format":"date-time"},"category_id":{"type":"integer","description":"Product category ID","format":"int32"},"visit_id":{"type":"integer","description":"Visit ID"},"record_id":{"type":"integer","description":"Appointment ID"},"type_title":{"type":"string","description":"The name of the entity to which the document belongs"}}}}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a visit","example":{"success":true,"data":{"attendance":1,"datetime":"2026-09-21T23:00:00.000-05:00","comment":0,"records":[{"id":37955315,"company_id":4564,"staff_id":55436,"services":[],"events":[],"goods_transactions":[],"staff":{"id":55436,"name":"John Doe","specialization":"Manicure and pedicure","position":{"id":1,"title":"Supervisor"},"avatar":"https://app.alteg.io/uploads/masters/sm/b/bb/bb59d4cc17d9b16_20171215174158.png","avatar_big":"https://app.alteg.io/uploads/masters/origin/c/cf/cfb8c5cee58000b_20171215174158.png","rating":4.89,"votes_count":0},"client":{"id":4240788,"name":"dev1","phone":13155550175,"card":415,"email":"","success_visits_count":58,"fail_visits_count":9},"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-03-22T17:55:14-05:00","comment":"","online":false,"visit_attendance":1,"attendance":1,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":1,"sms_now":1,"sms_now_text":"","email_now":1,"notified":0,"master_request":0,"api_id":"0","from_url":"","review_requested":0,"visit_id":8260852,"created_user_id":999290,"deleted":0,"paid_full":0,"prepaid":0,"prepaid_confirmed":0,"last_change_date":"2026-03-28T17:46:48-05:00","custom_color":"","custom_font_color":"","record_labels":[],"activity_id":0,"custom_fields":{},"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}]}]},"meta":[]}}},"components/schemas/visit_details_data_types":{"id":"components/schemas/visit_details_data_types","kind":"json-schema","title":"Root Type for visit_details_data_types","data":{"title":"Root Type for visit_details_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"payment_transactions":{"type":"array","description":"Payment transactions","items":{"type":"object","properties":{"id":{"type":"number","description":"Payment transaction ID"},"document_id":{"type":"number","description":"Document ID"},"date":{"type":"string","description":"Transaction date","format":"date-time"},"type_id":{"type":"number","description":"Transaction type"},"expense_id":{"type":"number","description":"Payment Item ID"},"account_id":{"type":"number","description":"Checkout ID"},"amount":{"type":"number","description":"Payment amount"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"comment":{"type":"string","description":"A comment"},"item_id":{"type":"number","description":"Item ID"},"target_type_id":{"type":"integer","format":"int32"},"record_id":{"type":"number","description":"Appointment ID"},"goods_transaction_id":{"type":"number","description":"Commodity transaction ID"},"expense":{"type":"object","properties":{"id":{"type":"integer","description":"Payment Item ID"},"title":{"type":"string","description":"Name of payment item"}},"description":"Payment item"},"account":{"type":"object","properties":{"id":{"type":"number","description":"Checkout ID"},"title":{"type":"string","description":"Location account name"}},"description":"Location account"},"client":{"type":"object","properties":{"id":{"type":"integer","description":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Phone number"}},"description":"Customer"},"master":{"type":"array","description":"team member","items":{"type":"object"}},"supplier":{"type":"array","description":"The supplier","items":{"type":"object"}}}}},"loyalty_transactions":{"type":"array","description":"Loyalty transactions","items":{"type":"object","properties":{"id":{"type":"number","description":"Transaction ID"},"status_id":{"type":"number","description":"Transaction status ID"},"amount":{"type":"number","description":"Loyalty payment amount","format":"double"},"type_id":{"type":"number","description":"Type of loyalty transaction"},"program_id":{"type":"number","description":"Loyalty program ID"},"card_id":{"type":"number","description":"Loyalty card ID"},"salon_group_id":{"type":"number","description":"ID of the location chain, within the loyalty of which this transaction was created"},"item_id":{"type":"number","description":"Position ID in the order, if the transaction is related to the sale of a product or service"},"item_type_id":{"type":"number","description":"Item type in the order to which this transaction relates (1 Provision of service, 7 Sale of products), if applicable"},"item_record_id":{"type":"number","description":"ID of the appointment to which the item in the order belongs, if applicable"},"goods_transaction_id":{"type":"number","description":"Item sale transaction ID"},"is_discount":{"type":"boolean"},"is_loyalty_withdraw":{"type":"boolean"},"type":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"}}}}}},"kkm_transaction_details_container":{"type":"object","properties":{"last_operation_type":{"type":"number","description":"Type of last KKM operation"},"transactions":{"type":"array","description":"KKM transaction","items":{"type":"object","properties":{"id":{"type":"number","description":"Transaction ID"},"print_date":{"type":"string","description":"Check printing date","format":"date-time"},"printed_count":{"type":"integer","format":"int32"},"sum":{"type":"number","description":"Payment amount with an accuracy of 2 decimal places","format":"float"},"type":{"type":"object","properties":{"id":{"type":"number","description":"Payment type ID"},"title":{"type":"string","description":"Payment type name"}},"description":"Payment type"},"status":{"type":"object","properties":{"id":{"type":"number","description":"Status ID"},"title":{"type":"string","description":"Status name"}},"description":"Receipt printing status"},"document":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"type":{"type":"number","description":"Document type identifier"},"type_title":{"type":"string","description":"Document entity name"}},"description":"document"},"cashier":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"team member name"}},"description":"Cashier"}}}}},"description":"KKM transaction details"},"items":{"type":"array","description":"Array of products/services","items":{"type":"object","properties":{"id":{"type":"number","description":"Array entity ID"},"item_id":{"type":"number","description":"Product or service identifier"},"item_type_id":{"type":"integer","format":"int32"},"record_id":{"type":"number","description":"Appointment ID"},"item_title":{"type":"string","description":"Name of the product or service"},"amount":{"type":"number","description":"Quantity"},"first_cost":{"type":"number","description":"Initial cost","format":"float"},"manual_cost":{"type":"number","description":"Manual price","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"cost":{"type":"number","description":"Final price minus all discounts and promotions","format":"float"},"master_id":{"type":"number","description":"team member ID"},"good_id":{"type":"number","description":"Item ID"},"service_id":{"type":"number","description":"Service ID"},"event_id":{"type":"number","description":"Promotion ID"},"is_service":{"type":"boolean","description":"This is a service"},"is_event":{"type":"boolean","description":"This is a promotion"},"is_good":{"type":"boolean","description":"This is a product"}},"description":"Sale objects array"}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get Visit Details","example":{"success":true,"data":{"payment_transactions":[{"id":6023813,"document_id":8172806,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":32299,"amount":10,"client_id":4241492,"master_id":0,"supplier_id":0,"comment":"","item_id":1162679,"target_type_id":1,"record_id":13136569,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":32299,"title":"Deposits (payment in cash)"},"client":{"id":4241492,"name":"ModulKassaClient","phone":"+13155550175"},"master":[],"supplier":[]}],"loyalty_transactions":[{"id":10614,"status_id":1,"amount":0.5,"type_id":2,"program_id":145,"card_id":20013,"salon_group_id":646,"item_id":0,"item_type_id":0,"item_record_id":0,"goods_transaction_id":0,"is_discount":false,"is_loyalty_withdraw":false,"type":{"id":2,"title":"Loyalty programs"}}],"kkm_transaction_details_container":{"last_operation_type":0,"transactions":[{"id":1047,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":1,"sum":13,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":2045,"type":7,"type_title":"Visit"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"items":[{"id":0,"item_id":1162679,"item_type_id":1,"record_id":13136569,"item_title":"Haircut with the TOP-expert","amount":2,"first_cost":20,"manual_cost":10,"discount":50,"cost":10,"master_id":13136569,"good_id":0,"service_id":1162679,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]},"meta":[]}}},"components/schemas/visits_visitid_recordid_request_data_types":{"id":"components/schemas/visits_visitid_recordid_request_data_types","kind":"json-schema","title":"Root Type for visits_visitid_recordid_request_data_types","data":{"title":"Root Type for visits_visitid_recordid_request_data_types","required":["attendance","comment"],"type":"object","properties":{"attendance":{"type":"number","description":"Visit status (2 - The user confirmed the appointment, 1 - The user came, the services were provided, 0 - the user is waiting, -1 - the user did not show)"},"comment":{"type":"string","description":"A comment"},"new_transactions":{"type":"array","description":"Array of objects of new commodity transactions","items":{"type":"object","properties":{"id":{"type":"number","description":"Financial transaction ID"},"amount":{"type":"number","description":"Sum","format":"float"},"account_id":{"type":"number","description":"Checkout ID"}}}},"deleted_transaction_ids":{"type":"array","description":"Array of instance IDs","items":{"type":"object"}},"goods_transactions":{"type":"array","description":"Array of commodity transactions objects","items":{"type":"object","properties":{"id":{"type":"number","description":"Inventory transaction ID"},"title":{"type":"string","description":"Barcode"},"barcode":{"type":"string","description":"Barcode"},"article":{"type":"string","description":"vendor code"},"amount":{"type":"string","description":"Sum"},"cost_per_unit":{"type":"string","description":"Unit price"},"price":{"type":"string","description":"Price"},"cost":{"type":"string","description":"Selling price"},"operation_unit_type":{"type":"number","description":"Unit type: 1 - for sale, 2 - for write-off"},"master_id":{"type":"string","description":"team member ID"},"storage_id":{"type":"string","description":"Inventory ID"},"good_id":{"type":"string","description":"Item ID"},"discount":{"type":"string","description":"Discount"}}}},"services":{"type":"array","description":"Array of objects with services","items":{"type":"object","properties":{"id":{"type":"number","description":"Service ID"},"title":{"type":"string","description":"Service name"},"cost":{"type":"number","description":"The total cost of the service","format":"float"},"cost_per_unit":{"type":"number","description":"Unit price","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"first_cost":{"type":"number","description":"Initial cost of the service","format":"float"},"record_id":{"type":"number","description":"Appointment ID"}}}},"fast_payment":{"type":"number","description":"Quick payment 1 - cash, 2 - cashless, 129 - cash and print, 130 - cashless and print"}},"description":"Edit Visit","example":{"attendance":1,"comment":"","new_transactions":[{"id":12345,"amount":100,"account_id":23322}],"deleted_transaction_ids":[],"fast_payment":1,"goods_transactions":[{"id":2168657,"title":"Vital Creme Shampoo Plus","barcode":"123","article":"120277","amount":-1,"cost_per_unit":15,"price":15,"cost":12,"operation_unit_type":2,"master_id":55436,"storage_id":91303,"good_id":232658,"discount":20}],"services":[{"id":389045,"title":"Hand massage (10 min)","cost":255,"cost_per_unit":300,"discount":15,"first_cost":300,"record_id":10403702}]}}},"components/schemas/comments_companyid_ressponse200_data_types":{"id":"components/schemas/comments_companyid_ressponse200_data_types","kind":"json-schema","title":"Root Type for comments_companyid_ressponse200_data_types","data":{"title":"Root Type for comments_companyid_ressponse200_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":"Comment ID"},"salon_id":{"type":"number","description":"location ID"},"type":{"type":"number","description":"1 - comment to the team member, 0 - to the location"},"master_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member ID if type = 1"},"children":[]}]}]}]},"text":{"type":"string","description":"Comment text"},"date":{"type":"string","description":"The date the comment was posted","format":"date-time"},"rating":{"type":"string","description":"Rating (from 1 to 5)"},"user_id":{"type":"number","description":"ID of the user who left the comment"},"user_name":{"type":"string","description":"Name of the user who left the comment"},"user_avatar":{"type":"string","description":"Avatar of the user who left the comment"},"record_id":{"type":"number","description":"ID of the post after which the review was left"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get comments","example":{"success":true,"data":[{"id":18437,"salon_id":12345,"type":1,"master_id":8864,"text":"Fine!","date":"2026-09-21T23:00:00.000-05:00","rating":4,"user_id":157169,"user_name":"Victor Sitnikov","user_avatar":"/images/no-master.png","record_id":100001}],"meta":[]}}},"components/schemas/comments_companyid_request_data_types":{"id":"components/schemas/comments_companyid_request_data_types","kind":"json-schema","title":"Root Type for comments_companyid_request_data_types","data":{"title":"Root Type for comments_companyid_request_data_types","required":["mark","name","text"],"type":"object","properties":{"mark":{"type":"number","description":"Rating from 1 to 5"},"text":{"type":"string","description":"Feedback text"},"name":{"type":"string","description":"Username to be displayed on the review page"}},"description":"Leave a Comment","example":{"mark":4,"text":"Everything is very bad!","name":"Victor"}}},"components/schemas/event_search_response":{"id":"components/schemas/event_search_response","kind":"json-schema","title":"Event Search Response","data":{"title":"Event Search Response","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":"Event ID"},"service_id":{"type":"number","description":"Service ID"},"company_id":{"type":"number","description":"Location ID"},"staff_id":{"type":"number","description":"team member ID"},"date":{"type":"string","description":"Session date","format":"date-time"},"length":{"type":"number","description":"Duration"},"capacity":{"type":"number","description":"Capacity"},"records_count":{"type":"number","description":"Number of appointments"},"color":{"type":"string","description":"Color"},"instructions":{"type":"string","description":"Instructions"},"stream_link":{"type":"string","description":"Link to instructions"},"font_color":{"type":"string","description":"Font color"},"notified":{"type":"boolean","description":"Notifications"},"prepaid":{"type":"string","description":"Prepayment"},"service":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Service ID"},"category_id":{"type":"number","description":"Service category identifier"},"title":{"type":"string","description":"Service name"},"price_min":{"type":"number","description":"The minimum cost of the service","format":"float"},"price_max":{"type":"number","description":"Maximum cost of the service","format":"float"},"comment":{"type":"string","description":"A comment"},"image_url":{"type":"string","description":"The path to the image with the image of the service"},"salon_service_id":{"type":"number","description":"Category ID for the location on the chain"},"prepaid":{"type":"string","description":"Prepayment"},"category":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Category ID"},"category_id":{"type":"number","description":"Product category ID (0 if the item is a product)"},"title":{"type":"string","description":"name of category"}},"description":"Category"}},"description":"Service"},"staff":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"team member ID"},"api_id":{"type":["string","null"],"description":"team member External ID"},"name":{"type":"string","description":"team member name"},"company_id":{"type":"number","description":"Location ID"},"specialization":{"type":"string","description":"team member specialization"},"rating":{"type":"number","description":"Rating","format":"double"},"show_rating":{"type":"number","description":"Whether to show the team member's rating (1 - show, 0 - do not show)"},"avatar":{"type":"string","description":"Path to team member avatar file"},"avatar_big":{"type":"string","description":"The path to the team member's avatar file in a higher resolution"},"comments_count":{"type":"number","description":"Number of comments to the team member"},"votes_count":{"type":"number","description":"Number of votes that rated a team member"},"average_score":{"type":"number","description":"Average rating","format":"double"},"prepaid":{"type":"string","description":"Indicates whether online payment is available for the appointment"},"position":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Job ID"},"title":{"type":"string","description":"Job Title"}},"description":"team member's position"}},"description":"team member"},"resource_instances":{"type":"array","description":"Resource instance","items":{"type":"object","properties":{"id":{"type":"number","description":"Resource instance ID"},"title":{"type":"string","description":"Resource instance name"},"resource_id":{"type":"number","description":"Resource ID"}}}},"labels":{"type":"array","description":"Post category","items":{"type":"object"}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of Events found)"}},"description":"Search Events response","example":{"success":true,"data":[{"id":3480140,"service_id":5243360,"company_id":68570,"staff_id":921105,"date":"2026-09-21T23:00:00.000-05:00","length":3600,"capacity":40,"records_count":0,"color":"","instructions":"","stream_link":"","font_color":"","notified":false,"prepaid":"forbidden","service":{"id":5243360,"category_id":5092305,"title":"Lecture: is it possible to re-educate a perverted narcissist","price_min":500,"price_max":500,"comment":"Spoiler: no.","image_url":"","salon_service_id":5792535,"prepaid":"forbidden","category":{"id":5092305,"category_id":1,"title":"Psychoanalysis (service category Natalie)"}},"staff":{"id":921105,"name":"Natalie","company_id":68570,"specialization":"Do not touch","rating":4.57,"show_rating":0,"avatar":"https://assets.alteg.io/masters/sm/7/70/70e95a2383e51da_20210426134346.png","avatar_big":"https://assets.alteg.io/masters/origin/7/7d/7da6be6c33a59cd_20210426134346.png","comments_count":7,"votes_count":0,"average_score":4.57,"prepaid":"forbidden","position":{"id":123340,"title":"Psychotherapist"}},"resource_instances":[{"id":83030,"title":"Psychotherapist's office. #one","resource_id":34895}],"labels":{}}],"meta":{"count":1}}}},"components/schemas/event_dates_range":{"id":"components/schemas/event_dates_range","kind":"json-schema","title":"Event Date Range","data":{"title":"Event Date Range","type":"object","description":"Date range for Event search.","properties":{"min_date":{"type":["string","null"],"description":"Start date (YYYY-MM-DD)."},"max_date":{"type":["string","null"],"description":"End date (YYYY-MM-DD)."}},"example":{"min_date":"2026-06-01","max_date":"2026-07-15"}}},"components/schemas/event_filter":{"id":"components/schemas/event_filter","kind":"json-schema","title":"Event Search Filter","data":{"title":"Event Search Filter","type":"object","additionalProperties":true,"description":"Event search filter.","properties":{"code":{"type":"string","description":"Filter type.","enum":["staff","resource","service","service_category"]},"title":{"type":"string","description":"Filter title."},"data":{"type":"array","description":"Filter items.","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Filter item ID."},"title":{"type":"string","description":"Filter item title."},"is_disabled":{"type":"boolean","description":"Flag that filter item is disabled for selection (depends on previously applied filters passed as query parameters)."}}}}},"example":{"code":"service","title":"Services","data":[{"id":1,"title":"Service 1","is_disabled":true},{"id":2,"title":"Service 2","is_disabled":false}]}}},"components/schemas/event_response":{"id":"components/schemas/event_response","kind":"json-schema","title":"Event Response","data":{"title":"Event Response","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Event ID"},"salon_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location ID (deprecated, use company_id)"},"children":[]}]}]}]},"company_id":{"type":"number","description":"Location ID"},"service_id":{"type":"number","description":"Service ID"},"staff_id":{"type":"number","description":"team member ID"},"date":{"type":"string","description":"Event date and time"},"timestamp":{"type":"number","description":"Unix timestamp of Event date"},"length":{"type":"number","description":"Event duration in seconds"},"capacity":{"type":"number","description":"Capacity"},"records_count":{"type":"number","description":"Number of Appointments in this Event"},"color":{"type":"string","description":"Event color"},"font_color":{"type":"string","description":"Font color"},"instructions":{"type":"string","description":"Event instructions"},"stream_link":{"type":"string","description":"Stream link for online events"},"notified":{"type":"boolean","description":"Whether notifications have been sent"},"comment":{"type":["string","null"],"description":"Event comment"},"prepaid":{"type":"string","description":"Prepayment status (forbidden, optional, required)"},"is_deleted":{"type":"boolean","description":"Whether Event is deleted"},"duration_details":{"type":"object","description":"Event duration details","properties":{"id":{"type":"number","description":"Duration detail ID"},"services_duration":{"type":"number","description":"Services duration in seconds"},"technical_break_duration":{"type":"number","description":"Technical break duration in seconds"}}},"service":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Service ID"},"title":{"type":"string","description":"Service name"},"category_id":{"type":"number","description":"Service category identifier"}},"description":"Service"},"staff":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"team member name"},"company_id":{"type":"number","description":"Location ID"}},"description":"team member"},"resource_instances":{"type":"array","description":"Resource instances","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Resource instance ID"},"title":{"type":"string","description":"Resource instance name"},"resource_id":{"type":"number","description":"Resource ID"}}}},"labels":{"type":"array","description":"Event tags","items":{"type":"object"}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Event object with details","example":{"success":true,"data":{"id":108,"salon_id":4564,"service_id":1185299,"staff_id":26427,"date":"2026-09-21T23:00:00.000-05:00","length":3600,"capacity":9,"records_count":0,"color":"","font_color":"","service":{"id":1185299,"title":"Group manicure","category_id":754917},"staff":{"id":26427,"name":"Monica Bellucci","company_id":4564},"resource_instances":[{"id":3127,"title":"Manicure machine #1","resource_id":1364}]},"meta":[]}}},"components/schemas/event_request":{"id":"components/schemas/event_request","kind":"json-schema","title":"Event Request","data":{"title":"Event Request","required":["capacity","date","force","service_id","staff_id"],"type":"object","properties":{"date":{"type":"string","description":"date and time","format":"date-time"},"service_id":{"type":"number","description":"Service ID"},"staff_id":{"type":"number","description":"team member ID"},"capacity":{"type":"number","description":"Capacity"},"resource_instance_ids":{"type":"array","description":"Array of resource instance IDs","items":{"type":"number"}},"force":{"type":"boolean","description":"Ignore errors (busy team member/resources, etc.)"},"length":{"type":"number","description":"Event duration in seconds"}},"description":"Event creation/update request body","example":{"date":"2026-10-10 15:30","service_id":1185299,"staff_id":26427,"length":3600,"capacity":9,"resource_instance_ids":[3127],"force":false}}},"components/schemas/event_services_response":{"id":"components/schemas/event_services_response","kind":"json-schema","title":"Event Services Response","data":{"title":"Event Services Response","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":"Service ID"},"title":{"type":"string","description":"Service name"},"capacity":{"type":"number","description":"Capacity"},"price_min":{"type":"number","description":"The minimum cost of the service"},"price_max":{"type":"number","description":"Maximum cost of the service"},"is_multi":{"type":"boolean","description":"Is the Service available for Events"},"category":{"type":"object","properties":{"id":{"type":"number","description":"Category ID"},"title":{"type":"string","description":"Service category name"}},"description":"Service category"},"staff":{"type":"array","description":"team member","items":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"team member name"},"length":{"type":"number","description":"Service duration"}}}},"resources":{"type":"array","description":"Resources","items":{"type":"object","properties":{"id":{"type":"number","description":"Resource ID"},"title":{"type":"string","description":"Resource name"},"salon_id":{"type":"number","description":"Location ID"}}}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of services found)"}},"description":"Search Event services response","example":{"success":true,"data":[{"id":1209148,"title":"Fitness test","capacity":5,"price_min":2,"price_max":3,"is_multi":true,"category":{"id":1285356,"title":"Group services"},"staff":[{"id":37695,"name":"Kim Kardashian","length":7200}],"resources":[{"id":464,"title":"massage room","salon_id":4564}]}],"meta":{"count":1}}}},"components/schemas/resources_companyid_data_types":{"id":"components/schemas/resources_companyid_data_types","kind":"json-schema","title":"Root Type for resources_companyid_data_types","data":{"title":"Root Type for resources_companyid_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array with data objects","items":{"type":"object","properties":{"id":{"type":"number","description":"Resource ID"},"title":{"type":"string","description":"Resource name"},"instances":{"type":"array","description":"Array of resource instances","items":{"type":"object","properties":{"id":{"type":"number","description":"Resource instance ID"},"title":{"type":"string","description":"Resource instance name"},"resource_id":{"type":"number","description":"ID of the resource that owns the instance"}}}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of resources found)"}},"description":"Getting Resources at a Location","example":{"success":true,"data":[{"id":70,"title":"Pedicure chair","instances":[{"id":181,"title":"Pedicure chair #1","resource_id":70}]},{"id":464,"title":"massage room","instances":[{"id":1094,"title":"Massage room 1st floor","resource_id":464},{"id":1162,"title":"Massage room 2nd floor","resource_id":464}]}],"meta":{"count":2}}}},"components/schemas/tag":{"id":"components/schemas/tag","kind":"json-schema","title":"Object of model \"Tag\"","data":{"title":"Object of model \"Tag\"","type":"object","properties":{"id":{"type":"number","description":"ID of tag."},"title":{"type":"string","description":"Title of a tag."},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Color of a tag (#rrggbb)."},"children":[]}]}]}]}},"example":{"id":123,"title":"Tag","color":"#ff0000"}}},"components/schemas/resource_instance":{"id":"components/schemas/resource_instance","kind":"json-schema","title":"Object of model \"Resource Instance\"","data":{"title":"Object of model \"Resource Instance\"","type":"object","properties":{"id":{"type":"number","description":"ID of a resource instance."},"title":{"type":"string","description":"Title of a resource instance."},"resource_id":{"type":"number","description":"ID of a resource, to which instance is linked."}},"example":{"id":123,"title":"Resource #1","resource_id":123}}},"components/schemas/timetable_event_schedule_event":{"id":"components/schemas/timetable_event_schedule_event","kind":"json-schema","title":"Object of model \"Event of appointment/event in a Schedule\"","data":{"title":"Object of model \"Event of appointment/event in a Schedule\"","description":"Data of the existing event of appointment or event in a schedule.","type":"object","properties":{"id":{"type":"number","description":"ID of an event of appointment/event in a schedule."},"created_at":{"type":"string","description":"Datetime of an event of appointment/event in a schedule created.","format":"date-time"},"updated_at":{"type":"string","description":"Datetime of an event of appointment/event in a schedule last updated.","format":"date-time"},"deleted_at":{"type":["string","null"],"description":"Datetime of an event of appointment/event in a schedule deleted.","format":"date-time"},"event_status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event of appointment/event status:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stable"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - entity is stable;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - event is created, corresponding appointment/event is not created yet;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - event is changed, corresponding appointment/event is not changed yet;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_changed_force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - event is changed with force override of manual changes, corresponding appointment/event is not changed yet;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - event is deleted, corresponding appointment/event is not deleted yet;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - appointment/event corresponding to an event is deleted (due to event deletion or due to manual deletion);"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - appointment/event creation failure."},"children":[]}]}]}],"enum":["stable","event_created","event_changed","event_changed_force","event_deleted","entity_deleted","entity_failed"]},"event_datetime":{"type":"string","description":"Datetime of a scheduled appointment/event beginning.","format":"date-time"},"event_entity_type":{"type":"string","description":"Type of an scheduled entity (appointment or event). Note: enum values \"record\" and \"activity\" are legacy terms for appointment and event.","enum":["record","activity"]},"event_entity_id":{"type":["number","null"],"description":"ID of an scheduled entity (appointment or event)."},"is_entity_master_changed":{"type":"boolean","description":"Flag for manual change of a team member for a scheduled appointment/event."},"is_entity_datetime_changed":{"type":"boolean","description":"Flag for manual change of a datetime for a scheduled appointment/event."},"is_entity_duration_changed":{"type":"boolean","description":"Flag for manual change of a duration for a scheduled appointment/event."},"is_entity_labels_changed":{"type":"boolean","description":"Flag for manual change of a tags linked to a scheduled appointment/event."},"is_entity_resource_instances_changed":{"type":"boolean","description":"Flag for manual change of a resource instances linked to a scheduled appointment/event."},"entity_master":{"type":"object","description":"Team member for a scheduled appointment/event.","allOf":[{"$ref":"#/components/schemas/master_with_position"}]},"entity_datetime":{"type":"string","description":"Actual datetime of a scheduled appointment/event beginning."},"entity_duration":{"type":"string","description":"Actual duration of a scheduled appointment/event."},"entity_labels":{"type":"array","description":"Actual tags linked to a scheduled appointment/event.","items":{"$ref":"#/components/schemas/tag"}},"entity_resource_instances":{"type":"array","description":"Actual resource instances linked to a scheduled appointment/event.","items":{"$ref":"#/components/schemas/resource_instance"}}},"example":{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"event_status":"stable","event_datetime":"2026-01-24T14:00:00-05:00","event_entity_type":"activity","event_entity_id":123,"is_entity_master_changed":false,"is_entity_datetime_changed":false,"is_entity_duration_changed":false,"is_entity_labels_changed":false,"is_entity_resource_instances_changed":false,"entity_master":{"id":123,"name":"John Johnson","company_id":123,"specialization":"Team Member","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Team Member"}},"entity_datetime":"2022-01-24 14:00:00","entity_duration":3600,"entity_labels":[{"id":123,"title":"Tag","color":"#ff0000"}],"entity_resource_instances":[{"id":123,"title":"Resource #1","resource_id":123}]}}},"components/schemas/timetable_event_schedule_day":{"id":"components/schemas/timetable_event_schedule_day","kind":"json-schema","title":"Object of model \"Schedule Series\"","data":{"title":"Object of model \"Schedule Series\"","description":"Data for an existing schedule series in a location.","type":"object","properties":{"id":{"type":"number","description":"ID of a schedule series."},"created_at":{"type":"string","description":"Datetime of a schedule series created.","format":"date-time"},"updated_at":{"type":"string","description":"Datetime of a schedule series last updated.","format":"date-time"},"deleted_at":{"type":["string","null"],"description":"Datetime of a schedule series deleted.","format":"date-time"},"timetable_event_schedule_id":{"type":"number","description":"ID of a schedule, which series is linked to."},"day_of_week":{"type":"string","description":"Day of week of a schedule series.","enum":["mon","tue","wed","thu","fri","sat","sun"]},"events_time":{"type":"string","description":"Time of beginning of the events in a schedule series."},"events_duration":{"type":"number","description":"Duration of the events in a schedule series.\nNote: Does not include technical break duration.\n"},"event_technical_break_duration":{"type":"number","description":"Technical break duration in seconds."},"events_master":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team member for the events in a schedule series."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned in response only if corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present in request."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/master_with_position"}]},"events_labels":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags for the events in a schedule series."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned in response only if corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present in request."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/tag"}},"events_resource_instances":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource instances for the events in a schedule series."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned in response only if corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present in request."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/resource_instance"}},"events":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events of appointments or events in a schedule series."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned in response only if corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present in request."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/timetable_event_schedule_event"}}},"example":{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"timetable_event_schedule_id":123,"day_of_week":"mon","events_time":"14:00:00","events_duration":3600,"event_technical_break_duration":0,"events_master":{"id":123,"name":"John Johnson","company_id":123,"specialization":"Team Member","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Team Member"}},"events_labels":[{"id":123,"title":"Tag","color":"#ff0000"}],"events_resource_instances":[{"id":123,"title":"Resource #1","resource_id":123}],"events":[{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"event_status":"stable","event_datetime":"2026-01-24T14:00:00-05:00","event_entity_type":"activity","event_entity_id":123,"is_entity_master_changed":false,"is_entity_datetime_changed":false,"is_entity_duration_changed":false,"is_entity_labels_changed":false,"is_entity_resource_instances_changed":false}]}}},"components/schemas/timetable_event_schedule":{"id":"components/schemas/timetable_event_schedule","kind":"json-schema","title":"Object of model \"Schedule\"","data":{"title":"Object of model \"Schedule\"","description":"Data for an existing schedule in a location.","type":"object","properties":{"id":{"type":"number","description":"ID of a schedule."},"created_at":{"type":"string","description":"Datetime of a schedule created.","format":"date-time"},"updated_at":{"type":"string","description":"Datetime of a schedule last updated.","format":"date-time"},"deleted_at":{"type":["string","null"],"description":"Datetime of a schedule deleted.","format":"date-time"},"original_entity_type":{"type":"string","description":"Type of entity schedule is based on (appointment or event).","enum":["record","activity"]},"original_entity_id":{"type":"number","description":"ID of entity schedule is based on."},"date_start":{"type":"string","description":"Date of a schedule start.","format":"date"},"date_end":{"type":"string","description":"Date of a schedule end.","format":"date"},"days":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schedule series, linked to a specified schedule."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned in response only if corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present in request."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/timetable_event_schedule_day"}}},"example":{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"original_entity_type":"activity","original_entity_id":123,"date_start":"2026-01-01","date_end":"2026-02-01","days":[{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"timetable_event_schedule_id":123,"day_of_week":"mon","events_time":"14:00:00","events_duration":3600,"events_master":{"id":123,"name":"John Johnson","company_id":123,"specialization":"Team Member","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Team Member"}},"events_labels":[{"id":123,"title":"Tag","color":"#ff0000"}],"events_resource_instances":[{"id":123,"title":"Resource #1","resource_id":123}]}]}}},"components/schemas/timetable_event_schedule_client_schedule":{"id":"components/schemas/timetable_event_schedule_client_schedule","kind":"json-schema","title":"Object of model \"Client schedule\"","data":{"title":"Object of model \"Client schedule\"","description":"Data for an existing client schedule in a location.","type":"object","properties":{"id":{"type":"number","description":"ID of a client schedule."},"loyalty_abonement_id":{"type":["number","null"],"description":"ID of a loyalty membership used for client schedule (not supported at the moment)."},"final_day":{"type":"string","description":"Datetime of a client schedule end."},"days":{"type":"array","description":"Schedule series linked to a client schedule.","items":{"$ref":"#/components/schemas/timetable_event_schedule_day"}}},"example":{"id":123,"loyalty_abonement_id":null,"final_day":"2022-01-01 12:12:12","days":[{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"timetable_event_schedule_id":123,"day_of_week":"mon","events_time":"14:00:00","events_duration":3600,"event_technical_break_duration":0,"events_master":{"id":123,"name":"John Johnson","company_id":123,"specialization":"Team Member","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Team Member"}},"events_labels":[{"id":123,"title":"Tag","color":"#ff0000"}],"events_resource_instances":[{"id":123,"title":"Resource #1","resource_id":123}]}]}}},"components/schemas/company_get_timetable_settings_response_data_field_data_types":{"id":"components/schemas/company_get_timetable_settings_response_data_field_data_types","kind":"json-schema","title":"Root Type for company_get_timetable_settings_response_data_field_data_types","data":{"title":"Root Type for company_get_timetable_settings_response_data_field_data_types","required":["activity_record_clients_count_max","record_type"],"type":"object","properties":{"record_type":{"maximum":2,"minimum":0,"type":"integer","description":"Default appointment type: 0 - Mixed appointment, 1 - Individual appointment, 2 - Group event"},"activity_record_clients_count_max":{"maximum":255,"minimum":1,"type":"integer","description":"Maximum number of seats in one group event"},"is_show_newsletter_agreement":{"type":"boolean","description":"Show newsletter subscription agreement checkbox in booking form"},"is_show_personal_data_processing_agreement":{"type":"boolean","description":"Show personal data processing agreement checkbox in booking form"}},"description":"","example":{"record_type":0,"activity_record_clients_count_max":1,"is_show_newsletter_agreement":false,"is_show_personal_data_processing_agreement":false}}},"components/schemas/company_get_timetable_settings_response_data_types":{"id":"components/schemas/company_get_timetable_settings_response_data_types","kind":"json-schema","title":"Root Type for company_get_timetable_settings_response_data_types","data":{"title":"Root Type for company_get_timetable_settings_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"$ref":"#/components/schemas/company_get_timetable_settings_response_data_field_data_types"},"meta":{"type":"array","description":"metadata","items":{"type":"object"}}},"description":"Retrieving Appointment Calendar Settings","example":{"success":true,"data":{"record_type":0,"activity_record_clients_count_max":1},"meta":[]}}},"components/schemas/company_update_timetable_settings_data_types":{"id":"components/schemas/company_update_timetable_settings_data_types","kind":"json-schema","title":"Root Type for company_update_timetable_settings_data_type","data":{"title":"Root Type for company_update_timetable_settings_data_type","required":["activity_record_clients_count_max","record_type"],"type":"object","properties":{"record_type":{"maximum":2,"minimum":0,"type":"integer","description":"Default appointment type: 0 - Mixed appointment, 1 - Individual appointment, 2 - Group event"},"activity_record_clients_count_max":{"maximum":255,"minimum":1,"type":"integer","description":"Maximum number of seats in one group event"}},"description":"Timetable settings for a location","example":{"record_type":0,"activity_record_clients_count_max":1}}},"components/schemas/goods_search_response200_data_types":{"id":"components/schemas/goods_search_response200_data_types","kind":"json-schema","title":"Root Type for goods_search_response200_data_types","data":{"title":"Root Type for goods_search_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array with data objects","items":{"type":"object","properties":{"parent_id":{"type":"number","description":"Parent element ID (0 for root elements)"},"item_id":{"type":"number","description":"Item ID (0 if item is a category)"},"category_id":{"type":"number","description":"Product category ID (0 if the item is a product)"},"title":{"type":"string","description":"The name of the product or product category"},"is_chain":{"type":"boolean","description":"Is the element chain-bound? true - the element is connected to the chain, false - not connected"},"is_category":{"type":"boolean","description":"Is the element a category? true - category, false - product"},"is_item":{"type":"boolean","description":"Is the item a product? true - product, false - category"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of categories found)"}},"description":"List request example","example":{"success":true,"data":[{"parent_id":0,"item_id":0,"category_id":123,"title":"Root Category 1","is_chain":true,"is_category":true,"is_item":false},{"parent_id":0,"item_id":0,"category_id":456,"title":"Root Category 2","is_chain":true,"is_category":true,"is_item":false}],"meta":{"count":2}}}},"components/schemas/goods_company_goods_id_response200_data_types":{"id":"components/schemas/goods_company_goods_id_response200_data_types","kind":"json-schema","title":"Root Type for goods_company_goods_id_response200_data_types","data":{"title":"Root Type for goods_company_goods_id_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","description":"Product data object","additionalProperties":true,"properties":{"title":{"type":"string","description":"Name of product"},"value":{"type":"string","description":"Name of product"},"label":{"type":"string","description":"Product name with article number (if any)"},"good_id":{"type":"number","description":"Product ID"},"cost":{"type":"number","description":"Selling price"},"unit_id":{"type":"number","description":"Sales Unit ID"},"unit_short_title":{"type":"string","description":"Sales unit"},"service_unit_id":{"type":"number","description":"ID of unit of measure to write off"},"service_unit_short_title":{"type":"string","description":"Write-off unit"},"actual_cost":{"type":"number","description":"Cost price"},"unit_actual_cost":{"type":"number","description":"Unit cost"},"unit_actual_cost_format":{"type":"string","description":"Unit cost format"},"unit_equals":{"type":"number","description":"The ratio of the unit of measure for sale to the unit for write-off"},"barcode":{"type":"string","description":"Barcode"},"loyalty_abonement_type_id":{"type":"number","description":"Subscription type identifier (if the product is a membership)"},"loyalty_certificate_type_id":{"type":"number","description":"Certificate type identifier (if the item is a certificate)"},"loyalty_allow_empty_code":{"type":["boolean","number"],"description":"Is it allowed to sell without a code (can be 0/1 or true/false)"},"critical_amount":{"type":"number","description":"Critical residue","format":"float"},"desired_amount":{"type":"number","description":"Desired balance","format":"float"},"actual_amounts":{"type":"array","description":"Remaining stock","items":{"type":"object","additionalProperties":true,"properties":{"storage_id":{"type":"number","description":"Inventory ID"},"amount":{"type":"number","description":"Quantity"}}}},"last_change_date":{"type":"string","description":"The date the entity was last modified","format":"date-time"}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Receive item(s)","example":{"success":true,"data":{"title":"Shampoo 1","value":"Shampoo 1","label":"Shampoo 1 (123)","good_id":123456,"cost":100500,"unit_id":4835,"unit_short_title":"PC","service_unit_id":3548,"service_unit_short_title":"gr","actual_cost":1050,"unit_actual_cost":105,"unit_actual_cost_format":"105 r","unit_equals":10,"barcode":"123","loyalty_abonement_type_id":"150","loyalty_certificate_type_id":"0","loyalty_allow_empty_code":false,"critical_amount":0,"desired_amount":0,"actual_amounts":[{"storage_id":987,"amount":1000000}],"last_change_date":"2026-01-01T12:00:00-0500"},"meta":[]}}},"components/schemas/goods_company_request_with_rules_data_type":{"id":"components/schemas/goods_company_request_with_rules_data_type","kind":"json-schema","title":"Root Type for goods_company_request_data_type","data":{"title":"Root Type for goods_company_request_data_type","required":["category_id","sale_unit_id","service_unit_id","title"],"type":"object","properties":{"title":{"type":"string","description":"Product Name"},"print_title":{"type":"string","description":"Title to be printed on receipt"},"article":{"type":"string","description":"vendor code"},"barcode":{"type":"string","description":"Barcode"},"category_id":{"type":"integer","description":"Product category ID"},"cost":{"type":"number","description":"Selling price","format":"float"},"actual_cost":{"type":"number","description":"Cost price","format":"float"},"sale_unit_id":{"type":"integer","description":"Sales unit"},"service_unit_id":{"type":"integer","description":"Write-off unit"},"unit_equals":{"type":"number","description":"The ratio of the unit of measure for sale to the unit of measure for write-off","format":"float"},"critical_amount":{"type":"number","description":"critical residue","format":"float"},"desired_amount":{"type":"number","description":"Desired balance","format":"float"},"netto":{"type":"number","description":"Net weight","format":"float"},"brutto":{"type":"number","description":"Gross weight","format":"float"},"comment":{"type":"string","description":"A comment"},"tax_variant":{"type":"integer","description":"Taxation system"},"vat_id":{"type":"integer","description":"VAT"},"correction_rules":{"type":"array","description":"An array of rules for converting units of measurement (required if there are inventory operations for the product)","items":{"type":"object","properties":{"type":{"type":"integer","description":"Type of transaction"},"base_unit":{"type":"string","description":"Basic units in adjustment"}}}}},"description":"Product Creation Method","example":{"title":"Shampoo","print_title":"Shampoo","article":"123","barcode":"123","category_id":289632,"cost":1000,"actual_cost":500,"sale_unit_id":216762,"service_unit_id":216762,"unit_equals":100,"critical_amount":1,"desired_amount":1,"netto":200,"brutto":250,"comment":"Test comment 123","tax_variant":0,"vat_id":3,"correction_rules":[{"type":1,"base_unit":"service"},{"type":2,"base_unit":"service"},{"type":3,"base_unit":"sale"},{"type":4,"base_unit":"sale"},{"type":5,"base_unit":"sale"}]}}},"components/schemas/goods_company_response409_data_type":{"id":"components/schemas/goods_company_response409_data_type","kind":"json-schema","title":"Root Type for good_company_response409_data_type","data":{"title":"Root Type for good_company_response409_data_type","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"string","description":"Contains null"},"meta":{"type":"object","properties":{"message":{"type":"string"},"conflict":{"type":"boolean"}},"description":"Object with error message"}},"description":"Edit Products","example":{"success":false,"meta":{"message":"The product already has inventory operations, you need to specify the rules for converting units of measure for inventory operations","conflict":true}}}},"components/schemas/goods_company_response422_data_type":{"id":"components/schemas/goods_company_response422_data_type","kind":"json-schema","title":"Root Type for goods_company_response422_data_type","data":{"title":"Root Type for goods_company_response422_data_type","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"string","description":"Contains null"},"meta":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}}},"description":"Contains an error message"}},"description":"Product editing","example":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"The specified taxation system is not available for this country."},{"message":"The specified VAT is not available for this taxation system."},{"[title]":["This field is missing."],"[category_id]":["This field is missing."],"[sale_unit_id]":["This field is missing."],"[service_unit_id]":["This field is missing."]}]}}}},"components/schemas/goods_list_response":{"id":"components/schemas/goods_list_response","kind":"json-schema","title":"Root Type for goods_list_response","data":{"title":"Root Type for goods_list_response","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of products","items":{"type":"object","additionalProperties":true,"properties":{"title":{"type":"string","description":"Product title"},"value":{"type":"string","description":"Product value (usually same as title)"},"label":{"type":"string","description":"Product label for display"},"article":{"type":"string","description":"Product article/SKU"},"category":{"type":"string","description":"Category name"},"category_id":{"type":"number","description":"Category ID"},"salon_id":{"type":"number","description":"Location ID"},"good_id":{"type":"number","description":"Product ID"},"cost":{"type":"number","description":"Product cost"},"unit_id":{"type":"number","description":"Unit ID"},"unit_short_title":{"type":"string","description":"Unit short title (e.g. pc, gr)"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of products response","example":{"success":true,"data":[{"title":"Shampoo 1","value":"Shampoo 1","label":"Shampoo 1 (123)","good_id":123456,"cost":100500,"unit_id":4835,"unit_short_title":"PC"}],"meta":[]}}},"components/schemas/goods_company_request_data_type":{"id":"components/schemas/goods_company_request_data_type","kind":"json-schema","title":"Root Type for goods_company_request_data_type","data":{"title":"Root Type for goods_company_request_data_type","required":["category_id","sale_unit_id","service_unit_id","title"],"type":"object","properties":{"title":{"type":"string","description":"Product Name"},"print_title":{"type":"string","description":"Title to be printed on receipt"},"article":{"type":"string","description":"vendor code"},"barcode":{"type":"string","description":"Barcode"},"category_id":{"type":"integer","description":"Product category ID"},"cost":{"type":"number","description":"Selling price","format":"float"},"actual_cost":{"type":"number","description":"Cost price","format":"float"},"sale_unit_id":{"type":"integer","description":"Sales unit"},"service_unit_id":{"type":"integer","description":"Write-off unit"},"unit_equals":{"type":"number","description":"The ratio of the unit of measure for sale to the unit of measure for write-off","format":"float"},"critical_amount":{"type":"number","description":"critical residue","format":"float"},"desired_amount":{"type":"number","description":"Desired balance","format":"float"},"netto":{"type":"number","description":"Net weight","format":"float"},"brutto":{"type":"number","description":"Gross weight","format":"float"},"comment":{"type":"string","description":"A comment"},"tax_variant":{"type":"integer","description":"Taxation system"},"vat_id":{"type":"integer","description":"VAT"}},"description":"Product Creation Method","example":{"title":"Shampoo","print_title":"Shampoo","article":"123","barcode":"123","category_id":289632,"cost":1000,"actual_cost":500,"sale_unit_id":216762,"service_unit_id":216762,"unit_equals":100,"critical_amount":1,"desired_amount":1,"netto":200,"brutto":250,"comment":"Test comment 123","tax_variant":0,"vat_id":3}}},"components/schemas/goods_categories_response200_data_types":{"id":"components/schemas/goods_categories_response200_data_types","kind":"json-schema","title":"Root Type for goods_categories_response200_data_types","data":{"title":"Root Type for goods_categories_response200_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":"integer","description":"Product category ID"},"title":{"type":"string","description":"Product category name"},"parent_category_id":{"type":["integer","null"],"description":"Parent category ID (null for top-level categories)"},"is_chain":{"type":"boolean","description":"Whether the category belongs to the chain"}}}},"meta":{"type":"object","description":"Metadata","properties":{"count":{"type":"integer","description":"Total number of categories"}}}},"description":"Get a list of product categories","example":{"success":true,"data":[{"id":1035384,"title":"Memberships","parent_category_id":null,"is_chain":true},{"id":961078,"title":"Basic products","parent_category_id":null,"is_chain":false}],"meta":{"count":2}}}},"components/schemas/goods_category_node_response200_data_types":{"id":"components/schemas/goods_category_node_response200_data_types","kind":"json-schema","title":"Root Type for goods_category_node_response200_data_types","data":{"title":"Root Type for goods_category_node_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"parent_id":{"type":"number","description":"Parent element ID (0 for root elements)"},"item_id":{"type":"number","description":"Item ID (always 0)"},"category_id":{"type":"number","description":"Product category ID"},"title":{"type":"string","description":"Product category name"},"is_chain":{"type":"boolean","description":"Is the element chain-bound? true - the element is connected to the chain, false - not connected"},"is_category":{"type":"boolean","description":"Is the element a category? always true"},"is_item":{"type":"boolean","description":"Is the item a product? always false"},"children":{"type":"array","description":"Child elements of a product category","items":{"type":"object","properties":{"parent_id":{"type":"number","description":"Parent element ID (0 for root elements)"},"item_id":{"type":"number","description":"Item ID (0 if item is a category)"},"category_id":{"type":"number","description":"Product category ID (0 if the item is a product)"},"title":{"type":"string","description":"The name of the product or product category"},"is_chain":{"type":"boolean","description":"Is the element chain-bound? true - the element is connected to the chain, false - not connected"},"is_category":{"type":"boolean","description":"Is the element a category? true - category, false - product"},"is_item":{"type":"boolean","description":"Is the item a product? true - product, false - category"}}}},"children_count":{"type":"number","description":"Total number of child products and categories (no recursion)"}},"description":"Object with data"}},"description":"Example of a request to get the composition of a category","example":{"success":true,"data":{"parent_id":0,"item_id":0,"category_id":123,"title":"Root category 1","is_chain":false,"is_category":true,"is_item":false,"children":[{"parent_id":123,"item_id":0,"category_id":456,"title":"Child category","is_chain":false,"is_category":true,"is_item":false},{"parent_id":123,"item_id":789,"category_id":0,"title":"Child product","is_chain":false,"is_category":false,"is_item":true}],"children_count":2}}}},"components/schemas/goods_categories_request_data_types":{"id":"components/schemas/goods_categories_request_data_types","kind":"json-schema","title":"Root Type for goods_categories_request_data_types","data":{"title":"Root Type for goods_categories_request_data_types","required":["title"],"type":"object","properties":{"title":{"type":"string","description":"Product category name"},"parent_category_id":{"type":"integer","description":"Parent category ID (optional, but can be 0 or null if you don't need to specify the parent category)","format":"int32"},"article":{"type":"string","description":"vendor code"},"comment":{"type":"string","description":"A comment"}},"description":"Create a Product Category","example":{"title":"Manicure","parent_category_id":123456,"article":"123article","comment":"Category of products for manicure"}}},"components/schemas/goods_categories_post_put_response_data_types":{"id":"components/schemas/goods_categories_post_put_response_data_types","kind":"json-schema","title":"Root Type for goods_categories_response201_data_types","data":{"title":"Root Type for goods_categories_response201_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"object","properties":{"id":{"type":"integer","description":"Product category ID","format":"int32"},"title":{"type":"string","description":"Product category name"},"parent_category_id":{"type":"integer","description":"Identifier of the parent product category (may be null if there is no parent product category)"}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create a Product Category","example":{"success":true,"data":{"id":123456,"title":"Manicure","parent_category_id":123457},"meta":[]}}},"components/schemas/storage_response_data_types":{"id":"components/schemas/storage_response_data_types","kind":"json-schema","title":"Root Type for storage_response_data_types","data":{"title":"Root Type for storage_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":"Inventory ID"},"title":{"type":"string","description":"Inventory name"},"for_service":{"type":"number","description":"1 - if used for automatic write-off of consumables"},"for_sale":{"type":"number","description":"1 - if the default inventory for selling products"},"comment":{"type":"string","description":"Description of the inventory"},"weight":{"type":"number","description":"Sort order weight"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get location inventories","example":{"success":true,"data":[{"id":1,"title":"Consumables","for_service":1,"for_sale":0,"comment":"To account for consumables"},{"id":2,"title":"Products","for_service":0,"for_sale":1,"comment":"To record store sales"},{"id":23061,"title":"Ors","for_service":0,"for_sale":1,"comment":"Nz"}],"meta":[]}}},"components/schemas/storages_transaction_response_data_types":{"id":"components/schemas/storages_transaction_response_data_types","kind":"json-schema","title":"Root Type for storages_transaction_response_data_types","data":{"title":"Root Type for storages_transaction_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":"Transaction ID"},"document_id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Transaction type identifier"},"type":{"type":"string","description":"Transaction type"},"good":{"type":"object","properties":{"id":{"type":"number","description":"Item ID"},"title":{"type":"string","description":"Product Name"}},"description":"Product"},"storage":{"type":"object","properties":{"id":{"type":"number","description":"Inventory ID"},"title":{"type":"string","description":"Inventory name"}},"description":"Inventory"},"unit":{"type":"object","properties":{"id":{"type":"number","description":"Unit ID"},"title":{"type":"string","description":"Unit name"}},"description":"Unit of measurement"},"operation_unit_type":{"type":"number","description":"Unit type: 1 - for sale, 2 - for write-off"},"create_date":{"type":"string","description":"date of creation","format":"date-time"},"last_change_date":{"type":"string","description":"Last modified date","format":"date-time"},"cost_per_unit":{"type":"number","description":"Unit price","format":"float"},"cost":{"type":"number","description":"Price","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"master":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"title":{"type":"string","description":"team member name"}},"description":"team member"},"supplier":{"type":"object","properties":{"id":{"type":"number","description":"Vendor ID"},"title":{"type":"string","description":"Supplier name"}},"description":"The supplier"},"record_id":{"type":"number","description":"Appointment ID"},"service":{"type":"object","properties":{"id":{"type":"number","description":"Service ID"},"title":{"type":"string","description":"Service name"}},"description":"Service"},"clients":{"type":"object","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Customer phone"}},"description":"Customer"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Search for product transactions","example":{"success":true,"data":[{"id":123456789,"document_id":22256643,"type_id":987654321,"type":"Something","good":{"id":111222333,"title":"Something"},"storage":{"id":333222111,"title":"Storage 1"},"unit":{"id":333222111,"title":"milliliter"},"operation_unit_type":1,"create_date":"2026-12-21T19:08:00-0500","last_change_date":"2026-02-01T12:00:00-0500","cost_per_unit":1.07,"cost":0,"discount":10,"master":{"id":112233445,"title":"James Smith"},"supplier":{"id":11112222,"title":"Best Supplier Ever"},"record_id":1,"service":{"id":1234321,"title":"Service 4"},"clients":{"id":4321234,"name":"George Smith","phone":13155550176}}],"meta":[]}}},"components/schemas/storage_operation_operation_request_data_types":{"id":"components/schemas/storage_operation_operation_request_data_types","kind":"json-schema","title":"Root Type for storage_operation_operation_request_data_types","data":{"title":"Root Type for storage_operation_operation_request_data_types","required":["create_date","goods_transactions","storage_id","type_id"],"type":"object","properties":{"type_id":{"type":"number","description":"Document type (Sale 1, Usage / Material Consumption 2, Product Receipt / Incoming 3, Inventory Write-off / Product Disposal 4, Internal Transfer 5)"},"comment":{"type":"string","description":"A comment"},"create_date":{"type":"string","description":"Document creation date","format":"date-time"},"master_id":{"type":"number","description":"team member ID"},"storage_id":{"type":"number","description":"Inventory ID"},"goods_transactions":{"type":"array","description":"An array of objects containing transaction parameters, similar to a request to create a product transaction","items":{"type":"object"}}},"description":"Create an inventory operation","example":{"type_id":1,"comment":"test document comment","create_date":"2026-09-21T23:00:00.000-05:00","master_id":0,"storage_id":91271,"transactions":[{"good_id":232674,"operation_unit_type":1,"amount":1,"cost_per_unit":100,"discount":10,"cost":90,"client_id":0,"supplier_id":0,"comment":"test transaction comment"}]}}},"components/schemas/storage_operation_operation_response_data_types":{"id":"components/schemas/storage_operation_operation_response_data_types","kind":"json-schema","title":"Root Type for storage_operation_operation_response_data_types","data":{"title":"Root Type for storage_operation_operation_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"document":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Document type identifier"},"type":{"type":"object","properties":{"id":{"type":"number","description":"Document type identifier"},"title":{"type":"string","description":"Document type name"}},"description":"Document Type"},"storage_id":{"type":"number","description":"Inventory ID"},"user_id":{"type":"number","description":"User ID"},"company_id":{"type":"number","description":"location ID"},"number":{"type":"number","description":"Document Number"},"comment":{"type":"string","description":"A comment"},"create_date":{"type":"string","description":"date of creation","format":"date-time"},"storage":{"type":"object","properties":{"id":{"type":"number","description":"Inventory ID"},"title":{"type":"string","description":"Inventory name"}},"description":"Inventory"},"company":{"type":"object","properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"country_id":{"type":"number","description":"Country ID"},"city_id":{"type":"number","description":"City ID"},"timezone":{"type":"string","description":"time zone","format":"date-time"},"address":{"type":"string","description":"location address"},"coordinate_lat":{"type":"string","description":"Latitude"},"coordinate_lon":{"type":"string","description":"Longitude"},"logo":{"type":"string","description":"Let, on which the location logo is located"},"zip":{"type":"string","description":"Postcode"},"phones":{"type":"array","description":"location phone","items":{"type":"object"}},"site":{"type":"string","description":"The site of the location"}},"description":"location"},"user":{"type":"object","properties":{"id":{"type":"number","description":"User ID"},"name":{"type":"string","description":"Username"},"phone":{"type":"string","description":"User phone number"}},"description":"User"}},"description":"Document"},"transactions":{"type":"array","description":"transaction","items":{"type":"object","properties":{"id":{"type":"number","description":"Transaction ID"},"document_id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Document type identifier"},"type":{"type":"object","properties":{"id":{"type":"number","description":"Document type identifier"},"title":{"type":"string","description":"Document type name"}},"description":"Document type"},"company_id":{"type":"number","description":"location ID"},"good_id":{"type":"number","description":"Item ID"},"amount":{"type":"number","description":"Quantity"},"cost_per_unit":{"type":"number","description":"Price per unit","format":"float"},"discount":{"type":"number","description":"Skdika","format":"float"},"cost":{"type":"number","description":"total price","format":"float"},"unit_id":{"type":"number","description":"Unit ID"},"storage_id":{"type":"number","description":"Inventory ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"create_date":{"type":"string","description":"date of creation","format":"date-time"},"comment":{"type":"string","description":"A comment"},"deleted":{"type":"boolean","description":"Has the transaction been deleted?"},"good":{"type":"object","properties":{"id":{"type":"number","description":"Item ID"},"title":{"type":"string","description":"Product Name"}},"description":"Product"},"storage":{"type":"object","properties":{"id":{"type":"number","description":"Inventory ID"},"title":{"type":"string","description":"Inventory name"}},"description":"Inventory"},"supplier":{"type":"array","description":"The supplier","items":{"type":"object"}},"client":{"type":"array","description":"Customer","items":{"type":"object"}},"master":{"type":"array","description":"Team Member","items":{"type":"object"}},"unit":{"type":"object","properties":{"id":{"type":"number","description":"Unit ID"},"title":{"type":"string","description":"Unit name"}},"description":"Units"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create an inventory operation","example":{"success":true,"data":{"document":{"id":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":91271,"user_id":999290,"company_id":4564,"number":1254,"comment":"test document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":91271,"title":"Secret place"},"company":{"id":4564,"title":"Business Example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}},"transactions":[{"id":3428012,"document_id":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"storage_id":91271,"supplier_id":0,"client_id":0,"master_id":0,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"test transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe"},"storage":{"id":91271,"title":"Secret place"},"supplier":[],"client":[],"master":[],"unit":{"id":1,"title":"Thing"}}]},"meta":[]}}},"components/schemas/storage_operation_documents_request_data_types":{"id":"components/schemas/storage_operation_documents_request_data_types","kind":"json-schema","title":"Root Type for storage_operation_documents_request_data_types","data":{"title":"Root Type for storage_operation_documents_request_data_types","required":["create_date","storage_id","type_id"],"type":"object","properties":{"type_id":{"type":"number","description":"Document type (sale 1, receipt 3, write-off 7)"},"comment":{"type":"string","description":"A comment"},"storage_id":{"type":"number","description":"Inventory ID"},"create_date":{"type":"string","description":"Date of the inventory transaction","format":"date-time"}},"description":"Create document","example":{"type_id":1,"comment":"Document comment","storage_id":36539,"create_date":"2026-09-21T23:00:00.000-05:00"}}},"components/schemas/storage_operation_documents_response_data_types":{"id":"components/schemas/storage_operation_documents_response_data_types","kind":"json-schema","title":"Root Type for storage_operation_documents_response_data_types","data":{"title":"Root Type for storage_operation_documents_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Document type identifier"},"type":{"type":"object","properties":{"id":{"type":"number","description":"Document type identifier"},"title":{"type":"string","description":"Document type name"}},"description":"Document type"},"storage_id":{"type":"number","description":"Inventory ID"},"user_id":{"type":"number","description":"User ID"},"company_id":{"type":"number","description":"location ID"},"number":{"type":"number","description":"Document Number"},"comment":{"type":"string","description":"A comment"},"create_date":{"type":"string","description":"date of creation","format":"date-time"},"bill_print_status":{"type":"number","description":"Bill print status"},"storage":{"type":"object","properties":{"id":{"type":"number","description":"Inventory ID"},"title":{"type":"string","description":"Inventory name"}},"description":"Inventory"},"company":{"type":"object","properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"public_title":{"type":"string","description":"Public-facing location name"},"business_group_id":{"type":"number","description":"Business group ID"},"business_type_id":{"type":"number","description":"Business type ID"},"country_id":{"type":"number","description":"Country ID"},"city_id":{"type":"number","description":"City ID"},"timezone":{"type":"number","description":"Timezone ID"},"timezone_name":{"type":"string","description":"Timezone name"},"address":{"type":"string","description":"location address"},"coordinate_lat":{"type":"number","description":"Latitude"},"coordinate_lon":{"type":"number","description":"Longitude"},"logo":{"type":"string","description":"Let, on which the location logo is located"},"zip":{"type":"string","description":"Postcode"},"phones":{"type":"array","description":"location phone","items":{"type":"object"}},"site":{"type":"string","description":"The site of the location"},"phone":{"type":"string","description":"Location phone number"},"allow_delete_record":{"type":"boolean","description":"Allow deleting records"},"allow_change_record":{"type":"boolean","description":"Allow changing records"}},"description":"location"},"user":{"type":"object","properties":{"id":{"type":"number","description":"User ID"},"name":{"type":"string","description":"Username"},"phone":{"type":"string","description":"User phone"},"email":{"type":"string","description":"User email"},"is_approved":{"type":"boolean","description":"Is user approved"},"avatar":{"type":"string","description":"User avatar URL"}},"description":"User"}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create Document","example":{"success":true,"data":{"id":22255503,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":36539,"user_id":999290,"company_id":4564,"number":1251,"comment":"Document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":36539,"title":"Products"},"company":{"id":4564,"title":"Business Example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}},"meta":[]}}},"components/schemas/storage_operation_good_transaction_request_data_types":{"id":"components/schemas/storage_operation_good_transaction_request_data_types","kind":"json-schema","title":"Root Type for storage_operation_good_transaction_request_data_types","data":{"title":"Root Type for storage_operation_good_transaction_request_data_types","required":["amount","cost","cost_per_unit","discount","document_id","good_id","operation_unit_type"],"type":"object","properties":{"document_id":{"type":"number","description":"Document ID","format":"float"},"good_id":{"type":"number","description":"Item ID"},"amount":{"type":"number","description":"Quantity"},"cost_per_unit":{"type":"number","description":"Unit cost","format":"float"},"discount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount in %"},"children":[]}]}]}]},"cost":{"type":"number","description":"Total transaction amount","format":"float"},"operation_unit_type":{"type":"number","description":"unit type: 1 - for sale, 2 - for write-off"},"master_id":{"type":"number","description":"ID of the team member who sold the product"},"client_id":{"type":"number","description":"ID of the customer who bought the product"},"supplier_id":{"type":"number","description":"Vendor ID"},"comment":{"type":"string","description":"A comment"},"good_special_number":{"type":"string","description":"Membership/subscription number. Required when selling a loyalty membership product to a specified client; must be unique."}},"description":"Create Transaction","example":{"document_id":22254960,"good_id":232674,"amount":1,"cost_per_unit":100,"discount":10,"cost":90,"operation_unit_type":1,"master_id":26781,"client_id":0,"supplier_id":0,"comment":"Transaction comment"}}},"components/schemas/storage_operation_good_transaction_response200_data_types":{"id":"components/schemas/storage_operation_good_transaction_response200_data_types","kind":"json-schema","title":"Root Type for storage_operation_good_transaction_response200_data_types","data":{"title":"Root Type for storage_operation_good_transaction_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"document_id":{"type":"integer","format":"int32"},"type_id":{"type":"integer","format":"int32"},"type":{"type":"object","properties":{"id":{"type":"number","description":"Transaction type ID"},"title":{"type":"string","description":"Transaction type name"}},"description":"Transaction type"},"company_id":{"type":"number","description":"location ID"},"good_id":{"type":"number","description":"Product ID"},"amount":{"type":"number","description":"Quantity"},"cost_per_unit":{"type":"number","description":"Unit price","format":"float"},"cost":{"type":"number","description":"Price","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"unit_id":{"type":"number","description":"Unit ID"},"storage_id":{"type":"number","description":"Inventory ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"create_date":{"type":"string","description":"date of creation","format":"date-time"},"last_change_date":{"type":"string","description":"Last modified date","format":"date-time"},"comment":{"type":"string","description":"A comment"},"deleted":{"type":"boolean","description":"Delete transaction flag"},"good_special_number":{"type":"string","description":"Special number (e.g., certificate code)"},"service_amount":{"type":"number","description":"Service quantity"},"sale_amount":{"type":"number","description":"Sale quantity"},"service_unit_id":{"type":"number","description":"Service unit ID"},"sale_unit_id":{"type":"number","description":"Sale unit ID"},"operation_unit_type":{"type":"number","description":"Operation unit type"},"good":{"type":"object","properties":{"id":{"type":"number","description":"Product ID"},"title":{"type":"string","description":"Product Name"},"unit":{"type":"string","description":"unit of measurement"},"value":{"type":"string","description":"Product Name"},"label":{"type":"string","description":"Product Name"},"article":{"type":"string","description":"vendor code"},"category":{"type":"string","description":"Product category name"},"category_id":{"type":"number","description":"Product category ID"},"salon_id":{"type":"number","description":"location ID"},"good_id":{"type":"number","description":"Product ID"},"cost":{"type":"number","description":"Price","format":"float"},"unit_id":{"type":"number","description":"Unit ID"},"unit_short_title":{"type":"string","description":"Abbreviated name of the unit of measurement"},"service_unit_id":{"type":"number","description":"Unit ID for the service"},"service_unit_short_title":{"type":"string","description":"Abbreviated name of the unit of measure for the service"},"actual_cost":{"type":"number","description":"Cost price","format":"float"},"unit_actual_cost":{"type":"number","description":"unit cost","format":"float"},"unit_actual_cost_format":{"type":"string","description":"Unit cost format"},"unit_equals":{"type":"number","description":"Unit value"},"barcode":{"type":"string","description":"Barcode"},"loyalty_abonement_type_id":{"type":"number","description":"Membership ID (if the product is a membership)"},"loyalty_certificate_type_id":{"type":"number","description":"Certificate identifier (if the product is a certificate)"},"loyalty_allow_empty_code":{"type":"number","description":"Is it allowed to sell without a code"},"actual_amounts":{"type":"array","description":"Quantity of products","items":{"type":"object"}},"last_change_date":{"type":"string","description":"Date of last product change"},"comment":{"type":"string","description":"Product comment"},"loyalty_certificate_type":{"type":["object","null"],"description":"Certificate type details (if product is certificate)"},"loyalty_serial_number_limited":{"type":"number","description":"Serial number limit flag"},"is_goods_mark_enabled":{"type":"boolean","description":"Whether products marking is enabled"},"critical_amount":{"type":"number","description":"Critical stock amount threshold"},"desired_amount":{"type":"number","description":"Desired stock amount"},"is_chain":{"type":"boolean","description":"Whether product belongs to chain"}},"description":"Product"},"sale_unit":{"anyOf":[{"type":"object","properties":{"id":{"type":"number"},"company_id":{"type":"number"},"title":{"type":"string"},"short_title":{"type":"string"}}},{"type":"null"}],"description":"Sales unit (can be object or null)"},"service_unit":{"anyOf":[{"type":"object","properties":{"id":{"type":"number"},"company_id":{"type":"number"},"title":{"type":"string"},"short_title":{"type":"string"}}},{"type":"null"}],"description":"Sales unit for service (can be object or null)"},"goods_marks":{"type":"array","description":"Product marking codes","items":{"type":"object"}},"storage":{"type":"object","properties":{"id":{"type":"number","description":"Inventory ID"},"title":{"type":"string","description":"Inventory name"}},"description":"Inventory"},"supplier":{"type":"array","description":"The supplier","items":{"type":"object"}},"client":{"anyOf":[{"type":"array","items":{"type":"object"}},{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}}}],"description":"Customer (can be array or object)"},"master":{"anyOf":[{"type":"array","items":{"type":"object"}},{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"Team Member name"}}}],"description":"Team Member (can be array or object)"},"unit":{"type":"object","properties":{"id":{"type":"number","description":"Unit ID"},"company_id":{"type":"number","description":"Location ID"},"title":{"type":"string","description":"Unit name"},"short_title":{"type":"string","description":"Abbreviated name of the unit of measurement"}},"description":"unit of measurement"}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create transaction","example":{"success":true,"data":{"id":3428010,"document_id":22254960,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"storage_id":36539,"supplier_id":0,"client_id":0,"master_id":26781,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"Transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe","unit":"PC.","value":"delete yy","label":"delete yy","article":"","category":"goose category","category_id":303603,"salon_id":91372,"good_id":15086312,"cost":500,"unit_id":216760,"unit_short_title":"PC","service_unit_id":216760,"service_unit_short_title":"PC","actual_cost":0,"unit_actual_cost":0,"unit_actual_cost_format":"0 USD","unit_equals":1,"barcode":"","loyalty_abonement_type_id":"0","loyalty_certificate_type_id":"0","loyalty_allow_empty_code":true,"actual_amounts":[],"last_change_date":"2026-03-05T18:21:34-0500"},"storage":{"id":36539,"title":"Products"},"sale_unit":null,"service_unit":null,"supplier":[],"client":[],"master":{"id":26781,"name":"Angelina Jolie"},"unit":{"id":1,"title":"Thing","short_title":"PC."}},"meta":[]}}},"components/schemas/storage_operation_good_transaction_response_data_types":{"id":"components/schemas/storage_operation_good_transaction_response_data_types","kind":"json-schema","title":"Root Type for storage_operation_good_transaction_response_data_types","data":{"title":"Root Type for storage_operation_good_transaction_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":"Transaction ID"},"document_id":{"type":"number","description":"Document ID"},"type_id":{"type":"number","description":"Transaction type identifier"},"company_id":{"type":"number","description":"location ID"},"good_id":{"type":"number","description":"Item ID"},"amount":{"type":"number","description":"Quantity of products"},"cost_per_unit":{"type":"number","description":"Unit price","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"cost":{"type":"number","description":"The total cost of the products","format":"float"},"unit_id":{"type":"number","description":"Unit ID"},"operation_unit_type":{"type":"number","description":"Unit type: 1 - for sale, 2 - for write-off"},"storage_id":{"type":"number","description":"Inventory ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"record_id":{"type":"number","description":"Appointment ID"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"create_date":{"type":"string","description":"date of creation","format":"date-time"},"comment":{"type":"string","description":"A comment"},"service_id":{"type":"number","description":"Service ID"},"user_id":{"type":"number","description":"User ID"},"deleted":{"type":"boolean","description":"Has the transaction been deleted?"},"pkg_amount":{"type":"number","description":"Amount in a package"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (number of transactions found)"}},"description":"Get Product Transactions of a Document","example":{"success":true,"data":[{"id":3728232,"document_id":22256643,"type_id":1,"company_id":4564,"good_id":587018,"amount":-10,"cost_per_unit":100,"discount":0,"cost":1000,"unit_id":88272,"operation_unit_type":1,"storage_id":36539,"supplier_id":0,"record_id":0,"client_id":0,"master_id":49754,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"","service_id":0,"user_id":3,"deleted":false,"pkg_amount":0},{"id":3728233,"document_id":22256643,"type_id":1,"company_id":4564,"good_id":232674,"amount":-10,"cost_per_unit":127.5,"discount":0,"cost":1275,"unit_id":1,"operation_unit_type":2,"storage_id":36539,"supplier_id":0,"record_id":0,"client_id":0,"master_id":49754,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"","service_id":0,"user_id":3,"deleted":false,"pkg_amount":0}],"meta":{"count":2}}}},"components/schemas/storage_operation_finance_transaction_response_data_types":{"id":"components/schemas/storage_operation_finance_transaction_response_data_types","kind":"json-schema","title":"Root Type for storage_operation_finance_transaction_response_data_types","data":{"title":"Root Type for storage_operation_finance_transaction_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":"Transaction ID"},"date":{"type":"string","format":"date-time"},"type_id":{"type":"number","description":"Transaction type identifier"},"expense_id":{"type":"number","description":"Payment Item ID"},"account_id":{"type":"number","description":"Checkout ID"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"comment":{"type":"string","description":"A comment"},"item_id":{"type":"integer","format":"int32"},"target_type_id":{"type":"integer","format":"int32"},"record_id":{"type":"number","description":"Appointment ID"},"expense":{"type":"object","properties":{"id":{"type":"number","description":"Payment Item ID"},"title":{"type":"string","description":"Name of payment item"}},"description":"Payment item"},"account":{"type":"object","properties":{"id":{"type":"number","description":"Checkout ID"},"title":{"type":"string","description":"Location account name"},"type_id":{"type":"number","description":"Transaction type identifier"},"type":{"type":"number","description":"Transaction type"},"comment":{"type":"string","description":"A comment"},"company_id":{"type":"number","description":"location ID"}},"description":"Location account"},"client":{"type":"object","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Customer phone"}},"description":"Customer"},"master":{"type":"array","description":"team member","items":{"type":"object"}},"supplier":{"type":"array","description":"The supplier","items":{"type":"object"}}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get document financial transactions","example":{"success":true,"data":[{"id":9053737,"date":"2026-09-21T23:00:00.000-05:00","type_id":2640,"expense_id":2640,"account_id":35501,"amount":434,"client_id":4240788,"master_id":0,"supplier_id":0,"comment":"Transaction comment","item_id":0,"target_type_id":0,"record_id":0,"expense":{"id":2640,"title":"Provision of corporate services"},"account":{"id":35501,"title":"Location account","type_id":0,"type":0,"comment":"","company_id":4564},"client":{"id":4240788,"name":"Client","phone":"+13155550175"},"master":[],"supplier":[]},{"id":9053738,"date":"2026-09-21T23:00:00.000-05:00","type_id":2640,"expense_id":2640,"account_id":35501,"amount":434,"client_id":4240788,"master_id":0,"supplier_id":0,"comment":"Transaction comment","item_id":0,"target_type_id":0,"record_id":0,"expense":{"id":2640,"title":"Provision of corporate services"},"account":{"id":35501,"title":"Location account","type_id":0,"type":0,"comment":"","company_id":4564},"client":{"id":4240788,"name":"Client","phone":"+13155550175"},"master":[],"supplier":[]}],"meta":[]}}},"components/schemas/technological_cards_response200_data_types":{"id":"components/schemas/technological_cards_response200_data_types","kind":"json-schema","title":"Root Type for technological_cards_response200_data_types","data":{"title":"Root Type for technological_cards_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array of data objects","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tech ID. cards"},"title":{"type":"string","description":"The name of those cards"},"technological_card_items":{"type":"array","description":"List of consumables kart","items":{"type":"object","properties":{"id":{"type":"number","description":"Consumable ID"},"technological_card_id":{"type":"number","description":"Tech ID. cards"},"storage_id":{"type":"number","description":"Inventory ID"},"good_id":{"type":"number","description":"Item ID"},"amount":{"type":"number","description":"Quantity"},"unit":{"type":"string","description":"unit of measurement"},"price":{"type":"number","description":"Price","format":"double"},"title":{"type":"string","description":"Name"}}}}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of those. kart","example":{"success":true,"data":[{"id":1,"title":"Tech map 1","technological_card_items":[{"id":3,"technological_card_id":1,"storage_id":4234,"good_id":34234,"amount":12,"unit":"l","price":0.0742,"title":"Consumable 3"}]},{"id":2,"title":"Tech map 2","technological_card_items":[{"id":4,"technological_card_id":2,"storage_id":4234,"good_id":34235,"amount":10,"unit":"l","price":0.02412,"title":"Consumable 4"}]}],"meta":[]}}},"components/schemas/technological_cards_consumables_response200_data_types":{"id":"components/schemas/technological_cards_consumables_response200_data_types","kind":"json-schema","title":"Root Type for technological_cards_consumables_response200_data_types","data":{"title":"Root Type for technological_cards_consumables_response200_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":{"service_id":{"type":"number","description":"Service ID"},"record_id":{"type":"number","description":"Appointment ID"},"technological_cards":{"type":"array","description":"Technological cards","items":{"type":"object","properties":{"id":{"type":"number","description":"ID of those cards"},"title":{"type":"string","description":"The name of those cards"},"technological_card_items":{"type":"array","description":"Those consumables cards","items":{"type":"object","properties":{"id":{"type":"number","description":"Consumable ID"},"technological_card_id":{"type":"number","description":"Dash ID"},"storage_id":{"type":"number","description":"Inventory ID"},"good_id":{"type":"number","description":"Item ID"},"amount":{"type":"number","description":"Quantity"},"price":{"type":"number","description":"Price"},"good":{"type":"object","properties":{"id":{"type":"number","description":"Item ID"},"title":{"type":"string","description":"Product Name"},"unit":{"type":"string","description":"unit of measurement"}},"description":"Product"}}}}}}},"consumables":{"type":"array","items":{"type":"object","properties":{"goods_transaction_id":{"type":"number","description":"Commodity transaction ID"},"record_id":{"type":"number","description":"Appointment ID"},"service_id":{"type":"number","description":"Service ID"},"storage_id":{"type":"number","description":"Inventory ID"},"good_id":{"type":"number","description":"Item ID"},"price":{"type":"number","description":"Price"},"amount":{"type":"number","description":"Quantity"},"good":{"type":"object","properties":{"id":{"type":"number","description":"Item ID"},"title":{"type":"string","description":"Product Name"},"unit":{"type":"string","description":"unit of measurement"}},"description":"Product"}}}}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a list of tech cards and appointment consumables","example":{"success":true,"data":[{"service_id":21558,"record_id":1233243,"technological_cards":[{"id":36069,"title":"Tech map","technological_card_items":[{"id":208568,"technological_card_id":36069,"storage_id":91303,"good_id":6858783,"amount":10,"price":1000,"good":{"id":6858783,"title":"Product","unit":"G"}}]}],"consumables":[{"goods_transaction_id":2180771,"record_id":121793129,"service_id":695486,"storage_id":91303,"good_id":6858783,"price":1000,"amount":10,"good":{"id":6858783,"title":"Product","unit":"G"}}]}],"meta":[]}}},"components/schemas/consumables":{"id":"components/schemas/consumables","kind":"json-schema","title":"consumables","data":{"type":"object","properties":{"consumables":{"type":"array","description":"List of consumables","items":{"type":"object","required":["amount","good_id","goods_transaction_id","price","record_id","service_id","storage_id"],"properties":{"goods_transaction_id":{"type":"number","description":"commodity transaction id"},"record_id":{"type":"number","description":"appointment id"},"service_id":{"type":"number","description":"service id"},"storage_id":{"type":"number","description":"inventory id"},"good_id":{"type":"number","description":"product id"},"price":{"type":"number","description":"the cost of the consumable in the appointment"},"amount":{"type":"number","description":"the number of consumables in the appointment"}}}}}}},"components/schemas/technological_cards_consumables_response200_delete_data_types":{"id":"components/schemas/technological_cards_consumables_response200_delete_data_types","kind":"json-schema","title":"Root Type for technological_cards_consumables_response200_delete_data_types","data":{"title":"Root Type for technological_cards_consumables_response200_delete_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array with object","items":{"type":"object","properties":{"service_id":{"type":"number","description":"Service ID"},"record_id":{"type":"number","description":"Appointment ID"},"technological_cards":{"type":"array","description":"Array of technological maps","items":{"type":"object"}},"consumables":{"type":"array","description":"Consumables","items":{"type":"object"}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (empty array0)"}},"description":"Removes a routing from an appointment-service association","example":{"success":true,"data":[{"service_id":7224099,"record_id":310013764,"technological_cards":[],"consumables":[]}],"meta":{"count":1}}}},"components/schemas/company_salon_id_sale_documentid_response_data_types":{"id":"components/schemas/company_salon_id_sale_documentid_response_data_types","kind":"json-schema","title":"Root Type for company_salon_id_sale_documentid_response_data_types","data":{"title":"Root Type for company_salon_id_sale_documentid_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"state":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number","description":"Selling unit ID","format":"int32"},"type":{"type":"string","description":"Type (service/product)"},"title":{"type":"string","description":"Name"},"amount":{"type":"number","description":"Quantity","format":"int32"},"default_cost_per_unit":{"type":"number","description":"Unit price","format":"float"},"default_cost_total":{"type":"number","description":"Total default price","format":"float"},"client_discount_percent":{"type":"number","description":"Discount percentage","format":"float"},"cost_to_pay_total":{"type":"number","description":"Payable price","format":"float"}},"description":"Selling unit"}},"loyalty_transactions":{"type":"array","description":"Loyalty Payment Transaction","items":{"type":"object","properties":{"id":{"type":"integer","description":"Loyalty transaction ID","format":"int32"},"document_id":{"type":"integer","description":"Document ID","format":"int32"},"sale_item_id":{"type":"integer","description":"Sold unit ID","format":"int32"},"sale_item_type":{"type":"string","description":"Unit sold type"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"type_id":{"type":"integer","description":"Transaction type identifier","format":"int32"},"created_at":{"type":"string","description":"date of creation","format":"date-time"},"deposit_transaction_id":{"type":"integer","description":"Transaction ID (depends on type)","format":"int32"},"chain":{"type":"object","properties":{"id":{"type":"integer","description":"Location chain ID","format":"int32"},"title":{"type":"string","description":"Location chain name"}},"description":"Location chain"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Transaction type ID","format":"int32"},"title":{"type":"string","description":"Transaction type name"}},"description":"Transaction type"},"deposit":{"type":"object","properties":{"id":{"type":"integer","description":"Personal account ID","format":"int32"},"balance":{"type":"number","description":"Available personal account balance","format":"double"},"reserved_balance":{"type":"number","description":"Amount currently reserved by active holds","format":"double"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Client account type identifier","format":"int32"},"title":{"type":"string","description":"Name of the client account"}},"description":"Client account type"}},"description":"Withdrawal from personal account"}}}},"payment_transactions":{"type":"array","description":"Cashier payment transaction","items":{"type":"object","properties":{"id":{"type":"integer","description":"Payment transaction ID","format":"int32"},"document_id":{"type":"integer","description":"Document ID","format":"int32"},"sale_item_id":{"type":"integer","description":"Sold unit ID","format":"int32"},"sale_item_type":{"type":"string","description":"Unit sold type"},"expense_id":{"type":"integer","description":"Payment Item ID","format":"int32"},"account_id":{"type":"integer","description":"Checkout ID","format":"int32"},"created_at":{"type":"string","description":"date of creation"},"account":{"type":"object","properties":{"id":{"type":"integer","description":"Checkout ID","format":"int32"},"title":{"type":"string","description":"Location account name"},"is_cash":{"type":"boolean","description":"Is the payment in cash"},"is_default":{"type":"boolean","description":"Is the checkout by default"}},"description":"Location account"},"expense":{"type":"object","properties":{"id":{"type":"integer","description":"Payment Item ID","format":"int32"},"title":{"type":"string","description":"Name of payment item"}},"description":"Payment Article"}}}}}},"kkm_state":{"type":"object","properties":{"last_operation_type":{"type":"integer","description":"Type of last KKM operation","format":"int32"},"transactions":{"type":"array","description":"KKM transaction","items":{"type":"object","properties":{"id":{"type":"integer","description":"KKM transaction ID","format":"int32"},"document_id":{"type":"integer","description":"Document ID","format":"int32"},"print_date":{"type":"string","description":"Check printing date","format":"date-time"},"printed_count":{"type":"integer","format":"int32"},"sum":{"type":"integer","format":"int32"},"type":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"}}},"status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID","format":"int32"},"title":{"type":"string","description":"Status name"}},"description":"Receipt printing status"},"document":{"type":"object","properties":{"id":{"type":"integer","description":"Document ID","format":"int32"},"type":{"type":"integer","description":"Document Type","format":"int32"},"type_title":{"type":"string","description":"Document type name"}}},"cashier":{"type":"object","properties":{"id":{"type":"integer","description":"team member ID","format":"int32"},"name":{"type":"string","description":"team member name"}},"description":"Cashier"}}}}}},"payment_methods":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"is_applicable":{"type":"boolean","description":"Is it possible to use this method"},"applicable_amount":{"type":"number","description":"Possible amount accepted for payment","format":"float"},"applicable_count":{"type":"integer","description":"Possible number of visits (in case of membership)","format":"int32"},"applicable_value":{"type":"number","description":"Applicable bonus (in the case of a loyalty program)","format":"float"},"account_id":{"type":"integer","description":"Checkout ID (depends on slug)","format":"int32"},"account":{"type":"object","properties":{"id":{"type":"integer","description":"Checkout ID","format":"int32"},"title":{"type":"string","description":"Location account name"},"is_cash":{"type":"boolean","description":"Is the location account cash"}},"description":"Location account"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get a sales transaction","example":{"success":true,"data":{"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"chain":{"id":231,"title":"Example chain."},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}}]},"meta":[]}}},"components/schemas/company_salonid_sale_documentid_payment_account":{"id":"components/schemas/company_salonid_sale_documentid_payment_account","kind":"json-schema","title":"Payment at the checkout","data":{"title":"Payment at the checkout","type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"account_id":{"type":"integer","description":"Checkout ID","format":"int32"}},"description":"Payment method"},"amount":{"type":"number","description":"Payment amount","format":"float"}},"description":"Object containing the payment method"}},"description":"Payment at the checkout","example":{"payment":{"method":{"slug":"account","account_id":90218},"amount":123}}}},"components/schemas/company_salonid_sale_documentid_payment_deposit":{"id":"components/schemas/company_salonid_sale_documentid_payment_deposit","kind":"json-schema","title":"Payment via client personal account","data":{"title":"Payment via client personal account","type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"deposit_id":{"type":"integer","description":"Client's personal account ID","format":"int32"}},"description":"Payment method"},"amount":{"type":"number","description":"Payment amount","format":"float"}},"description":"Object containing the payment method"}},"description":"Loyalty payment (various methods)","example":{"payment":{"method":{"slug":"deposit","deposit_id":220},"amount":123}}}},"components/schemas/company_salonid_sale_documentid_payment_certificate":{"id":"components/schemas/company_salonid_sale_documentid_payment_certificate","kind":"json-schema","title":"Payment with a gift card","data":{"title":"Payment with a gift card","type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"loyalty_certificate_id":{"type":"integer","description":"Certificate ID","format":"int32"}},"description":"Payment method"},"amount":{"type":"number","description":"Payment amount","format":"float"},"number":{"type":"string","description":"Certificate code"}},"description":"Object containing the payment method"}},"description":"In the case of payment by a certificate, if the user does not have the \"Pay by certificate and membership without code\" right, the \"number\" (string) parameter containing the certificate code must also be passed in the request body.","example":{"payment":{"method":{"slug":"loyalty_certificate","loyalty_certificate_id":325},"amount":123,"number":123123}}}},"components/schemas/company_salonid_sale_documentid_payment_abonements":{"id":"components/schemas/company_salonid_sale_documentid_payment_abonements","kind":"json-schema","title":"Payment with membership - works only for the visit","data":{"title":"Payment with membership - works only for the visit","type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"loyalty_abonement_id":{"type":"integer","description":"Membership ID","format":"int32"}},"description":"Payment method"},"number":{"type":"string","description":"Subscription code"}},"description":"Object containing the payment method"}},"description":"In the case of payment by membership, if the user does not have the \"Pay by certificate and membership without code\" right, the \"number\" (string) parameter containing the membership code must also be passed in the request body.","example":{"payment":{"method":{"slug":"loyalty_abonement","loyalty_abonement_id":275},"number":123123}}}},"components/schemas/company_salonid_sale_documentid_payment_referal":{"id":"components/schemas/company_salonid_sale_documentid_payment_referal","kind":"json-schema","title":"Pay with referral program - works only for visit","data":{"title":"Pay with referral program - works only for visit","type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"loyalty_program_id":{"type":"integer","description":"Loyalty program ID","format":"int32"}},"description":"Payment method"},"referrer_phone":{"type":"string","description":"Phone of the inviter"}},"description":"Object containing the payment method"}},"description":"Pay with referral program - works only for visit","example":{"payment":{"method":{"slug":"referral_loyalty_program","loyalty_program_id":717},"referrer_phone":"+13155550175"}}}},"components/schemas/company_salonid_sale_documentid_payment_loyalty_card":{"id":"components/schemas/company_salonid_sale_documentid_payment_loyalty_card","kind":"json-schema","title":"Pay with a loyalty card","data":{"title":"Pay with a loyalty card","type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"loyalty_card_id":{"type":"integer","description":"Loyalty card ID","format":"int32"}},"description":"Payment method"},"amount":{"type":"number","description":"Payment amount","format":"float"}},"description":"Object containing the payment method"}},"description":"Pay with a loyalty card","example":{"payment":{"method":{"slug":"loyalty_card","loyalty_card_id":185395},"amount":123}}}},"components/schemas/company_salonid_sale_documentid_payment_loyalty_program":{"id":"components/schemas/company_salonid_sale_documentid_payment_loyalty_program","kind":"json-schema","title":"Pay with a loyalty program","data":{"title":"Pay with a loyalty program","type":"object","properties":{"payment":{"type":"object","properties":{"method":{"type":"object","properties":{"slug":{"type":"string","description":"Payment method type"},"loyalty_program_id":{"type":"integer","description":"Loyalty program ID","format":"int32"},"loyalty_card_id":{"type":"integer","description":"Loyalty card ID","format":"int32"}},"description":"Payment method"}},"description":"Object containing the payment method"}},"description":"Pay with a loyalty program","example":{"payment":{"method":{"slug":"loyalty_program","loyalty_program_id":339,"loyalty_card_id":185395}}}}},"components/schemas/accounts_response_data_types":{"id":"components/schemas/accounts_response_data_types","kind":"json-schema","title":"Root Type for accounts_response_data_types","data":{"title":"Root Type for accounts_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":"Checkout ID"},"title":{"type":"string","description":"Location account name"},"type":{"type":"number","description":"1 - for non-cash payments, 0 for cash"},"comment":{"type":"string","description":"Description for checkout"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get location accounts","example":{"success":true,"data":[{"id":13881,"title":"Main location account","type":0,"comment":"Standing at the reception"},{"id":13882,"title":"Payment account","type":1,"comment":"For non-cash payments"},{"id":21961,"title":"Advances","type":0,"comment":""}],"meta":[]}}},"components/schemas/kkm_transactions_response_data_type":{"id":"components/schemas/kkm_transactions_response_data_type","kind":"json-schema","title":"Root Type for kkm_transactions_response_data_type","data":{"title":"Root Type for kkm_transactions_response_data_type","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":"integer","description":"Transaction ID","format":"int32"},"print_date":{"type":"string","description":"Check printing date","format":"date-time"},"printed_count":{"type":"number","description":"Number of checks printed"},"sum":{"type":"integer","description":"Sum","format":"int32"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Operation type identifier","format":"int32"},"title":{"type":"string","description":"Operation name"}},"description":"Type of transaction"},"status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID","format":"int32"},"title":{"type":"string","description":"Status name"}},"description":"Receipt printing status"},"document":{"type":"object","properties":{"id":{"type":"integer","description":"Document ID","format":"int32"},"type":{"type":"integer","description":"Document type identifier","format":"int32"},"type_title":{"type":"string","description":"The name of the entity to which the document belongs"}},"description":"Transaction document"},"cashier":{"type":"object","properties":{"id":{"type":"integer","description":"team member ID","format":"int32"},"name":{"type":"string","description":"team member name"}},"description":"Cashier"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of transactions found)"}},"description":"Get transactions","example":{"success":true,"data":[{"id":1059,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":1,"sum":10,"type":{"id":1,"title":"Sales return operation"},"status":{"id":3,"title":"Runtime error"},"document":{"id":2045,"type":7,"type_title":"Visit"},"cashier":{"id":746310,"name":"Jack Smith"}}],"meta":{"count":1}}}},"components/schemas/kkm_transactions_print_response_data_type":{"id":"components/schemas/kkm_transactions_print_response_data_type","kind":"json-schema","title":"Root Type for kkm_transactions_print_response_data_type","data":{"title":"Root Type for kkm_transactions_print_response_data_type","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"kkm_type":{"type":"integer","description":"Type of KKM operation","format":"int32"},"kkm_transactions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Transaction ID","format":"int32"},"print_date":{"type":"string","description":"Check printing date","format":"date-time"},"printed_count":{"type":"number","description":"Number of checks printed"},"sum":{"type":"integer","description":"Sum","format":"int32"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Operation type identifier","format":"int32"},"title":{"type":"string","description":"Operation name"}},"description":"Type of transaction"},"status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID","format":"int32"},"title":{"type":"string","description":"Status name"}},"description":"Receipt printing status"},"document":{"type":"object","properties":{"id":{"type":"integer","description":"Document ID","format":"int32"},"type":{"type":"integer","description":"Document type identifier","format":"int32"},"type_title":{"type":"string","description":"The name of the entity to which the document belongs"}},"description":"Transaction document"},"cashier":{"type":"object","properties":{"id":{"type":"integer","description":"team member ID","format":"int32"},"name":{"type":"string","description":"team member name"}},"description":"Cashier"}}}},"status":{"type":"integer","format":"int32"},"bill_json":{"type":"array","items":{"type":"object","properties":{}}}},"description":"Array of objects with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Print receipt","example":{"success":true,"data":{"kkm_type":0,"kkm_transactions":[{"id":1954,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":2,"title":"Sent for printing"},"document":{"id":164,"type":9,"type_title":"Deposit replenishment"},"cashier":{"id":1138453,"name":"Jack Smith"}}],"status":2,"bill_json":[{}]},"meta":[]}}},"components/schemas/transaction_companyid_response_data_types":{"id":"components/schemas/transaction_companyid_response_data_types","kind":"json-schema","title":"Root Type for transaction_companyid_response_data_types","data":{"title":"Root Type for transaction_companyid_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":"Transaction ID"},"document_id":{"type":"number","description":"Document ID"},"expense":{"type":"object","properties":{"id":{"type":"number","description":"Payment type ID"},"title":{"type":"string","description":"Payment type name"}},"description":"Payment type"},"date":{"type":"string","description":"Transaction creation date","format":"date-time"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"comment":{"type":"string","description":"A comment"},"master":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"title":{"type":"string","description":"team member name"}},"description":"Team Member"},"supplier":{"type":"object","properties":{"id":{"type":"number","description":"Supplier ID"},"title":{"type":"string","description":"Counterparty name"}},"description":"counterparty"},"account":{"type":"object","properties":{"id":{"type":"number","description":"Checkout ID"},"title":{"type":"string","description":"Location account name"}},"description":"Location account"},"client":{"type":"object","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Customer phone"}},"description":"Customer"},"last_change_date":{"type":"string","description":"Last modified date","format":"date-time"},"record_id":{"type":"number","description":"Appointment ID"},"visit_id":{"type":"number","description":"Visit ID"},"sold_item_id":{"type":"number","description":"Identifier of the sold product/service"},"sold_item_type":{"type":"number","description":"Sale entity type (product/service)"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get transactions","example":{"success":true,"data":[{"id":4815162342,"document_id":22256641,"expense":{"id":5,"title":"Provision of services"},"date":"2026-04-13T15:34:31-0500","amount":1000,"comment":"Comment","master":{"id":1926,"title":"Sweeney Todd"},"supplier":{"id":1968,"title":"George"},"account":{"id":23182,"title":"Cards"},"client":{"id":481516,"name":"John Turk","phone":13155550176},"last_change_date":"2026-02-01T12:00:00-0500","record_id":308786662,"visit_id":262551993,"sold_item_id":7134634,"sold_item_type":"service"}],"meta":[]}}},"components/schemas/finance_transaction_request_data_types":{"id":"components/schemas/finance_transaction_request_data_types","kind":"json-schema","title":"Root Type for finance_transaction_request_data_types","data":{"title":"Root Type for finance_transaction_request_data_types","type":"object","properties":{"expense_id":{"type":"number","description":"Payment item"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"account_id":{"type":"number","description":"Checkout ID"},"client_id":{"type":"number","description":"Client ID"},"supplier_id":{"type":"number","description":"Supplier ID"},"master_id":{"type":"number","description":"team member ID"},"comment":{"type":"number","description":"A comment"},"date":{"type":"string","description":"Transaction creation date","format":"date-time"}},"description":"Create a Financial Transaction","example":{"expense_id":2640,"amount":100,"account_id":39105,"client_id":4240788,"supplier_id":0,"master_id":0,"comment":"Test transaction comment","date":"2026-08-29T10:00:00-05:00"}}},"components/schemas/finance_transaction_response_data_types":{"id":"components/schemas/finance_transaction_response_data_types","kind":"json-schema","title":"Root Type for finance_transaction_response_data_types","data":{"title":"Root Type for finance_transaction_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"id":{"type":"number","description":"Transaction ID"},"document_id":{"type":"number","description":"Document ID"},"date":{"type":"string","description":"Transaction creation date","format":"date-time"},"type_id":{"type":"number","description":"Payment type ID"},"expense_id":{"type":"number","description":"Payment Item ID"},"account_id":{"type":"number","description":"Checkout ID"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"supplier_id":{"type":"number","description":"Supplier ID"},"comment":{"type":"string","description":"A comment"},"item_id":{"type":"integer","format":"int32"},"target_type_id":{"type":"integer","format":"int32"},"record_id":{"type":"number","description":"Appointment ID"},"goods_transaction_id":{"type":"number","description":"Commodity transaction ID"},"expense":{"type":"object","properties":{"id":{"type":"number","description":"Payment type ID"},"title":{"type":"string","description":"Payment type name"}},"description":"Payment type"},"account":{"type":"object","properties":{"id":{"type":"number","description":"Checkout ID"},"title":{"type":"string","description":"Location account name"},"is_cash":{"type":"boolean","description":"Is cash"},"is_default":{"type":"boolean","description":"Is the checkout by default"}},"description":"Location account"},"client":{"type":"object","properties":{"id":{"type":"number","description":"Client ID"},"name":{"type":"string","description":"Client name"},"phone":{"type":"string","description":"Customer phone"},"email":{"type":"string","description":"Client Email"}},"description":"Customer"},"master":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"team member name"}},"description":"team member"},"supplier":{"type":"array","description":"counterparty","items":{"type":"object"}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create a Financial Transaction","example":{"success":true,"data":{"id":277016617,"document_id":0,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":774020,"amount":100,"client_id":51520012,"master_id":921395,"supplier_id":0,"comment":"Transaction comment","item_id":0,"target_type_id":0,"record_id":0,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":774020,"title":"Archive location account","is_cash":true,"is_default":false},"client":{"id":51520012,"name":"Sweeney Todd","phone":"+13155550175","email":"mail@example.com"},"master":{"id":921395,"name":"Valeria"},"supplier":[]},"meta":[]}}},"components/schemas/sms_clients_by_id_request_data_types":{"id":"components/schemas/sms_clients_by_id_request_data_types","kind":"json-schema","title":"Root Type for sms_clients_by_id_request_data_types","data":{"title":"Root Type for sms_clients_by_id_request_data_types","type":"object","properties":{"client_ids":{"type":"array","description":"Array of client IDs","items":{"type":"number"}},"text":{"type":"string","description":"SMS text message"}},"description":"Send SMS to the list of clients","example":{"client_ids":[1,2,3,4,5],"text":"Dear clients, we congratulate you on being our clients! You are very lucky!"}}},"components/schemas/sms_clients_by_id_response_data_types":{"id":"components/schemas/sms_clients_by_id_response_data_types","kind":"json-schema","title":"Root Type for sms_clients_by_id_response_data_types","data":{"title":"Root Type for sms_clients_by_id_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"null","description":"Always null for this endpoint"},"meta":{"type":"object","properties":{"message":{"type":"string"}},"description":"An object containing a 201 status code message"}},"description":"Send SMS to the list of clients","example":{"success":true,"meta":{"message":"Accepted"}}}},"components/schemas/sms_clients_by_filter_request_data_types":{"id":"components/schemas/sms_clients_by_filter_request_data_types","kind":"json-schema","title":"Root Type for sms_clients_by_filter_request_data_types","data":{"title":"Root Type for sms_clients_by_filter_request_data_types","type":"object","properties":{"text":{"type":"string","description":"SMS text message"}},"description":"Send SMS campaigns to customers matching the filters","example":{"text":"Dear clients, we congratulate you on being our clients! You are very lucky!"}}},"components/schemas/email_clients_by_id_request_data_types":{"id":"components/schemas/email_clients_by_id_request_data_types","kind":"json-schema","title":"Root Type for email_clients_by_id_request_data_types","data":{"title":"Root Type for email_clients_by_id_request_data_types","required":["client_ids","subject","text"],"type":"object","properties":{"client_ids":{"type":"array","description":"Array of client IDs","items":{"type":"number"}},"subject":{"type":"string","description":"Email Subject"},"text":{"type":"string","description":"Email text"}},"description":"Send Email newsletter according to the list of clients","example":{"client_ids":[1,2,3,4,5],"subject":"Important!","text":"Dear clients, we congratulate you on being our clients! You are very lucky!"}}},"components/schemas/email_clients_by_filter_request_data_types":{"id":"components/schemas/email_clients_by_filter_request_data_types","kind":"json-schema","title":"Root Type for email_clients_by_filter_request_data_types","data":{"title":"Root Type for email_clients_by_filter_request_data_types","required":["subject","text"],"type":"object","properties":{"subject":{"type":"string","description":"Email Subject"},"text":{"type":"string","description":"Email text"}},"description":"Send email campaigns for clients matching the filters","example":{"subject":"Important!","text":"Dear clients, we congratulate you on being our clients! You are very lucky!"}}},"components/schemas/delivery_status_request_data_types":{"id":"components/schemas/delivery_status_request_data_types","kind":"json-schema","title":"Root Type for delivery_status_request_data_types","data":{"title":"Root Type for delivery_status_request_data_types","type":"array","description":"Getting message statuses","example":[{"id":"232674","status":1,"payment_sum":0.045,"currency_iso":"EUR","parts_amount":2}],"items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier"},"status":{"type":"number","description":"Message status"},"payment_sum":{"type":"number","description":"Full message cost"},"currency_iso":{"type":"string","description":"Currency ISO"},"parts_amount":{"type":"number","description":"Amount of message's parts"}}}}},"components/schemas/company_get_online_settings_response_data_field_data_types":{"id":"components/schemas/company_get_online_settings_response_data_field_data_types","kind":"json-schema","title":"Root Type for company_get_online_settings_response_data_field_data_types","data":{"title":"Root Type for company_get_online_settings_response_data_field_data_types","required":["activity_online_record_clients_count_max","any_master","confirm_number","seance_delay_step"],"type":"object","properties":{"confirm_number":{"type":"boolean","description":"Confirm customer number via SMS"},"any_master":{"type":"boolean","description":"\"Any team member\" mode"},"seance_delay_step":{"maximum":1380,"minimum":0,"type":"integer","description":"Delay to the next session, in minutes from 0 to 23 hours (inclusive) in increments of 30 minutes"},"activity_online_record_clients_count_max":{"maximum":255,"minimum":1,"type":"integer","description":"Maximum number of seats in one group event"}},"description":"Online booking settings for a location","example":{"confirm_number":false,"any_master":true,"seance_delay_step":90,"activity_online_record_clients_count_max":1}}},"components/schemas/company_get_online_settings_response_data_types":{"id":"components/schemas/company_get_online_settings_response_data_types","kind":"json-schema","title":"Root Type for company_get_online_settings_response_data_types","data":{"title":"Root Type for company_get_online_settings_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"$ref":"#/components/schemas/company_get_online_settings_response_data_field_data_types"},"meta":{"type":"array","description":"metadata","items":{"type":"object"}}},"description":"Getting Online Booking Settings","example":{"success":true,"data":{"confirm_number":false,"any_master":true,"seance_delay_step":90,"activity_online_record_clients_count_max":1},"meta":[]}}},"components/schemas/company_update_online_settings_data_types":{"id":"components/schemas/company_update_online_settings_data_types","kind":"json-schema","title":"Root Type for company_update_online_settings_data_type","data":{"title":"Root Type for company_update_online_settings_data_type","required":["activity_online_record_clients_count_max","any_master","confirm_number","seance_delay_step"],"type":"object","properties":{"confirm_number":{"type":"boolean","description":"Confirm customer number via SMS"},"any_master":{"type":"boolean","description":"\"Any team member\" mode"},"seance_delay_step":{"maximum":1380,"minimum":0,"type":"integer","description":"Delay to the next session, in minutes from 0 to 23 hours (inclusive) in increments of 30 minutes"},"activity_online_record_clients_count_max":{"maximum":255,"minimum":1,"type":"integer","description":"Maximum number of seats in one group event"}},"description":"","example":{"confirm_number":false,"any_master":true,"seance_delay_step":90,"activity_online_record_clients_count_max":1}}},"components/schemas/bookform_settings_response":{"id":"components/schemas/bookform_settings_response","kind":"json-schema","title":"Root Type BookformSettingsResponse","data":{"title":"Root Type BookformSettingsResponse","required":["ab_test_enabled","button_animation","button_color","button_position","datetime_step_num","description","form_position","html_code","id","is_default","master_step_default","master_step_hide","master_step_num","service_step_default","service_step_hide","service_step_num","show_button","title","without_menu"],"type":"object","properties":{"id":{"type":"number","description":"appointment widget ID"},"title":{"type":"string","description":"Name of the appointment widget"},"description":{"type":"string","description":"appointment widget description"},"is_default":{"type":"boolean","description":"Default appointment widget flag"},"without_menu":{"type":"boolean","description":"Step mode flag"},"service_step_default":{"type":"number","description":"Service ID"},"service_step_hide":{"type":"boolean","description":"Service Hiding Flag"},"master_step_default":{"type":"number","description":"team member ID"},"master_step_hide":{"type":"boolean","description":"team member hide flag"},"service_step_num":{"type":"number","description":"Service serial number"},"master_step_num":{"type":"number","description":"Team Member serial number"},"datetime_step_num":{"type":"number","description":"Sequence number of date and time"},"show_button":{"type":"boolean","description":"Button Visibility Step"},"button_position":{"type":"string","description":"Button location on the page"},"form_position":{"type":"string","description":"Panel position on the page"},"button_color":{"type":"string","description":"Button color"},"button_animation":{"type":"boolean","description":"Button animation enable flag"},"html_code":{"type":"string","description":"Code for inserting a button on the site"},"ab_test_enabled":{"type":"boolean","description":"Flag for enabling letterform ab-test"},"is_chain":{"type":"boolean","description":"Chain booking form flag"},"sequence_type":{"type":"string","description":"Sequence type (e.g., \"steps\")"},"service_step_title":{"type":"string","description":"Service step title"},"master_step_title":{"type":"string","description":"Team member step title"},"specialization_display_mode":{"type":"number","description":"Specialization display mode"},"datetime_step_title":{"type":"string","description":"Date/time step title"},"html_code_v2":{"type":"string","description":"Version 2 of HTML code for button insertion"},"map_type":{"type":"number","description":"Map type identifier"},"default_language_id":{"type":"number","description":"Default language ID"},"group_id":{"type":"number","description":"Group ID"},"facebook_pixel_id":{"type":"string","description":"Facebook Pixel ID"},"vk_pixel_id":{"type":"string","description":"VK Pixel ID"},"online_sales_group_id":{"type":"number","description":"Online sales group ID"},"service_step_category_view_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service step category view type (e.g., \"horizontal_tags\")"},"children":[]}]}]}]},"salon_select_type_code":{"type":"string","description":"Location select type code (e.g., \"list\")"},"record_type_id":{"type":["number","null"],"description":"Appointment type ID"},"display_activity_type":{"type":"string","description":"Display event type (e.g., \"all\")"},"is_multiple_activity_record":{"type":"boolean","description":"Multiple event appointment flag"},"activity_record_count":{"type":"number","description":"Event appointment count limit"},"header_images":{"type":["object","null"],"description":"Header images configuration"},"is_weekly_view_enabled":{"type":"boolean","description":"Weekly view enabled flag"},"show_weekly_view_without_online_booking":{"type":"boolean","description":"Show weekly view without online booking flag"},"weekly_view_default_salon_id":{"type":["number","null"],"description":"Default location ID for weekly view"},"personal_subdomain_url":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal subdomain URL for the booking form; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not configured"},"children":[]}]}]}]}},"description":"appointment Widget Settings"}},"components/schemas/booking_form_list_response_data_type":{"id":"components/schemas/booking_form_list_response_data_type","kind":"json-schema","title":"booking_form_list_response_data_type","data":{"required":["data","meta","success"],"type":"object","properties":{"data":{"type":"array","description":"Array of data","items":{"$ref":"#/components/schemas/bookform_settings_response"}},"meta":{"type":"object","description":"Metadata (contains the total count of bookforms)","properties":{"count":{"type":"number","description":"Total count of booking forms"}}},"success":{"type":"boolean","description":"Success status (true)"}},"description":"List of letterforms"}},"components/schemas/bookform_create_request":{"id":"components/schemas/bookform_create_request","kind":"json-schema","title":"Root Type BookformCreateRequest","data":{"title":"Root Type BookformCreateRequest","required":["title"],"type":"object","properties":{"title":{"type":"string","description":"Name of the appointment widget"},"description":{"type":"string","description":"appointment widget description","default":""},"is_default":{"type":"boolean","description":"Default appointment widget flag","default":false},"without_menu":{"type":"boolean","description":"Step mode flag","default":false},"service_step_default":{"type":"number","description":"Service ID"},"service_step_hide":{"type":"boolean","description":"Service Hiding Flag","default":false},"master_step_default":{"type":"number","description":"team member ID"},"master_step_hide":{"type":"boolean","description":"team member hide flag","default":false},"service_step_num":{"type":"number","description":"Service step sequence number"},"master_step_num":{"type":"number","description":"Sequence number of the wizard step"},"datetime_step_num":{"type":"number","description":"Sequence number of the date and time step"},"show_button":{"type":"boolean","description":"Button visibility flag","default":true},"button_position":{"type":"string","description":"Button location on the page","default":"bottom right","enum":["bottom right","bottom left","top right","top left "]},"form_position":{"type":"string","description":"Panel position on the page","default":"right","enum":["right","left"]},"button_color":{"type":"string","description":"Button color","default":"#1c84c6"},"button_animation":{"type":"boolean","description":"Button animation enable flag","default":true}},"description":"Request to create a letterform"}},"components/schemas/booking_form_response_data_type":{"id":"components/schemas/booking_form_response_data_type","kind":"json-schema","title":"booking_form_response_data_type","data":{"required":["data","meta","success"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/bookform_settings_response"},"meta":{"type":"array","description":"Metadata","items":{"type":"object"}},"success":{"type":"boolean","description":"Success status (true)"}},"description":"appointment Widget Settings"}},"components/schemas/bookform_update_request":{"id":"components/schemas/bookform_update_request","kind":"json-schema","title":"Root Type for BookformUpdateRequest","data":{"title":"Root Type for BookformUpdateRequest","required":["button_animation","button_color","button_position","datetime_step_num","description","form_position","is_default","master_step_default","master_step_hide","master_step_num","service_step_default","service_step_hide","service_step_num","show_button","title","without_menu"],"type":"object","properties":{"title":{"type":"string","description":"Name of the appointment widget"},"description":{"type":"string","description":"appointment widget description"},"is_default":{"type":"boolean","description":"Default appointment widget flag"},"without_menu":{"type":"boolean","description":"Step mode flag"},"service_step_default":{"type":"number","description":"Service ID"},"service_step_hide":{"type":"boolean","description":"Service Hiding Flag"},"master_step_default":{"type":"number","description":"team member ID"},"master_step_hide":{"type":"boolean","description":"team member hide flag"},"service_step_num":{"type":"number","description":"Service step sequence number"},"master_step_num":{"type":"number","description":"Sequence number of the wizard step"},"datetime_step_num":{"type":"number","description":"Sequence number of the date and time step"},"show_button":{"type":"boolean","description":"Button Visibility Step"},"button_position":{"type":"string","description":"Button location on the page","enum":["bottom right","bottom left","top right","top left"]},"form_position":{"type":"string","description":"Panel position on the page","enum":["right","left"]},"button_color":{"type":"string","description":"Button color"},"button_animation":{"type":"boolean","description":"Button animation enable flag"}},"description":"Request to change the letterform"}},"components/schemas/currency":{"id":"components/schemas/currency","kind":"json-schema","title":"Root Type for Currency","data":{"title":"Root Type for Currency","type":"object","properties":{"id":{"type":"integer","description":"Currency identifier","format":"int32"},"iso":{"maxLength":3,"minLength":3,"type":"string","description":"Three-letter currency code according to ISO 4217"},"name":{"type":"string","description":"Currency name"},"symbol":{"type":"string","description":"Currency symbol next to the amount"},"is_symbol_after_amount":{"type":"boolean","description":"Flag where to display the currency symbol relative to the amount (true - after the amount, false - before)"}},"description":"Currency","example":{"id":2,"iso":"USD","name":"US Dollar","symbol":"$","is_symbol_after_amount":false}}},"components/schemas/analytics_report_overall_sum_stats":{"id":"components/schemas/analytics_report_overall_sum_stats","kind":"json-schema","title":"Root Type for AnalyticsReportOverallSumStats","data":{"title":"Root Type for AnalyticsReportOverallSumStats","type":"object","properties":{"current_sum":{"type":"string","description":"The current value of the indicator"},"previous_sum":{"type":"string","description":"The value of the indicator in the previous period"},"change_percent":{"type":"integer","description":"The percentage change in the current value of the indicator relative to the past. Null if the previous value is 0 and the current value is not 0.","format":"int32"},"currency":{"$ref":"#/components/schemas/currency"}},"description":"","example":{"current_sum":12.56,"previous_sum":10.34,"change_percent":21,"currency":{"symbol":"USD"}}}},"components/schemas/analytics_report_overall_fullness_stats":{"id":"components/schemas/analytics_report_overall_fullness_stats","kind":"json-schema","title":"Root Type for AnalyticsReportOverallFullnessStats","data":{"title":"Root Type for AnalyticsReportOverallFullnessStats","type":"object","properties":{"current_percent":{"type":"number","description":"Percentage of occupancy in the current period","format":"double"},"previous_percent":{"type":"number","description":"Percentage of occupancy in the previous period","format":"double"},"change_percent":{"type":"integer","description":"The percentage change in the current value of the indicator relative to the past. Null if the previous value is 0 and the current value is not 0.","format":"int32"}},"description":"Summary indicators of the occupancy of the working hours of the location's team members","example":{"current_percent":12.1,"previous_percent":10.2,"change_percent":18}}},"components/schemas/analytics_report_overall_record_stats":{"id":"components/schemas/analytics_report_overall_record_stats","kind":"json-schema","title":"Root Type for AnalyticsReportOverallRecordStats","data":{"title":"Root Type for AnalyticsReportOverallRecordStats","type":"object","properties":{"current_completed_count":{"type":"integer","description":"Number of completed appointments","format":"int32"},"current_completed_percent":{"type":"integer","description":"Percentage of completed appointments relative to the total. Null if the total is 0.","format":"int32"},"current_pending_count":{"type":"integer","description":"Number of pending appointments","format":"int32"},"current_pending_percent":{"type":"integer","description":"Percentage of incomplete records relative to the total. Null if the total is 0.","format":"int32"},"current_canceled_count":{"type":"integer","description":"Number of canceled appointments","format":"int32"},"current_canceled_percent":{"type":"integer","description":"The percentage of canceled appointments relative to the total. Null if the total is 0.","format":"int32"},"current_total_count":{"type":"integer","description":"Number of all appointments in the current period","format":"int32"},"previous_total_count":{"type":"integer","description":"Number of all appointments in the previous period","format":"int32"},"change_percent":{"type":"integer","description":"The percentage change in the current value of the total number of records relative to the past. Null if the number of records in the previous period is 0 and the current number is different from 0.","format":"int32"}},"description":"Summary metrics by number of appointments","example":{"current_completed_count":150,"current_completed_percent":75,"current_pending_count":30,"current_pending_percent":15,"current_canceled_count":20,"current_canceled_percent":10,"current_total_count":200,"previous_total_count":180,"change_percent":11}}},"components/schemas/analytics_report_overall_client_stats":{"id":"components/schemas/analytics_report_overall_client_stats","kind":"json-schema","title":"Root Type for AnalyticsReportOverallClientStats","data":{"title":"Root Type for AnalyticsReportOverallClientStats","type":"object","properties":{"total_count":{"type":"integer","description":"Total number of clients","format":"int32"},"new_count":{"type":"integer","description":"Number of new clients in the analyzed period","format":"int32"},"new_percent":{"type":"integer","description":"Percentage of new customers relative to the number of active customers","format":"int32"},"return_count":{"type":"integer","description":"The number of customers who returned in the analyzed period","format":"int32"},"return_percent":{"type":"integer","description":"Percentage of returning customers relative to the number of active customers","format":"int32"},"active_count":{"type":"integer","description":"Number of active clients in the analyzed period","format":"int32"},"lost_count":{"type":"integer","description":"The number of lost customers in the analyzed period","format":"int32"},"lost_percent":{"type":"integer","description":"The percentage of lost customers relative to the total number of customers","format":"int32"}},"description":"Summary indicators by number of clients","example":{"total_count":1000,"new_count":50,"new_percent":10,"return_count":450,"return_percent":90,"active_count":500,"lost_count":20,"lost_percent":2}}},"components/schemas/analytics_report_overall_stats":{"id":"components/schemas/analytics_report_overall_stats","kind":"json-schema","title":"analytics_report_overall_stats","data":{"type":"object","properties":{"income_total_stats":{"$ref":"#/components/schemas/analytics_report_overall_sum_stats"},"income_services_stats":{"$ref":"#/components/schemas/analytics_report_overall_sum_stats"},"income_goods_stats":{"$ref":"#/components/schemas/analytics_report_overall_sum_stats"},"income_average_stats":{"$ref":"#/components/schemas/analytics_report_overall_sum_stats"},"income_average_services_stats":{"$ref":"#/components/schemas/analytics_report_overall_sum_stats"},"fullness_stats":{"$ref":"#/components/schemas/analytics_report_overall_fullness_stats"},"record_stats":{"$ref":"#/components/schemas/analytics_report_overall_record_stats"},"client_stats":{"$ref":"#/components/schemas/analytics_report_overall_client_stats"}},"description":"Summary indicators"}},"components/schemas/company_analytics_overall_data_type":{"id":"components/schemas/company_analytics_overall_data_type","kind":"json-schema","title":"company_analytics_overall_data_type","data":{"required":["data","meta","success"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/analytics_report_overall_stats"},"meta":{"type":"array","description":"metadata","items":{"type":"object"}},"success":{"type":"boolean","description":"Execution success status (true)"}},"description":""}},"components/schemas/analytics_report_overall_chart_daily_row_item":{"id":"components/schemas/analytics_report_overall_chart_daily_row_item","kind":"json-schema","title":"analytics_report_overall_chart_daily_row_item","data":{"type":"array","description":"Data for one day. The first element is the timestamp of the beginning of the day in the UTC zone, the second element is the value of the indicator on that day.","example":["2026-09-21T23:00:00.000-05:00",1000],"items":{"type":"integer","format":"int32"}}},"components/schemas/analytics_report_overall_chart_daily_row":{"id":"components/schemas/analytics_report_overall_chart_daily_row","kind":"json-schema","title":"Root Type for AnalyticsReportOverallChartRow","data":{"title":"Root Type for AnalyticsReportOverallChartRow","type":"object","properties":{"label":{"type":"string","description":"Name of data series"},"data":{"type":"array","description":"Data for each day. Each day is an array of two numbers. The first number is the timestamp of the beginning of the day in the UTC zone, the second number is the value of the indicator on that day.","items":{"$ref":"#/components/schemas/analytics_report_overall_chart_daily_row_item"}}},"description":"Data for plotting a chart by day in the Key Indicators report","example":{"label":"Revenue","data":[["2026-09-21T23:00:00.000-05:00",1000],["2026-09-21T23:00:00.000-05:00",500]]}}},"components/schemas/analytics_report_overall_chart_scalar_item":{"id":"components/schemas/analytics_report_overall_chart_scalar_item","kind":"json-schema","title":"Root Type for AnalyticsReportOverallChartRow","data":{"title":"Root Type for AnalyticsReportOverallChartRow","type":"object","properties":{"label":{"type":"string","description":"Name of indicator"},"data":{"type":"integer","description":"Indicator value"}},"description":"Data for building an aggregate chart in the Key indicators report"}},"components/schemas/company_analytics_loyalty_programs_income_data_types":{"id":"components/schemas/company_analytics_loyalty_programs_income_data_types","kind":"json-schema","title":"Root Type for company_analytics_loyalty_programs_income_data_types","data":{"title":"Root Type for company_analytics_loyalty_programs_income_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"object","properties":{"income_stats":{"type":"object","properties":{"new":{"type":"object","properties":{"all_sum":{"type":"integer","description":"Revenue from new customers","format":"int32"},"returned_sum":{"type":"integer","description":"Revenue from returning customers","format":"int32"}},"description":"New clients"},"old":{"type":"object","properties":{"all_sum":{"type":"integer","description":"Revenue from old customers","format":"int32"},"returned_sum":{"type":"integer","description":"Revenue from returning customers","format":"int32"}},"description":"Old clients"},"total":{"type":"object","properties":{"all_sum":{"type":"integer","description":"Revenue for all customers","format":"int32"},"returned_sum":{"type":"integer","description":"Revenue from returning customers","format":"int32"}},"description":"Total amount"}},"description":"revenue statistics"},"currency":{"type":"object","properties":{"id":{"type":"integer","description":"Currency identifier","format":"int32"},"iso":{"type":"string","description":"Name in the ISO system"},"name":{"type":"string","description":"Full title"},"symbol":{"type":"string","description":"Currency symbol"},"is_symbol_after_amount":{"type":"boolean"}},"description":"Currency"},"income_stats_by_day":{"type":"array","description":"Revenue statistics by day","items":{"type":"object","properties":{"date":{"type":"string","description":"date","format":"date"},"new_sum":{"type":"integer","description":"Revenue from new customers","format":"int32"},"old_sum":{"type":"integer","description":"Revenue from old customers","format":"int32"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"revenue statistics","example":{"success":true,"data":{"income_stats":{"new":{"all_sum":0,"returned_sum":0},"old":{"all_sum":0,"returned_sum":0},"total":{"all_sum":0,"returned_sum":0}},"currency":{"id":1,"iso":"USD","name":"US Dollar","symbol":"USD","is_symbol_after_amount":true},"income_stats_by_day":[{"date":"2026-09-21","new_sum":0,"old_sum":0},{"date":"2026-09-21","new_sum":0,"old_sum":0}]},"meta":[]}}},"components/schemas/company_analytics_loyalty_programs_staff_data_types":{"id":"components/schemas/company_analytics_loyalty_programs_staff_data_types","kind":"json-schema","title":"Root Type for company_analytics_loyalty_programs_staff_data_types","data":{"title":"Root Type for company_analytics_loyalty_programs_staff_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"array","description":"Array with data objects","items":{"type":"object","properties":{"client_stats":{"type":"object","properties":{"all_count":{"type":"integer","description":"Number of all clients","format":"int32"},"lost_count":{"type":"integer","description":"Number of lost customers","format":"int32"},"returned_count":{"type":"integer","description":"Number of returning customers","format":"int32"},"returned_percent":{"type":"number","description":"Percentage of returning customers","format":"float"}},"description":"Client statistics"},"staff":{"type":"object","properties":{"id":{"type":"integer","description":"team member ID","format":"int32"},"name":{"type":"string","description":"team member name"}},"description":"team member"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of objects found)"}},"description":"Get team member turnover data.","example":{"success":true,"data":[{"client_stats":{"all_count":1,"lost_count":0,"returned_count":1,"returned_percent":100},"staff":{"id":1140369,"name":"Doniella Davy"}}],"meta":{"count":1}}}},"components/schemas/company_analytics_loyalty_programs_visits_data_types":{"id":"components/schemas/company_analytics_loyalty_programs_visits_data_types","kind":"json-schema","title":"Root Type for company_analytics_loyalty_programs_visits_data_types","data":{"title":"Root Type for company_analytics_loyalty_programs_visits_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"object","properties":{"client_stats":{"type":"object","properties":{"new":{"type":"object","properties":{"all_count":{"type":"integer","description":"Total","format":"int32"},"lost_count":{"type":"integer","description":"Lost Clients","format":"int32"},"returned_count":{"type":"integer","description":"Returning clients","format":"int32"},"returned_percent":{"type":"number","description":"Percentage of returning customers","format":"float"}},"description":"New clients"},"old":{"type":"object","properties":{"all_count":{"type":"integer","description":"Total","format":"int32"},"lost_count":{"type":"integer","description":"Lost Clients","format":"int32"},"returned_count":{"type":"integer","description":"Returning clients","format":"int32"},"returned_percent":{"type":"number","description":"Percentage of returning customers","format":"float"}},"description":"Old clients"},"total":{"type":"object","properties":{"all_count":{"type":"integer","description":"Total","format":"int32"},"lost_count":{"type":"integer","description":"Lost Clients","format":"int32"},"returned_count":{"type":"integer","description":"Returning clients","format":"int32"},"returned_percent":{"type":"number","description":"Percentage of returning customers","format":"float"}},"description":"Total Quantity"}},"description":"Client statistics"},"visits_stats_by_day":{"type":"array","description":"Number of clients per day","items":{"type":"object","properties":{"date":{"type":"string","description":"date","format":"date"},"new_count":{"type":"integer","description":"Number of new clients","format":"int32"},"old_count":{"type":"integer","description":"Number of old clients","format":"int32"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get customer statistics","example":{"success":true,"data":{"client_stats":{"new":{"all_count":0,"lost_count":0,"returned_count":0,"returned_percent":0},"old":{"all_count":0,"lost_count":0,"returned_count":0,"returned_percent":0},"total":{"all_count":0,"lost_count":0,"returned_count":0,"returned_percent":0}},"visits_stats_by_day":[{"date":"2026-09-21","new_count":0,"old_count":0},{"date":"2026-09-21","new_count":0,"old_count":0}]},"meta":[]}}},"components/schemas/z_report_response_data_types":{"id":"components/schemas/z_report_response_data_types","kind":"json-schema","title":"Root Type for z_report_response_data_types","data":{"title":"Root Type for z_report_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"stats":{"type":"object","properties":{"clients":{"type":"integer","description":"Number of clients","format":"int32"},"clients_average":{"type":"number","description":"Average payment per customer","format":"double"},"records":{"type":"integer","description":"Number of records","format":"int32"},"records_average":{"type":"number","description":"Average pay per appointment","format":"double"},"visit_records":{"type":"integer","description":"Number of records with clients","format":"int32"},"visit_records_average":{"type":"number","description":"Average payment for records with clients","format":"double"},"non_visit_records":{"type":"integer","description":"Number of appointments without clients","format":"int32"},"non_visit_records_average":{"type":"integer","description":"Average billing for records without clients","format":"int32"},"targets":{"type":"integer","description":"Number of services","format":"int32"},"targets_paid":{"type":"integer","description":"Payment for services","format":"int32"},"goods":{"type":"integer","description":"Number of products","format":"int32"},"goods_paid":{"type":"number","description":"Payment by products","format":"double"},"certificates":{"type":"integer","description":"Number of certificates","format":"int32"},"certificates_paid":{"type":"integer","description":"Payment for certificates","format":"int32"},"abonement":{"type":"integer","description":"Number of subscriptions","format":"int32"},"abonement_paid":{"type":"integer","description":"Subscription payment","format":"int32"}},"description":"general Statistics"},"paids":{"type":"object","properties":{"accounts":{"type":"array","description":"Payments at the box office","items":{"type":"object","properties":{"title":{"type":"string","description":"Location account name"},"amount":{"type":"integer","description":"Sum","format":"int32"}}}},"discount":{"type":"array","description":"Payment by discount and loyalty","items":{"type":"object","properties":{"title":{"type":"string","description":"Discount/promotion name"},"amount":{"type":"number","description":"Sum","format":"double"}}}},"total":{"type":"object","properties":{"accounts":{"type":"number","description":"Amounts for all location accounts","format":"double"},"discount":{"type":"number","description":"Amount paid by all loyalty","format":"double"}},"description":"Outcome"}},"description":"Payments"},"z_data":{"type":"object","properties":{"1481101200":{"type":"array","items":{"type":"object","properties":{"client_id":{"type":"number","description":"Client ID"},"client_name":{"type":"string","description":"Client name"},"client_phone":{"type":"string","description":"Customer phone"},"client_email":{"type":"string","description":"Client's email address"},"masters":{"type":"array","description":"team members","items":{"type":"object","properties":{"master_id":{"type":"number","description":"team member ID"},"master_name":{"type":"string","description":"team member name"},"service":{"type":"array","description":"Services","items":{"type":"object","properties":{"item_title":{"type":"string","description":"Service name"},"first_cost":{"type":"number","description":"Initial cost","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"result_cost":{"type":"number","description":"the total cost","format":"float"},"transactions":{"type":"array","description":"Transactions","items":{"type":"object","properties":{"accounts_amount":{"type":"number","description":"Amount paid to the location account","format":"float"},"loyalty_amount":{"type":"number","description":"Amount paid by loyalty","format":"float"},"payment_type":{"type":"string","description":"Payment type"}}}}}}},"good":{"type":"array","description":"Products","items":{"type":"object","properties":{"item_title":{"type":"string","description":"Product Name"},"first_cost":{"type":"number","description":"Initial cost","format":"float"},"discount":{"type":"number","description":"Discount","format":"double"},"result_cost":{"type":"number","description":"the total cost","format":"double"},"transactions":{"type":"array","description":"Transactions","items":{"type":"object","properties":{"accounts_amount":{"type":"number","description":"Amount paid to the location account","format":"double"},"loyalty_amount":{"type":"integer","description":"Amount paid by loyalty","format":"int32"},"payment_type":{"type":"string","description":"Payment type"}}}}}}},"others":{"type":"object","properties":{"item_title":{"type":"string","description":"Product/service name"},"first_cost":{"type":"number","description":"Initial cost","format":"float"},"discount":{"type":"number","description":"Discount","format":"double"},"result_cost":{"type":"number","description":"the total cost","format":"double"},"transactions":{"type":"array","description":"Transactions","items":{"type":"object","properties":{"accounts_amount":{"type":"number","description":"Amount paid to the location account","format":"double"},"loyalty_amount":{"type":"integer","description":"Amount paid by loyalty","format":"int32"},"payment_type":{"type":"string","description":"Payment type"}}}}}}}}}}}}},"description":"Data report"},"currency":{"type":"string","description":"Currency"}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get Z-Report data","example":{"success":true,"data":{"stats":{"clients":7,"clients_average":123.45,"records":14,"records_average":4231.51,"visit_records":13,"visit_records_average":100500.01,"non_visit_records":1,"non_visit_records_average":200,"targets":14,"targets_paid":10255,"goods":4,"goods_paid":12452.18,"certificates":1,"certificates_paid":9876,"abonement":0,"abonement_paid":0},"paids":{"accounts":[{"title":"Cards","amount":6987},{"title":"Cash","amount":54321.13},{"title":"Location account","amount":12531}],"discount":[{"title":"Advance Discount","amount":1816.875},{"title":"Written off bonuses","amount":800},{"title":"Promotion Discount","amount":123}],"total":{"accounts":2657.13,"discount":1241.875}},"z_data":{"1481101200":[{"client_id":11223344,"client_name":"John Smith","client_phone":"+13155550175","client_email":"","masters":[{"master_id":321123,"master_name":"Robert Brown","service":[{"item_title":"Highlighting from 9 strands","first_cost":3500,"discount":0,"result_cost":3500,"transactions":[{"accounts_amount":0,"loyalty_amount":700,"payment_type":"Card: Gold Card"},{"accounts_amount":0,"loyalty_amount":100,"payment_type":"Card: Gold Card"},{"accounts_amount":0,"loyalty_amount":1,"payment_type":"Card: Bonus card"}]}],"good":[{"item_title":"Spray For Hair","first_cost":15,"discount":2.25,"result_cost":12.75,"transactions":[{"accounts_amount":12.75,"loyalty_amount":0,"payment_type":"Cash"}]}],"others":{"item_title":"Other operations","first_cost":347,"discount":0,"result_cost":347,"transactions":[{"accounts_amount":23,"loyalty_amount":0,"payment_type":"Cash"},{"accounts_amount":324,"loyalty_amount":0,"payment_type":"Cash"}]}}]}]},"currency":"USD"},"meta":[]}}},"components/schemas/tags_create_response200_data_types":{"id":"components/schemas/tags_create_response200_data_types","kind":"json-schema","title":"Root Type for tags_create_response200_data_types","data":{"title":"Root Type for tags_create_response200_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"title":{"type":"string","description":"name of tag"},"salon_id":{"type":"number","description":"ID of the location that the tag belongs to"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag color in #RRGGBB format"},"children":[]}]}]}]},"entity":{"type":"number","description":"Tag type (1 - tag for customers, 2 - tag for appointments)"},"id":{"type":"integer","description":"Tag ID"}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Create a tag","example":{"success":true,"data":{"title":"test","salon_id":68570,"color":"#00ff11","entity":1,"id":3599560},"meta":[]}}},"components/schemas/tags_company_entity_response200_data_types":{"id":"components/schemas/tags_company_entity_response200_data_types","kind":"json-schema","title":"Root Type for tags_company_entity","data":{"title":"Root Type for tags_company_entity","type":"object","description":"Get location tags by entity type","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"array","description":"Array of tag objects","items":{"type":"object","properties":{"id":{"type":"string","description":"Tag ID"},"salon_id":{"type":"string","description":"Location ID"},"title":{"type":"string","description":"Tag name"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag color in #RRGGBB format"},"children":[]}]}]}]},"icon":{"type":"string","description":"Icon name"},"slug":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag slug; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not set"},"children":[]}]}]}]},"entity":{"type":"string","description":"Tag type (1 - client, 2 - appointment, 3 - event)"},"deleted":{"type":"string","description":"Delete mark (0 - active, 1 - deleted)"},"not_editable":{"type":"string","description":"Whether tag changes are allowed (0 - allowed, 1 - not allowed)"},"font_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Font color in #RRGGBB format"},"children":[]}]}]}]}}}},"meta":{"type":"array","description":"Metadata (empty array)"}},"example":{"success":true,"data":[{"id":241625,"salon_id":68570,"title":"VIP client","color":"#ff2828","icon":"star","entity":1,"deleted":0,"not_editable":0},{"id":241626,"salon_id":68570,"title":"Regular client","color":"#009800","icon":"user","entity":1,"deleted":0,"not_editable":0}],"meta":[]}}},"components/schemas/tags_update_request_data_types":{"id":"components/schemas/tags_update_request_data_types","kind":"json-schema","title":"Root Type for tags_update_request_data_types","data":{"title":"Root Type for tags_update_request_data_types","type":"object","properties":{"title":{"type":"string","description":"name of tag"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag color in #RRGGBB format"},"children":[]}]}]}]},"entity":{"type":"number","description":"Tag type (1 - tag for customers, 2 - tag for appointments)"},"icon":{"type":"string","description":"Icon name"}},"description":"Update Tag","example":{"title":"Testway2","color":"#aa11ff","entity":2,"icon":"Test"}}},"components/schemas/deposit_operation_response_data_types":{"id":"components/schemas/deposit_operation_response_data_types","kind":"json-schema","title":"Root Type for deposit_operation_response_data_types","data":{"title":"Root Type for deposit_operation_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"document":{"type":"object","properties":{"id":{"type":"number","description":"Document ID"},"user_id":{"type":"number","description":"User ID"},"salon_id":{"type":"number","description":"location ID"},"type_id":{"type":"number","description":"Document type identifier"},"type":{"type":"object","properties":{"id":{"type":"number","description":"Document type identifier"},"title":{"type":"string","description":"Document type name"}},"description":"Document Type"},"comment":{"type":"string","description":"A comment"},"number":{"type":"number","description":"Document Number"},"salon":{"type":"object","properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"public_title":{"type":"string","description":"location name for display on external resources"},"business_group_id":{"type":"number","description":"Business group ID"},"business_type_id":{"type":"number","description":"Business type ID"},"country_id":{"type":"number","description":"Identifier of the country in which the location is located"},"city_id":{"type":"number","description":"City ID where the location is located"},"timezone":{"type":"number","description":"location time zone"},"timezone_name":{"type":"string","description":"Time zone name"},"address":{"type":"string","description":"Address where the location is located"},"coordinate_lat":{"type":"number","description":"Latitude","format":"double"},"coordinate_lon":{"type":"number","description":"Longitude","format":"double"},"logo":{"type":"string","description":"The path to the image with the location logo"},"zip":{"type":"string","description":"Postcode"},"phone":{"type":"string","description":"Telephong"},"phones":{"type":"array","description":"Phones","items":{"type":"string"}},"site":{"type":"string","description":"The site of the location"},"allow_delete_record":{"type":"boolean","description":"Is it possible to delete an appointment"},"allow_change_record":{"type":"boolean","description":"Is it possible to change the appointment"}}},"user":{"type":"object","properties":{"id":{"type":"number","description":"User ID"},"name":{"type":"string","description":"Username"},"phone":{"type":"string","description":"User phone"}},"description":"User"}}},"deposits_transactions":{"type":"array","description":"Client account transaction","items":{"type":"object","properties":{"id":{"type":"number","description":"Client account transaction ID"},"salon_id":{"type":"number","description":"location ID"},"salon_group_id":{"type":"number","description":"Chain ID"},"document_id":{"type":"number","description":"Document ID"},"deposit_id":{"type":"number","description":"Personal account ID"},"deposit_type_id":{"type":"number","description":"Personal account type identifier"},"master_id":{"type":"number","description":"team member ID"},"user_id":{"type":"number","description":"User ID"},"amount":{"type":"number","description":"Top-up amount","format":"double"},"balance_after":{"type":"number","description":"Personal account balance after this transaction","format":"double"},"reserved_balance_after":{"type":"number","description":"Personal account reserved balance after this transaction","format":"double"},"comment":{"type":"string","description":"A comment"},"date_create":{"type":"string","description":"date of creation"},"deleted":{"type":"boolean","description":"Has the transaction been deleted?"},"date_delete":{"type":"string","description":"Deletion date"},"deposit":{"type":"object","properties":{"id":{"type":"integer","description":"Personal account ID"},"deposit_type_id":{"type":"integer","description":"Personal account type identifier"},"salon_group_id":{"type":"integer","description":"Chain ID"},"initial_balance":{"type":"number","description":"Starting balance","format":"double"},"balance":{"type":"number","description":"Available balance (current balance minus reserved balance)","format":"double"},"reserved_balance":{"type":"number","description":"Amount currently reserved by active holds","format":"double"},"blocked":{"type":"boolean","description":"Is the personal account blocked"},"date_create":{"type":"string","description":"date of creation"}},"description":"Personal account"},"deposit_type":{"type":"object","properties":{"id":{"type":"number","description":"Personal account type identifier"},"salon_group_id":{"type":"number","description":"Chain ID"},"title":{"type":"string","description":"Name of personal account type"},"date_create":{"type":"string","description":"date of creation"},"deleted":{"type":"boolean","description":"Has the personal account type been removed?"},"date_delete":{"type":"string","description":"Deletion date"}},"description":"Type of personal account"}}}},"payment_transactions":{"type":"array","description":"Payment transaction","items":{"type":"object","properties":{"id":{"type":"number","description":"Payment transaction ID"},"document_id":{"type":"integer","description":"Document ID"},"date":{"type":"string","description":"date of payment","format":"date-time"},"type_id":{"type":"number","description":"Document type identifier"},"expense_id":{"type":"number","description":"Payment Item ID"},"account_id":{"type":"number","description":"Checkout ID"},"amount":{"type":"number","description":"Transaction amount","format":"double"},"client_id":{"type":"number","description":"Client ID"},"master_id":{"type":"number","description":"team member ID"},"supplier_id":{"type":"number","description":"Vendor ID"},"comment":{"type":"string","description":"A comment"},"item_id":{"type":"integer","format":"int32"},"target_type_id":{"type":"integer","format":"int32"},"record_id":{"type":"integer","description":"Appointment ID"},"goods_transaction_id":{"type":"integer","description":"Commodity transaction ID"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Transaction type identifier"},"title":{"type":"string","description":"Transaction name"}}}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Creating a personal account replenishment operation","example":{"success":true,"data":{"document":{"id":1,"user_id":1,"salon_id":1,"type_id":9,"type":{"id":9,"title":"Account replenishment (advance payment)"},"comment":"","number":1,"salon":{"id":1,"title":"Location in New York","public_title":"Location in New York","business_group_id":1,"business_type_id":1,"country_id":7,"city_id":2,"timezone":"-5","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"http://app.alteg.io/images/icon.png","zip":"129090","phone":"+13155550175","phones":[],"site":"www.example.com","allow_delete_record":true,"allow_change_record":true},"user":{"id":1,"name":"James Smith","phone":"+13155550175"}},"deposits_transactions":[{"id":1,"salon_id":1,"salon_group_id":1,"document_id":1,"deposit_id":1,"deposit_type_id":1,"master_id":1,"user_id":1,"amount":100.5,"balance_after":12239.56,"reserved_balance_after":0,"comment":"","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false,"deposit":{"id":1,"deposit_type_id":1,"salon_group_id":1,"initial_balance":10000,"balance":12239.56,"reserved_balance":0,"blocked":false,"date_create":"2026-09-21T23:00:00.000-05:00"},"deposit_type":{"id":1,"salon_group_id":1,"title":"Account type 1","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false}}],"payment_transactions":[{"id":1,"document_id":1,"date":"2026-09-21T23:00:00.000-05:00","type_id":10,"expense_id":10,"account_id":1,"amount":100.5,"client_id":1,"master_id":1,"supplier_id":0,"comment":"","item_id":1,"target_type_id":0,"record_id":0,"goods_transaction_id":0,"type":{"id":10,"title":"Refill"}}]},"meta":[]}}},"components/schemas/loyalty_cards_response_data_types":{"id":"components/schemas/loyalty_cards_response_data_types","kind":"json-schema","title":"Root Type for loyalty_cards_response_data_types","data":{"title":"Root Type for loyalty_cards_response_data_types","type":"object","properties":{"id":{"type":"integer","description":"Loyalty card ID","format":"int32"},"balance":{"type":"number","description":"Loyalty card balance","format":"float"},"points":{"type":"integer","format":"int32"},"paid_amount":{"type":"number","description":"Amount Paid","format":"float"},"sold_amount":{"type":"number","description":"Amount \"Sold\"","format":"float"},"visits_count":{"type":"integer","description":"Number of visits","format":"int32"},"number":{"type":"string","description":"Card number"},"type_id":{"type":"integer","description":"Loyalty card type identifier","format":"int32"},"salon_group_id":{"type":"integer","description":"ID of the chain where the card was created","format":"int32"},"type":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"},"salon_group_id":{"type":"integer","format":"int32"}},"description":"An object that contains the \"id\" and \"title\" fields: card type identifier and card type name, respectively"},"salon_group":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"}},"description":"An object that contains the \"id\" and \"title\" fields: the identifier of the chain where the card type was created and the name of this chain"},"programs":{"type":"array","description":"An array with information about promotions linked to a loyalty card","items":{"type":"object","properties":{"id":{"type":"integer","description":"Promotion ID","format":"int32"},"title":{"type":"string","description":"Share name"},"value":{"type":"integer","description":"The value from which the rule will work","format":"int32"},"loyalty_type_id":{"type":"integer","description":"Promotion type ID","format":"int32"},"item_type_id":{"type":"integer","description":"Is cashback earned on products?","format":"int32"},"value_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bonus field. Discount % or Fixed. sum"},"children":[]}]}]}],"format":"int32"},"group_id":{"type":"integer","description":"ID of the chain where the promotion was created","format":"int32"},"loyalty_type":{"type":"object","properties":{"id":{"type":"integer","description":"Promotion type ID","format":"int32"},"title":{"type":"string","description":"Share type name"},"is_discount":{"type":"boolean","description":"Discount"},"is_cashback":{"type":"boolean","description":"Cashback"},"is_static":{"type":"boolean","description":"Fixed discount"},"is_accumulative":{"type":"boolean","description":"Accumulative discount"}},"description":"Object with information about the promotion"},"rules":{"type":"array","description":"An array with information about the rules configured in the promotion","items":{"type":"object","properties":{"id":{"type":"integer","description":"Rule ID","format":"int32"},"loyalty_program_id":{"type":"integer","description":"Identifier of the stock to which the rule is attached","format":"int32"},"loyalty_type_id":{"type":"integer","description":"Promotion type ID","format":"int32"},"value":{"type":"integer","description":"The value from which the rule will work","format":"int32"},"parameter":{"type":"integer","format":"int32"}}}}}}}},"description":"Get a list of customer cards","example":{"id":9210520,"balance":100,"points":0,"paid_amount":1000,"sold_amount":1000,"visits_count":1,"number":14507109210520,"type_id":10992,"salon_group_id":145071,"type":{"id":10992,"title":"5+2","salon_group_id":145071},"salon_group":{"id":145071,"title":"Dough chain1."},"programs":[{"id":18005,"title":"5+2","value":0,"loyalty_type_id":13,"item_type_id":3,"value_unit_id":1,"group_id":145071,"loyalty_type":{"id":13,"title":"Discount for a given number of accumulated services","is_discount":true,"is_cashback":false,"is_static":false,"is_accumulative":false},"rules":[{"id":72803,"loyalty_program_id":18005,"loyalty_type_id":13,"value":20,"parameter":0},{"id":72804,"loyalty_program_id":18005,"loyalty_type_id":13,"value":10,"parameter":0},{"id":72805,"loyalty_program_id":18005,"loyalty_type_id":13,"value":100,"parameter":0}]}]}}},"components/schemas/loyalty_card_types_response_data_types":{"id":"components/schemas/loyalty_card_types_response_data_types","kind":"json-schema","title":"Root Type for loyalty_card_types_response_data_types","data":{"title":"Root Type for loyalty_card_types_response_data_types","type":"array","description":"Get a list of loyalty cards","example":[{"id":10992,"title":"Cashback","salon_group_id":145071,"salon_group":{"id":145071,"title":"Chain 1"}},{"id":8230,"title":"Referral program","salon_group_id":145071,"salon_group":{"id":145071,"title":"Chain 1"}}],"items":{"type":"object","properties":{"id":{"type":"integer","description":"Card type identifier","format":"int32"},"title":{"type":"string","description":"Card type name"},"salon_group_id":{"type":"integer","description":"ID of the chain where the card type was created","format":"int32"},"salon_group":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the chain where the card type was created","format":"int32"},"title":{"type":"string","description":"The name of the chain where the map type was created"}},"description":"An object that contains the \"id\" and \"title\" fields: the identifier of the chain where the card type was created and the name of this chain"}}}}},"components/schemas/loyalty_card_type":{"id":"components/schemas/loyalty_card_type","kind":"json-schema","title":"Root Type for LoyaltyCardType","data":{"title":"Root Type for LoyaltyCardType","type":"object","properties":{"id":{"type":"integer","description":"Card type identifier","format":"int32"},"title":{"type":"string","description":"Card type name"}},"description":"Loyalty card type","example":{"id":123,"title":"Loyalty card type"}}},"components/schemas/loyalty_cards_request_data_types":{"id":"components/schemas/loyalty_cards_request_data_types","kind":"json-schema","title":"Root Type for loyalty_cards_request_data_types","data":{"title":"Root Type for loyalty_cards_request_data_types","type":"object","properties":{"loyalty_card_number":{"type":"string","description":"Loyalty card number"},"loyalty_card_type_id":{"type":"string","description":"Loyalty card type identifier"},"phone":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer phone number (e.g., 13155550175 for +13155550175)"},"children":[]}]}]}]}},"description":"Issue a Loyalty Card","example":{"loyalty_card_number":"9090909","loyalty_card_type_id":"8230","phone":13155550175}}},"components/schemas/loyalty_card":{"id":"components/schemas/loyalty_card","kind":"json-schema","title":"loyalty_card","data":{"type":"object","properties":{"id":{"type":"number","description":"Loyalty card ID"},"balance":{"type":"number","description":"Card balance"},"points":{"type":"number","description":"Points"},"paid_amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Paid\" amount"},"children":[]}]}]}]},"sold_amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"Sold\" amount"},"children":[]}]}]}]},"visits_count":{"type":"number","description":"Visits count"},"number":{"type":"string","description":"Loyalty card number"},"type_id":{"type":"number","description":"Loyalty card type ID"},"salon_group_id":{"type":"number","description":"Chain ID"},"max_discount_percent":{"type":"number","description":"Maximum discount percent"},"max_discount_amount":{"type":"number","description":"Maximum discount amount"}},"description":"Loyalty card"}},"components/schemas/loyalty_abonements_response_data_types":{"id":"components/schemas/loyalty_abonements_response_data_types","kind":"json-schema","title":"Root Type for loyalty_abonements_response_data_types","data":{"title":"Root Type for loyalty_abonements_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":"integer","description":"Membership ID","format":"int32"},"number":{"type":"string","description":"Subscription code"},"balance_string":{"type":"string","description":"Service name, with number of uses"},"is_frozen":{"type":"boolean","description":"Is the membership frozen?"},"freeze_period":{"type":"integer","description":"The period the membership was frozen","format":"int32"},"period":{"type":"integer","description":"Subscription expiration value","format":"int32"},"period_unit_id":{"type":"integer","description":"Identifier of the expiration units. 1 - day, 2 - week, 3 - month, 4 - year","format":"int32"},"expiration_date":{"type":["string","null"],"description":"Subscription expiration date","format":"date-time"},"created_date":{"type":"string","description":"Subscription creation date","format":"date-time"},"activated_date":{"type":["string","null"],"description":"Subscription activation date","format":"date-time"},"is_united_balance":{"type":"boolean","description":"Whether membership has unified balance"},"is_united_balance_unlimited":{"type":"boolean","description":"Whether unified balance is unlimited"},"united_balance_services_count":{"type":"integer","description":"Number of services for unified balance"},"goods_transaction_id":{"type":"integer","description":"Product transaction ID"},"slug":{"type":"string","description":"Subscription type slug"},"status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID","format":"int32"},"title":{"type":"string","description":"Status name"},"extended_title":{"type":"string","description":"Full status name"},"slug":{"type":"string","description":"Status slug"},"category":{"type":"string","description":"Status category"}},"description":"Current membership status"},"balance_container":{"type":"object","properties":{"links":{"type":"array","description":"Array of services covered by the membership","items":{"type":"object","properties":{"count":{"type":"integer","description":"Number of applications","format":"int32"},"is_unlimited":{"type":"boolean","description":"Whether count is unlimited"},"service":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"is_category":{"type":"boolean"},"title":{"type":"string"},"online_sale_title":{"type":"string"},"is_chain":{"type":"boolean"},"chain_price_min":{"type":"number"},"chain_price_max":{"type":"number"},"category":{"type":"object"}},"description":"Service details"},"category":{"type":"object","properties":{"id":{"type":"integer","description":"Service ID","format":"int32"},"category_id":{"type":"integer","description":"Service Category ID","format":"int32"},"title":{"type":"string","description":"Service name"},"is_category":{"type":"boolean"},"online_sale_title":{"type":"string"},"is_chain":{"type":"boolean"},"chain_price_min":{"type":"number"},"chain_price_max":{"type":"number"},"category":{"type":"object"}},"description":"Service category"}}}}},"description":"An object that includes the links array with information about the membership balance"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Membership type ID","format":"int32"},"salon_group_id":{"type":"integer","description":"Identifier of the chain in which the membership type is valid","format":"int32"},"title":{"type":"string","description":"Membership type name"},"period":{"type":"integer","description":"Subscription expiration date (0 if not set)","format":"int32"},"period_unit_id":{"type":"integer","description":"Subscription validity period unit (list of possible values, if not set - 0)","format":"int32"},"allow_freeze":{"type":"boolean","description":"Is it possible to freeze memberships? true - allowed, false - not allowed"},"freeze_limit":{"type":"integer","description":"Maximum total freezing period (days)","format":"int32"},"freeze_limit_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freeze period unit: 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}]},"is_booking_when_frozen_allowed":{"type":"boolean","description":"Allow booking when membership is frozen"},"category_id":{"type":["integer","null"],"description":"Category ID restriction"},"is_allow_empty_code":{"type":"boolean","description":"Allow the sale of a membership without a code? true - allow, false - do not allow"},"is_united_balance":{"type":"boolean","description":"Total or separate membership balance: true - total, false - separate"},"united_balance_services_count":{"type":"integer","description":"Number of visits for total balance","format":"int32"},"is_united_balance_unlimited":{"type":"boolean","description":"Whether unified balance is unlimited"},"slug":{"type":"string","description":"Subscription type slug"},"is_code_required":{"type":"boolean","description":"Whether activation code is required"},"balance_edit_type_id":{"type":"integer","description":"Balance edit permission level"},"cost":{"type":"number","description":"Subscription price"},"is_archived":{"type":"boolean","description":"Whether membership type is archived"},"date_archived":{"type":["string","null"],"format":"date-time","description":"Date when archived"},"expiration_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":"Activation type: 1 = on sale, 2 = on first use, 3 = from specific date"},"children":[]}]}]}]},"expiration_type_title":{"type":"string","description":"Human-readable expiration type"},"service_price_correction":{"type":"boolean","description":"Whether service price can be adjusted"},"is_online_sale_enabled":{"type":"boolean","description":"Whether online sale is enabled"},"online_sale_title":{"type":"string","description":"Title for online sale"},"online_sale_description":{"type":"string","description":"Description for online sale"},"online_sale_price":{"type":"number","description":"Price for online sale"},"autoactivation_time":{"type":"integer","description":"Time units for autoactivation"},"autoactivation_time_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autoactivation time unit: 1 = days, 2 = weeks, 3 = months, 4 = years"},"children":[]}]}]}]},"weight":{"type":"integer","description":"Sort order weight"},"category":{"type":"string","description":"Subscription type category"},"balance_container":{"type":"object","properties":{"links":{"type":"array","description":"Array of services covered by the membership","items":{"type":"object","properties":{"count":{"type":"integer","description":"Number of applications","format":"int32"},"is_unlimited":{"type":"boolean","description":"Whether count is unlimited"},"service":{"type":"object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"is_category":{"type":"boolean"},"title":{"type":"string"},"online_sale_title":{"type":"string"},"is_chain":{"type":"boolean"},"chain_price_min":{"type":"number"},"chain_price_max":{"type":"number"},"category":{"type":"object"}},"description":"Service details"},"category":{"type":"object","properties":{"id":{"type":"integer","description":"Service ID","format":"int32"},"category_id":{"type":"integer","description":"Service Category ID","format":"int32"},"title":{"type":"string","description":"Service name"},"is_category":{"type":"boolean"},"online_sale_title":{"type":"string"},"is_chain":{"type":"boolean"},"chain_price_min":{"type":"number"},"chain_price_max":{"type":"number"},"category":{"type":"object"}},"description":"Service category"}}}}},"description":"An object that includes the links array with information about the membership balance"}},"description":"Object with information about membership type"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of subscriptions found)"}},"description":"Get a list of customer subscriptions","example":{"success":true,"data":[{"id":659878,"number":788376,"balance_string":"Surfing (x10)","is_frozen":false,"freeze_period":0,"period":9999,"period_unit_id":3,"status":{"id":1,"title":"Released","extended_title":"Released"},"balance_container":{"links":[{"count":10,"category":{"id":3129591,"category_id":1,"title":"Surfing"}}]},"type":{"id":97804,"salon_group_id":145071,"title":89999,"period":9999,"period_unit_id":3,"allow_freeze":false,"freeze_limit":0,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0,"balance_container":{"links":[{"count":10,"category":{"id":3129591,"category_id":1,"title":"Surfing"}}]}}}],"meta":{"count":1}}}},"components/schemas/loyalty_abonements_type_search_response_data_types":{"id":"components/schemas/loyalty_abonements_type_search_response_data_types","kind":"json-schema","title":"Root Type for loyalty_abonements_type_search_reaponse_data_types","data":{"title":"Root Type for loyalty_abonements_type_search_reaponse_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"array","description":"Array with data objects","items":{"type":"object","properties":{"id":{"type":"number","description":"Membership type ID"},"salon_group_id":{"type":"number","description":"Identifier of the chain in which the membership type is valid"},"title":{"type":"string","description":"Membership type name"},"period":{"type":"number","description":"Subscription expiration date (0 if not set)"},"period_unit_id":{"type":"number","description":"Subscription validity period unit (list of possible values, if not set - 0)"},"allow_freeze":{"type":"boolean","description":"Is it possible to freeze memberships? true - allowed, false - not allowed"},"freeze_limit":{"type":"number","description":"Maximum total freezing period (days)"},"is_allow_empty_code":{"type":"boolean","description":"Allow the sale of a membership without a code? true - allow, false - do not allow"},"is_united_balance":{"type":"boolean","description":"Total or separate membership balance: true - total, false - separate"},"united_balance_services_count":{"type":"number","description":"Number of visits for total balance"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of membership types found)"}},"description":"Get a List of Available Membership Types","example":{"success":true,"data":[{"id":12233,"salon_group_id":123,"title":"Subscription with the possibility of freezing for 14 days","period":0,"period_unit_id":0,"allow_freeze":true,"freeze_limit":14,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0},{"id":255789,"salon_group_id":456,"title":"Subscription for 6 months","period":6,"period_unit_id":3,"allow_freeze":false,"freeze_limit":0,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0}],"meta":{"count":2}}}},"components/schemas/chain_loyalty_membership_type":{"id":"components/schemas/chain_loyalty_membership_type","kind":"json-schema","title":"Subscription Type","data":{"title":"Subscription Type","description":"Chain-level membership type object","type":"object","properties":{"id":{"type":"integer","description":"Subscription type ID","example":777},"salon_group_id":{"type":"integer","description":"Chain ID where membership type is available","example":333},"category_id":{"type":["integer","null"],"description":"Category ID restriction (null if no category restriction)","example":null},"title":{"type":"string","description":"Subscription type name","example":"10-visit subscription"},"period":{"type":"integer","description":"Validity period (0 if not set)","example":10},"period_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period unit: 1 = day, 2 = week, 3 = month, 4 = year, 0 = not set"},"children":[]}]}]}],"example":3},"allow_freeze":{"type":"boolean","description":"Whether freezing is allowed","example":true},"freeze_limit":{"type":"integer","description":"Maximum total freeze period","example":30},"freeze_limit_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freeze period unit: 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"example":1},"is_booking_when_frozen_allowed":{"type":"boolean","description":"Allow booking appointments when membership is frozen","example":false},"is_allow_empty_code":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow sale without code: true = personal membership, false = shared with code"},"children":[]}]}]}],"example":false},"is_united_balance":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance type: true = unified, false = separate"},"children":[]}]}]}],"example":true},"is_united_balance_unlimited":{"type":"boolean","description":"Whether unified balance is unlimited","example":false},"is_code_required":{"type":"boolean","description":"Whether activation code is required","example":false},"balance_edit_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":"Balance edit type: 1 = editable, 2 = not editable"},"children":[]}]}]}],"example":1},"cost":{"type":"number","format":"float","description":"Subscription price","example":1000},"chain_price_min":{"type":"number","format":"float","description":"Minimum price across chain locations","example":1000},"chain_price_max":{"type":"number","format":"float","description":"Maximum price across chain locations","example":1500},"is_chain":{"type":"boolean","description":"Whether this is a chain-level membership type","example":true},"expiration_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":"Activation type: 1 = on sale, 2 = on first use, 3 = from specific date"},"children":[]}]}]}],"example":1},"expiration_type_title":{"type":"string","description":"Human-readable expiration type","example":"On sale"},"category":{"type":["object","null","string"],"description":"Service category restriction (can be object, null, or string like \"standard\")","example":null},"weight":{"type":"integer","description":"Sort order weight","example":0},"abonements_count":{"type":"integer","description":"Number of active subscriptions of this type","example":0},"is_online_sale_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Online sale: true = enabled, false = disabled"},"children":[]}]}]}],"example":false},"online_sale_title":{"type":"string","description":"Title for online sale","example":"10-visit subscription"},"online_sale_description":{"type":"string","description":"Description for online sale","example":"Sold online with discount"},"online_sale_price":{"type":"number","format":"float","description":"Price for online sale","example":550},"service_price_correction":{"type":"boolean","description":"Whether service price can be adjusted when applying membership","example":true},"united_balance_services_count":{"type":"integer","description":"Number of visits for unified balance","example":10},"autoactivation_time":{"type":"integer","description":"Time units for autoactivation","example":10},"autoactivation_time_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autoactivation time unit: 1 = days, 2 = weeks, 3 = months, 4 = years"},"children":[]}]}]}],"example":1},"attached_location_ids":{"type":"array","description":"List of location IDs attached to this membership type","items":{"type":"integer"},"example":[1,2,3]},"attached_salon_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternative name for attached_location_ids"},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2,3]},"online_sale_image":{"type":["string","null"],"description":"Image URL for online sale","example":"https://example.com/images/subscription_type.png"},"is_archived":{"type":"boolean","description":"Whether membership type is archived","example":false},"date_archived":{"type":["string","null"],"format":"date-time","description":"Date when membership type was archived","example":null},"availability":{"type":"array","description":"Time-based availability rules","items":{"type":"object","properties":{"week_days":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days of week: 1 = Monday, 7 = Sunday"},"children":[]}]}]}],"items":{"type":"integer"},"example":[1,2,3]},"intervals":{"type":"array","description":"Time intervals (seconds from midnight)","items":{"type":"object","properties":{"from":{"type":"integer","description":"Interval start","example":3600},"to":{"type":"integer","description":"Interval end","example":7200}}}}}},"example":[{"week_days":[1,2,3],"intervals":[{"from":3600,"to":7200},{"from":10800,"to":14400}]},{"week_days":[6,7],"intervals":[{"from":36000,"to":72000}]}]},"balance_container":{"type":"object","description":"Container with attached services and/or categories and their balance","properties":{"links":{"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","description":"Number of visits for this service/category","example":10},"is_unlimited":{"type":"boolean","description":"Whether count is unlimited","example":false},"service":{"type":"object","description":"Service details (if link is to a service)","properties":{"id":{"type":"integer","example":45},"is_category":{"type":"boolean","example":false},"category_id":{"type":"integer","example":90},"title":{"type":"string","example":"Service in location"},"online_sale_title":{"type":"string","description":"Online sale title for service","example":""},"is_chain":{"type":"boolean","description":"Whether service belongs to chain","example":false},"chain_price_min":{"type":"number","description":"Minimum service price across chain","example":0},"chain_price_max":{"type":"number","description":"Maximum service price across chain","example":0},"category":{"type":"object","properties":{"id":{"type":"integer","example":90},"is_category":{"type":"boolean","example":true},"category_id":{"type":"integer","example":1},"title":{"type":"string","example":"First service category in location"},"online_sale_title":{"type":"string","description":"Online sale title for category","example":""},"is_chain":{"type":"boolean","description":"Whether category belongs to chain","example":false},"chain_price_min":{"type":"number","description":"Minimum price across chain","example":0},"chain_price_max":{"type":"number","description":"Maximum price across chain","example":0},"category":{"anyOf":[{"type":"array","description":"Nested categories as array","items":{"type":"object"}},{"type":"object","description":"Nested category as object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"is_category":{"type":"boolean"},"title":{"type":"string"},"online_sale_title":{"type":"string"}}}]}}}}},"category":{"type":"object","description":"Category details (if link is to a category)","properties":{"id":{"type":"integer","example":91},"is_category":{"type":"boolean","example":true},"category_id":{"type":"integer","example":1},"title":{"type":"string","example":"Second service category in location"},"online_sale_title":{"type":"string","description":"Online sale title for category","example":""},"is_chain":{"type":"boolean","description":"Whether category belongs to chain","example":false},"chain_price_min":{"type":"number","description":"Minimum price across chain","example":0},"chain_price_max":{"type":"number","description":"Maximum price across chain","example":0},"category":{"anyOf":[{"type":"array","description":"Nested categories as array","items":{"type":"object"}},{"type":"object","description":"Nested category as object","properties":{"id":{"type":"integer"},"category_id":{"type":"integer"},"is_category":{"type":"boolean"},"title":{"type":"string"},"online_sale_title":{"type":"string"}}}]}}}}}}}}}}},"components/schemas/loyalty_certificates_response_data_types":{"id":"components/schemas/loyalty_certificates_response_data_types","kind":"json-schema","title":"Root Type for loyalty_certificates_response_data_types","data":{"title":"Root Type for loyalty_certificates_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":"integer","description":"Certificate ID","format":"int32"},"number":{"type":"string","description":"Certificate number"},"balance":{"type":"number","description":"Current balance","format":"float"},"default_balance":{"type":"number","description":"Starting balance","format":"float"},"type_id":{"type":"integer","description":"Certificate type identifier","format":"int32"},"status_id":{"type":"integer","description":"Status ID","format":"int32"},"created_date":{"type":"string","description":"Date of sale","format":"date-time"},"expiration_date":{"type":"string","description":"Burn date","format":"date-time"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Certificate type identifier","format":"int32"},"title":{"type":"string","description":"Gift card type name"},"balance":{"type":"integer","description":"Certificate denomination","format":"int32"},"is_multi":{"type":"boolean","description":"Is it available for multiple debits"},"company_group_id":{"type":"integer","description":"ID of the chain where the certificate type was created","format":"int32"},"item_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":"Restriction on the use of redemption points. 0 - no restrictions, 1 - only services, 2 - some services + all products, 3 - some services, 4 - only products"},"children":[]}]}]}],"format":"int32"},"expiration_type_id":{"type":"integer","description":"The ID of the expiration limit. 0 - unlimited, 1 - fixed date, 2 - fixed period","format":"int32"},"expiration_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Burn date of all certificates. Populated with expiration_type_id = 1"},"children":[]}]}]}],"format":"date-time"},"expiration_timeout":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validity period of certificates. Populated with expiration_type_id = 2"},"children":[]}]}]}],"format":"int32"},"expiration_timeout_unit_id":{"type":"integer","description":"Time units. 1 - Day, 2 - Week, 3 - Month, 4 - Year","format":"int32"},"is_allow_empty_code":{"type":"boolean","description":"Sale without code"},"item_type":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the expiration limit","format":"int32"},"title":{"type":"string","description":"Name of the constraint"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with item_type_id and its name"},"children":[]}]}]}]}},"description":"Object with certificate type information"},"status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID","format":"int32"},"title":{"type":"string","description":"Status name"}},"description":"An object with information about the current status of the certificate"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of certificates found)"}},"description":"Get certificates","example":{"success":true,"data":[{"id":409726,"number":888,"balance":9000,"default_balance":9000,"type_id":27841,"status_id":2,"created_date":"2026-09-21T23:00:00.000-05:00","expiration_date":"2026-09-21T23:00:00.000-05:00","type":{"id":27841,"title":"certificate 9000","balance":9000,"is_multi":true,"company_group_id":128284,"item_type_id":0,"expiration_type_id":2,"expiration_timeout":365,"expiration_timeout_unit_id":1,"is_allow_empty_code":false,"item_type":{"id":0,"title":"No limits"}},"status":{"id":2,"title":"activated"}}],"meta":{"count":1}}}},"components/schemas/loyalty_certificate_type_search_response_data_types":{"id":"components/schemas/loyalty_certificate_type_search_response_data_types","kind":"json-schema","title":"Root Type for loyalty_certificate_type_search_response_data_types","data":{"title":"Root Type for loyalty_certificate_type_search_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":"Certificate type identifier"},"title":{"type":"string","description":"Gift card type name"},"balance":{"type":"number","description":"Certificate denomination"},"is_multi":{"type":"boolean","description":"Write-off type: true - multiple write-off, false - single write-off"},"company_group_id":{"type":"number","description":"ID of the chain where the certificate type is valid"},"item_type_id":{"type":"number","description":"Application restriction (list of possible values)"},"expiration_type_id":{"type":"number","description":"Expiration limit (list of possible values)"},"expiration_date":{"type":"string","description":"Fixed burn date in ISO8601 format (null if not set)","format":"date-time"},"expiration_timeout":{"type":"number","description":"Certificate validity period from the date of sale (0 if not set)"},"expiration_timeout_unit_id":{"type":"number","description":"The unit of measurement of the validity period of the certificate from the moment of sale (the list of possible values, if not specified - 0)"},"is_allow_empty_code":{"type":"boolean","description":"Allow sale of certificate without code? true - allow, false - do not allow"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of certificate types found)"}},"description":"Get a List of Available Gift Card Types","example":{"success":true,"data":[{"id":1,"title":"Fixed burn date certificate without application restrictions","balance":10,"is_multi":true,"company_group_id":12,"item_type_id":0,"expiration_type_id":1,"expiration_date":"2026-09-21T23:00:00.000-05:00","expiration_timeout":0,"expiration_timeout_unit_id":0,"is_allow_empty_code":true},{"id":11,"title":"Certificate valid for 6 months from the date of sale for any goods without services","balance":100,"is_multi":false,"company_group_id":12,"item_type_id":2,"expiration_type_id":2,"expiration_timeout":6,"expiration_timeout_unit_id":3,"is_allow_empty_code":false}],"meta":{"count":2}}}},"components/schemas/company_loyalty_programs_search_data_types":{"id":"components/schemas/company_loyalty_programs_search_data_types","kind":"json-schema","title":"Root Type for company_loyalty_programs_search_data_types","data":{"title":"Root Type for company_loyalty_programs_search_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status."},"data":{"type":"array","description":"An array of data objects.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Promotion ID","format":"int32"},"title":{"type":"string","description":"Share name"},"type":{"type":"string","description":"Promotion type","enum":["discount_static","discount_accumulative_visits","discount_accumulative_sold","discount_accumulative_paid","cashback_static_sold","cashback_static_paid","cashback_accumulative_paid","cashback_accumulative_sold","cashback_accumulative_paid_visits","cashback_accumulative_sold_visits","cashback_sold_visits","cashback_paid_visits","package_discount"]},"loyalty_type_id":{"type":"integer","description":"Promotion type ID","format":"int32"},"item_type_id":{"type":"integer","description":"Identifier of the discount application type","format":"int32"},"service_item_type":{"type":"string","description":"Type of application to services","enum":["any_allowed","not_allowed","custom_allowed"]},"good_item_type":{"type":"string","description":"Type of application to products","enum":["any_allowed","not_allowed","custom_allowed"]},"value_unit_id":{"type":"integer","description":"Unit ID of the bonus or discount","format":"int32"},"value_unit":{"type":"string","description":"Bonus or discount measurement unit (percentage, fixed amount)","enum":["percent","amount"]},"group_id":{"type":"integer","description":"Chain ID","format":"int32"},"usage_limit":{"type":"integer","description":"Limit on the number of applications (only for cashback)","format":"int32"},"visit_multiplicity":{"type":"integer","description":"Multiplicity of application by visits (only for cashback)","format":"int32"},"sold_items_multiplicity":{"type":"integer","description":"How many services you need to pay to get a discount on promotional services (only for the promotion type \"Discount by condition\")","format":"int32"},"current_package_progress":{"type":"integer","description":"The current number of uses of the promotion","format":"int32"},"allowed_usages_amount":{"type":"integer","description":"Limitation on the number of allowed uses","format":"int32"},"expiration_timeout":{"type":"integer","description":"Expiration date of bonuses or discounts","format":"int32"},"expiration_timeout_unit":{"type":"string","description":"The unit of measurement for the expiration date of bonuses or discounts","enum":["day","week","month","year"]},"expiration_notification_timeout":{"type":"integer","description":"How many days before the bonus or discount expires, you need to send a notification to the client","format":"int32"},"params_source_type":{"type":"string","description":"Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)","enum":["loyalty_card","active_companies","chain"]},"history_start_date":{"type":"string","description":"From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)"},"on_changed_notification_template_id":{"type":"integer","description":"Notification template ID when changing bonus or discount","format":"int32"},"on_expiration_notification_template_id":{"type":"integer","description":"Identifier of the notification template when a bonus or discount burns","format":"int32"},"first_transaction_date":{"type":"string","description":"Date of first stock transaction"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","description":"Number of objects found","format":"int32"}},"description":"Metadata (contains the number of objects found)"}},"description":"Getting a list of stocks available for a location","example":{"success":true,"data":[{"id":53591,"title":"100 USD discount on Altegio Implementation Consultation","type":"discount_static","loyalty_type_id":1,"item_type_id":4,"service_item_type":"custom_allowed","good_item_type":"any_allowed","value_unit_id":2,"value_unit":"amount","group_id":502054,"usage_limit":0,"visit_multiplicity":1,"sold_items_multiplicity":1,"current_package_progress":0,"allowed_usages_amount":0,"expiration_timeout":0,"expiration_timeout_unit":"day","expiration_notification_timeout":0,"params_source_type":"loyalty_card","on_changed_notification_template_id":0,"on_expiration_notification_template_id":0}],"meta":{"count":1}}}},"components/schemas/visit_loyalty_transaction_reaponse_data_types":{"id":"components/schemas/visit_loyalty_transaction_reaponse_data_types","kind":"json-schema","title":"Root Type for visit_loyalty_transaction_reaponse_data_types","data":{"title":"Root Type for visit_loyalty_transaction_reaponse_data_types","type":"array","description":"Get loyalty transactions by visit","example":[{"id":22989715,"status_id":1,"amount":100,"type_id":1,"program_id":12705,"card_id":0,"salon_group_id":145071,"item_id":5048371,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96082477,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion Discount"},"program":{"id":12705,"title":"invited","value":10,"loyalty_type_id":1,"item_type_id":0,"value_unit_id":1,"group_id":145071}},{"id":22994127,"status_id":1,"amount":100,"type_id":4,"program_id":19044,"card_id":9234863,"salon_group_id":145071,"item_id":0,"item_type_id":0,"item_record_id":0,"goods_transaction_id":0,"is_discount":false,"is_loyalty_withdraw":false,"type":{"id":4,"title":"Referral program accrual"},"program":{"id":19044,"title":"inviter 2","value":100,"loyalty_type_id":6,"item_type_id":0,"value_unit_id":2,"group_id":145071}}],"items":{"type":"object","properties":{"id":{"type":"integer","description":"Loyalty transaction ID","format":"int32"},"status_id":{"type":"integer","description":"Status ID","format":"int32"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"type_id":{"type":"integer","description":"Transaction type identifier","format":"int32"},"program_id":{"type":"integer","description":"Loyalty program ID","format":"int32"},"card_id":{"type":"integer","description":"Loyalty card ID","format":"int32"},"salon_group_id":{"type":"integer","description":"ID of the chain to which the loyalty belongs","format":"int32"},"item_id":{"type":"integer","description":"Identifier of the product/service to which the promotion applies","format":"int32"},"item_type_id":{"type":"integer","description":"Operation type identifier","format":"int32"},"item_record_id":{"type":"integer","description":"Identifier of the appointment to which the service/product belongs","format":"int32"},"goods_transaction_id":{"type":"integer","description":"Commodity transaction ID","format":"int32"},"is_discount":{"type":"boolean","description":"Is a discount"},"is_loyalty_withdraw":{"type":"boolean","description":"Is the application of loyalty canceled"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Loyalty type identifier","format":"int32"},"title":{"type":"string","description":"Loyalty type name"}},"description":"Loyalty type"},"program":{"type":"object","properties":{"id":{"type":"integer","description":"Promotion ID","format":"int32"},"title":{"type":"string","description":"Share name"},"value":{"type":"integer","description":"Discount value","format":"int32"},"loyalty_type_id":{"type":"integer","description":"Promotion type ID","format":"int32"},"item_type_id":{"type":"integer","description":"Is cashback earned on products?","format":"int32"},"value_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bonus field. Discount % or Fixed. sum"},"children":[]}]}]}],"format":"int32"},"group_id":{"type":"integer","description":"ID of the chain where the action was created","format":"int32"}},"description":"Promotion Information"}}}}},"components/schemas/loyalty_generate_code200_data_option":{"id":"components/schemas/loyalty_generate_code200_data_option","kind":"json-schema","title":"loyalty_generate_code200_data_option","data":{"required":["code"],"type":"object","properties":{"code":{"type":"string","description":"Generated code"}}}},"components/schemas/loyalty_generate_code200_option":{"id":"components/schemas/loyalty_generate_code200_option","kind":"json-schema","title":"loyalty_generate_code200_option","data":{"required":["data","meta","success"],"type":"object","properties":{"success":{"type":"boolean","description":"flag indicating that the response was completed without errors (true)"},"data":{"$ref":"#/components/schemas/loyalty_generate_code200_data_option"},"meta":{"type":"array","description":"metadata (empty array)","items":{"type":"object"}}}}},"components/schemas/loyalty_generate_code_error_option":{"id":"components/schemas/loyalty_generate_code_error_option","kind":"json-schema","title":"loyalty_generate_code_error_option","data":{"required":["data","success"],"type":"object","properties":{"success":{"type":"boolean","description":"Error"},"data":{"type":"string","description":"Error data"}}}},"components/schemas/loyalty_generate_code_error_meta_option":{"id":"components/schemas/loyalty_generate_code_error_meta_option","kind":"json-schema","title":"loyalty_generate_code_error_meta_option","data":{"required":["message"],"type":"object","properties":{"message":{"type":"string","description":"Error message"}}}},"components/schemas/visit_loyalty_withdrawl_request_data_types":{"id":"components/schemas/visit_loyalty_withdrawl_request_data_types","kind":"json-schema","title":"Root Type for visit_loyalty_withdrawl_request_data_types","data":{"title":"Root Type for visit_loyalty_withdrawl_request_data_types","required":["amount","record_id","visit_id"],"type":"object","properties":{"record_id":{"type":"number","description":"Appointment ID"},"visit_id":{"type":"number","description":"Visit ID"},"amount":{"type":"number","description":"Number of points to redeem"}},"description":"Apply Deduction from the Loyalty Card in the Visit","example":{"record_id":140967944,"visit_id":118389447,"amount":100}}},"components/schemas/visit_loyalty_apply_response_data_types":{"id":"components/schemas/visit_loyalty_apply_response_data_types","kind":"json-schema","title":"Root Type for visit_loyalty_apply_response_data_types","data":{"title":"Root Type for visit_loyalty_apply_response_data_types","type":"object","properties":{"payment_transactions":{"type":"array","description":"Array with information about the financial transactions of the appointment","items":{"type":"object"}},"loyalty_transactions":{"type":"array","description":"An array with information about applied loyalty transactions in a visit","items":{"type":"object","properties":{"id":{"type":"integer","description":"Loyalty transaction ID","format":"int32"},"status_id":{"type":"integer","description":"Status ID","format":"int32"},"amount":{"type":"number","description":"Transaction amount","format":"float"},"type_id":{"type":"integer","description":"Transaction type ID","format":"int32"},"program_id":{"type":"integer","description":"Loyalty program ID","format":"int32"},"card_id":{"type":"integer","description":"Loyalty card ID","format":"int32"},"salon_group_id":{"type":"integer","description":"ID of the chain to which the loyalty belongs","format":"int32"},"item_id":{"type":"integer","description":"Identifier of the product/service to which the promotion applies","format":"int32"},"item_type_id":{"type":"integer","description":"Operation type identifier","format":"int32"},"item_record_id":{"type":"integer","description":"Identifier of the appointment to which the service/product belongs","format":"int32"},"goods_transaction_id":{"type":"integer","description":"Commodity transaction ID","format":"int32"},"is_discount":{"type":"boolean","description":"Is a discount"},"is_loyalty_withdraw":{"type":"boolean","description":"Is the application of loyalty canceled"},"type":{"type":"object","properties":{"id":{"type":"integer","description":"Loyalty type identifier","format":"int32"},"title":{"type":"string","description":"Loyalty type name"}},"description":"Loyalty type"}}}},"kkm_transaction_details_container":{"type":"object","properties":{"last_operation_type":{"type":"integer","description":"Is the receipt printed (0 - return receipt, 1 - sale receipt)","format":"int32"},"transactions":{"type":"array","description":"Array of KKM transactions","items":{"type":"object"}}},"description":"An object that holds details about transactions recorded by the POS system"},"items":{"type":"array","description":"Array with information about products and services of the appointment","items":{"type":"object","properties":{"id":{"type":"integer","description":"Object ID","format":"int32"},"item_id":{"type":"integer","description":"Product/service identifier","format":"int32"},"item_type_id":{"type":"integer","description":"Operation type identifier","format":"int32"},"record_id":{"type":"integer","description":"Appointment ID","format":"int32"},"item_title":{"type":"string","description":"Product/service name"},"amount":{"type":"integer","description":"Number of products/services","format":"int32"},"first_cost":{"type":"number","description":"Initial cost","format":"float"},"manual_cost":{"type":"number","description":"Cost changed manually","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"cost":{"type":"number","description":"the total cost","format":"float"},"master_id":{"type":"integer","description":"team member ID","format":"int32"},"good_id":{"type":"integer","description":"Item ID","format":"int32"},"service_id":{"type":"integer","description":"Service ID","format":"int32"},"event_id":{"type":"integer","description":"Promotion ID","format":"int32"},"is_service":{"type":"boolean","description":"Is a service"},"is_event":{"type":"boolean","description":"Is a stock"},"is_good":{"type":"boolean","description":"Is the commodity"}}}}},"description":"Application of loyalty in a visit","example":{"payment_transactions":[],"loyalty_transactions":[{"id":22985556,"status_id":1,"amount":20,"type_id":1,"program_id":20802,"card_id":9223622,"salon_group_id":145071,"item_id":5048384,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96063258,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion discount"}}],"kkm_transaction_details_container":{"last_operation_type":1,"transactions":[]},"items":[{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]}}},"components/schemas/visit_loyalty_request_data_types":{"id":"components/schemas/visit_loyalty_request_data_types","kind":"json-schema","title":"Root Type for visit_loyalty_request_data_types","data":{"title":"Root Type for visit_loyalty_request_data_types","required":["record_id","visit_id"],"type":"object","properties":{"record_id":{"type":"number","description":"Appointment ID"},"visit_id":{"type":"number","description":"Visit ID"}},"description":"Apply promotion","example":{"record_id":0,"visit_id":0}}},"components/schemas/visit_loyalty_cancel_response_data_types":{"id":"components/schemas/visit_loyalty_cancel_response_data_types","kind":"json-schema","title":"Root Type for visit_loyalty_cancel_response_data_types","data":{"title":"Root Type for visit_loyalty_cancel_response_data_types","type":"object","properties":{"payment_transactions":{"type":"array","description":"Array with information about the financial transactions of the appointment","items":{"type":"object"}},"loyalty_transactions":{"type":"array","description":"An array with information about applied loyalty transactions in a visit","items":{"type":"object"}},"kkm_transaction_details_container":{"type":"object","properties":{"last_operation_type":{"type":"integer","format":"int32"},"transactions":{"type":"array","items":{"type":"object"}}},"description":"An object that holds details about transactions recorded by the POS system"},"items":{"type":"array","description":"Array with information about products and services of the appointment","items":{"type":"object","properties":{"id":{"type":"integer","description":"Object ID","format":"int32"},"item_id":{"type":"integer","description":"Product/service identifier","format":"int32"},"item_type_id":{"type":"integer","description":"Operation type identifier","format":"int32"},"record_id":{"type":"integer","description":"Appointment ID","format":"int32"},"item_title":{"type":"string","description":"Product/service name"},"amount":{"type":"integer","description":"Number of products/services","format":"int32"},"first_cost":{"type":"number","description":"Initial cost","format":"float"},"manual_cost":{"type":"number","description":"Cost changed manually","format":"float"},"discount":{"type":"number","description":"Discount","format":"float"},"cost":{"type":"number","description":"the total cost","format":"float"},"master_id":{"type":"integer","description":"team member ID","format":"int32"},"good_id":{"type":"integer","description":"Item ID","format":"int32"},"service_id":{"type":"integer","description":"Service ID","format":"int32"},"event_id":{"type":"integer","description":"Promotion ID","format":"int32"},"is_service":{"type":"boolean","description":"Is a service"},"is_event":{"type":"boolean","description":"Is a stock"},"is_good":{"type":"boolean","description":"Is the commodity"}}}}},"description":"Cancellation of loyalty in a visit","example":{"payment_transactions":[],"loyalty_transactions":[],"kkm_transaction_details_container":{"last_operation_type":1,"transactions":[]},"items":[{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]}}},"components/schemas/visit_loyalty_referral_request_data_types":{"id":"components/schemas/visit_loyalty_referral_request_data_types","kind":"json-schema","title":"Root Type for visit_loyalty_referral_request_data_types","data":{"title":"Root Type for visit_loyalty_referral_request_data_types","required":["record_id","referrer_phone","visit_id"],"type":"object","properties":{"record_id":{"type":"number","description":"Appointment ID"},"visit_id":{"type":"number","description":"Visit ID"},"referrer_phone":{"type":"number","description":"Phone number of the inviter"}},"description":"Apply referral program in a visit","example":{"record_id":140967944,"visit_id":118389447,"referrer_phone":13155550175}}},"components/schemas/salary_staff_balance":{"id":"components/schemas/salary_staff_balance","kind":"json-schema","title":"Salary balance object","data":{"title":"Salary balance object","type":"object","properties":{"income":{"type":"string","description":"Income."},"expense":{"type":"string","description":"Expense."},"balance":{"type":"string","description":"Balance."}}}},"components/schemas/salary_staff_calculation_daily":{"id":"components/schemas/salary_staff_calculation_daily","kind":"json-schema","title":"Mutual settlements grouped by date","data":{"title":"Mutual settlements grouped by date","type":"object","properties":{"payroll_daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Date."},"payroll_sum":{"$ref":"#/components/schemas/salary_staff_balance","description":"Total payroll sum for this date."}}}},"currency":{"$ref":"#/components/schemas/currency","description":"Currency."}},"description":"Mutual settlements grouped by date."}},"components/schemas/salary_staff_calculation":{"id":"components/schemas/salary_staff_calculation","kind":"json-schema","title":"Mutual settlements","data":{"title":"Mutual settlements","type":"object","properties":{"total_sum":{"$ref":"#/components/schemas/salary_staff_balance","description":"Total sum."},"currency":{"$ref":"#/components/schemas/currency","description":"Currency."}},"description":"Mutual settlements."}},"components/schemas/salary_staff_schemes_count":{"id":"components/schemas/salary_staff_schemes_count","kind":"json-schema","title":"Salary schemes count","data":{"title":"Salary schemes count","type":"object","properties":{"staff_id":{"type":"integer","description":"ID of a team member.","format":"int32"},"salary_schemes_count":{"type":"integer","description":"Applicable salary schemes count.","format":"int32"}}}},"components/schemas/salary_payroll_calculation":{"id":"components/schemas/salary_payroll_calculation","kind":"json-schema","title":"Salary calculation object","data":{"title":"Salary calculation object","type":"object","properties":{"id":{"type":"number","description":"ID of calculation."},"company_id":{"type":"number","description":"ID of a location."},"staff_id":{"type":"number","description":"ID of a team member."},"amount":{"type":"number","description":"Calculated salary amount."},"status":{"type":"string","enum":["draft","confirmed"],"description":"Calculation status."},"date_create":{"type":"string","format":"date","description":"Date of calculation creation."},"date_from":{"type":"string","format":"date","description":"Date of calculation period start."},"date_to":{"type":"string","format":"date","description":"Date of calculation period end."},"comment":{"type":"string","description":"Calculation comment."}},"example":{"id":123,"company_id":456,"staff_id":789,"amount":1000,"status":"confirmed","date_create":"2026-03-03","date_from":"2026-03-01","date_to":"2026-03-02","comment":"Calculation per day"}}},"components/schemas/salary_payroll_calculation_item_paid_container":{"id":"components/schemas/salary_payroll_calculation_item_paid_container","kind":"json-schema","title":"Payment details object","data":{"title":"Payment details object","type":"object","properties":{"money_sum":{"type":"string","description":"Sum paid with money."},"discount_sum":{"type":"string","description":"Sum paid with discount."},"bonus_sum":{"type":"string","description":"Sum paid with bonus."},"certificate_sum":{"type":"string","description":"Sum paid with a gift card."},"abonement_sum":{"type":"string","description":"Sum paid with a membership."},"deposit_sum":{"type":"string","description":"Sum paid with a customer account."}}}},"components/schemas/salary_payroll_calculation_item_info_container":{"id":"components/schemas/salary_payroll_calculation_item_info_container","kind":"json-schema","title":"Payroll calculation rules details object","data":{"title":"Payroll calculation rules details object","type":"object","properties":{"criteria_title":{"type":"string","description":"Salary payroll criterium title."},"param_title":{"type":"string","description":"Salary payroll parameter title."},"scheme_title":{"type":"string","description":"Salary payroll scheme title."}}}},"components/schemas/salary_payroll_calculation_item_target_calculation":{"id":"components/schemas/salary_payroll_calculation_item_target_calculation","kind":"json-schema","title":"Salary calculation item target rule object","data":{"title":"Salary calculation item target rule object","type":"object","properties":{"type_slug":{"type":"string","enum":["fix","percent"],"description":"Rule type."},"value":{"type":"number","description":"Value."},"description":{"type":"string","description":"Calculation rule description."}}}},"components/schemas/salary_payroll_calculation_item_target_container":{"id":"components/schemas/salary_payroll_calculation_item_target_container","kind":"json-schema","title":"Salary calculation item target object","data":{"title":"Salary calculation item target object","type":"object","properties":{"target_type_slug":{"type":["string","null"],"enum":["service","good"],"description":"Type of a target."},"target_id":{"type":["number","null"],"description":"ID of a target."},"title":{"type":"string","description":"Title of a target."},"cost":{"type":["string","null"],"description":"Sale cost of a target."},"net_cost":{"type":["string","null"],"description":"Net cost of a target."},"salary_sum":{"type":["string","null"],"description":"Total calculated salary sum for a target."},"salary_promotion_sum":{"type":["string","null"],"description":"Calculated salary sum for the promotion of a target."},"salary_calculation":{"type":["object","null"],"allOf":[{"$ref":"#/components/schemas/salary_payroll_calculation_item_target_calculation"}],"description":"Target salary calculation rule."}}}},"components/schemas/salary_payroll_calculation_item_discrepancy":{"id":"components/schemas/salary_payroll_calculation_item_discrepancy","kind":"json-schema","title":"Payroll calculation discrepancy details object","data":{"title":"Payroll calculation discrepancy details object","type":"object","properties":{"reason":{"type":"string","enum":["new","deleted","updated_rule","updated_sum"],"description":"Discrepancy type."},"actual_sum":{"type":"string","description":"Actual salary sum."},"difference_sum":{"type":"string","description":"Difference between actual and calculated salary sums."}}}},"components/schemas/salary_payroll_calculation_item_container":{"id":"components/schemas/salary_payroll_calculation_item_container","kind":"json-schema","title":"Salary calculation item object","data":{"title":"Salary calculation item object","type":"object","properties":{"date":{"type":"string","format":"date","description":"Date."},"time":{"type":"string","format":"time","description":"Time."},"item_id":{"type":"number","description":"ID of an entity subject to salary calculation (e.g., appointment ID or sale ID)."},"item_type_slug":{"type":"string","enum":["periodic","sale","record","bonus","penalty","retro_bonus","activity"],"description":"Type of an entity subject to salary calculation (e.g., appointment or sale)."},"salary_sum":{"type":"string","description":"Calculated salary sum."},"record_id":{"type":["number","null"],"description":"ID of an appointment."},"client_id":{"type":["number","null"],"description":"ID of a customer."},"cost":{"type":["string","null"],"description":"Base cost."},"paid":{"type":["object","null"],"allOf":[{"$ref":"#/components/schemas/salary_payroll_calculation_item_paid_container"}],"description":"Payment details."},"salary_calculation_info":{"$ref":"#/components/schemas/salary_payroll_calculation_item_info_container","description":"Payroll calculation rules details."},"targets":{"type":"array","items":{"$ref":"#/components/schemas/salary_payroll_calculation_item_target_container"}},"salary_discrepancy":{"type":["object","null"],"allOf":[{"$ref":"#/components/schemas/salary_payroll_calculation_item_discrepancy"}],"description":"Payroll calculation discrepancy details (if any)."}}}},"components/schemas/salary_payroll_calculation_container":{"id":"components/schemas/salary_payroll_calculation_container","kind":"json-schema","title":"Salary calculation object with details","data":{"title":"Salary calculation object with details","allOf":[{"$ref":"#/components/schemas/salary_payroll_calculation"},{"type":"object","properties":{"salary_items":{"type":"array","items":{"$ref":"#/components/schemas/salary_payroll_calculation_item_container"},"description":"Salary calculation items."},"currency":{"$ref":"#/components/schemas/currency","description":"Currency."}}}]}},"components/schemas/salary_staff_summary":{"id":"components/schemas/salary_staff_summary","kind":"json-schema","title":"Salary totals","data":{"title":"Salary totals","type":"object","properties":{"working_days_count":{"type":"integer","description":"Number of working days.","format":"int32"},"working_hours_count":{"type":"integer","description":"Number of working hours.","format":"int32"},"group_services_count":{"type":"integer","description":"Number of group services provided.","format":"int32"},"services_count":{"type":"integer","description":"Number of services provided.","format":"int32"},"services_sum":{"type":"string","description":"The cost of services provided."},"goods_sales_count":{"type":"integer","description":"Number of products sold.","format":"int32"},"goods_sales_sum":{"type":"string","description":"Cost of products sold."},"total_sum":{"type":"string","description":"Total cost."},"salary":{"type":"string","description":"Salary."}}}},"components/schemas/salary_staff_period_daily":{"id":"components/schemas/salary_staff_period_daily","kind":"json-schema","title":"Payroll for a period for a team member grouped by date","data":{"title":"Payroll for a period for a team member grouped by date","type":"object","properties":{"period_calculation_daily":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Date."},"period_calculation":{"$ref":"#/components/schemas/salary_staff_summary","description":"Calculations for this date."}}}},"currency":{"$ref":"#/components/schemas/currency","description":"Currency."}},"description":"Payroll for a period for a specific team member grouped by date."}},"components/schemas/salary_staff_period":{"id":"components/schemas/salary_staff_period","kind":"json-schema","title":"Payroll for a period for a team member","data":{"title":"Payroll for a period for a team member","allOf":[{"$ref":"#/components/schemas/salary_staff_summary"},{"type":"object","properties":{"currency":{"$ref":"#/components/schemas/currency","description":"Currency."}}}],"description":"Payroll for a period for a specific team member."}},"components/schemas/salary_staff_scheme":{"id":"components/schemas/salary_staff_scheme","kind":"json-schema","title":"Salary scheme object","data":{"title":"Salary scheme object","type":"object","properties":{"staff_id":{"type":"integer","description":"ID of a team member.","format":"int32"},"date_start":{"type":"string","description":"Start date the salary scheme is applicable.","format":"date"},"date_end":{"type":"string","description":"Start date the salary scheme is applicable. Null, if salary scheme is unlimited.","format":"date"},"salary_scheme":{"type":"object","properties":{"id":{"type":"integer","description":"ID of a salary scheme.","format":"int32"},"title":{"type":"string","description":"Title of a salary scheme."}},"description":"Salary scheme."}}}},"components/schemas/notification_settings_notification_types_data_type":{"id":"components/schemas/notification_settings_notification_types_data_type","kind":"json-schema","title":"Root Type for notification_settings_notification_types_data_type","data":{"title":"Root Type for notification_settings_notification_types_data_type","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"array","description":"Array of objects","items":{"type":"object","properties":{"type":{"type":"string","description":"Notification type"},"channels":{"type":"object","properties":{"push":{"type":"integer","description":"PUSH notifications","format":"int32"},"sms":{"type":"integer","description":"SMS notifications","format":"int32"},"email":{"type":"integer","description":"Email Notifications","format":"int32"}},"description":"Channels through which notifications will be sent"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of objects)"}},"description":"Location notification settings","example":{"success":true,"data":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_move_admin","channels":{"push":1,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":1,"sms":1,"email":1}},{"type":"record_create_offline_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_create_online_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_delete_admin","channels":{"push":0,"sms":0,"email":1}},{"type":"record_delete_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}}],"meta":{"count":9}}}},"components/schemas/notification_settings_users_data_type":{"id":"components/schemas/notification_settings_users_data_type","kind":"json-schema","title":"Root Type for notification_settings_users_data_type","data":{"title":"Root Type for notification_settings_users_data_type","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"object","properties":{"mode":{"type":"string","description":"Notification type (for team member/for administrator)","enum":["admin","staff","disabled"]},"notification_types":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Notification type","enum":["record_create_online_staff","record_create_offline_staff","record_delete_staff","record_move_staff","record_create_online_admin","record_create_offline_admin","record_delete_admin","record_move_admin","license_expire"]},"channels":{"type":"object","properties":{"push":{"type":"integer","description":"PUSH notifications","format":"int32"},"sms":{"type":"integer","description":"SMS notifications","format":"int32"},"email":{"type":"integer","description":"Email Notifications","format":"int32"}},"description":"Channels through which notifications will be sent"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get User Notification Settings","example":{"success":true,"data":{"mode":"staff","notification_types":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_delete_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":0,"sms":0,"email":0}}]},"meta":[]}}},"components/schemas/notification_settings_users_request_data_type":{"id":"components/schemas/notification_settings_users_request_data_type","kind":"json-schema","title":"Root Type for notification_settings_users_request_data_type","data":{"title":"Root Type for notification_settings_users_request_data_type","type":"object","properties":{"notification_types":{"type":"array","description":"Array of objects","items":{"type":"object","properties":{"type":{"type":"string","description":"Notification type","enum":["record_create_online_staff","record_create_offline_staff","record_delete_staff","record_move_staff","record_create_online_admin","record_create_offline_admin","record_delete_admin","record_move_admin","license_expire"]},"channels":{"type":"object","properties":{"push":{"type":"integer","description":"PUSH notification","format":"int32"}},"description":"The channel on which the notification will be sent"}}}}},"description":"Change User Push Notification Settings","example":{"notification_types":[{"type":"record_create_online_admin","channels":{"push":1}},{"type":"record_create_offline_admin","channels":{"push":1}},{"type":"record_delete_admin","channels":{"push":1}},{"type":"record_move_admin","channels":{"push":1}},{"type":"license_expire","channels":{"push":1}}]}}},"components/schemas/custom_fields_response_data_types":{"id":"components/schemas/custom_fields_response_data_types","kind":"json-schema","title":"Root Type for custom_fields_response_data_types","data":{"title":"Root Type for custom_fields_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":"integer","description":"Field ID","format":"int32"},"salon_id":{"type":"number","description":"location ID"},"custom_field":{"type":"object","properties":{"id":{"type":"integer","description":"Field ID","format":"int32"},"code":{"type":"string","description":"Field code by which values for appointment fields are set"},"entity_type":{"type":"string","description":"Entity type for which the field is valid (customer card, appointment window)"},"show_in_ui":{"type":"boolean","description":"Whether to show fields in the interface"},"title":{"type":"string","description":"Name of add. fields"},"user_can_edit":{"type":"boolean","description":"Is editing allowed"},"type":{"type":"object","properties":{"code":{"type":"string","description":"Field type code"},"title":{"type":"string","description":"Field type name"}},"description":"Field type"},"values":{"type":"string","description":"List of valid values for type \"list\""}},"description":"Custom fields"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Getting a collection of location fields","example":{"success":true,"data":[{"id":1,"salon_id":1,"custom_field":{"id":1,"code":"my_text_field","show_in_ui":true,"title":"test field","user_can_edit":true,"type":{"code":"text","title":"Text"}}}],"meta":[]}}},"components/schemas/custom_fields_request_data_type":{"id":"components/schemas/custom_fields_request_data_type","kind":"json-schema","title":"Root Type for custom_fields_request_data_type","data":{"title":"Root Type for custom_fields_request_data_type","required":["code","show_in_ui","title","type","user_can_edit"],"type":"object","properties":{"type":{"type":"string","description":"Field type"},"code":{"type":"string","description":"Field ID"},"title":{"type":"string","description":"Field name"},"user_can_edit":{"type":"boolean","description":"Can the user edit the field"},"show_in_ui":{"type":"boolean","description":"Whether to show the field in the interface"}},"description":"Adding a Custom Field","example":{"type":"text","code":"my_text_field","title":"test field","user_can_edit":true,"show_in_ui":true}}},"components/schemas/groups_response_data_types":{"id":"components/schemas/groups_response_data_types","kind":"json-schema","title":"Root Type for groups_response_data_types","data":{"title":"Root Type for groups_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":"Chain ID"},"title":{"type":"string","description":"Chain name"},"companies":{"type":"array","description":"Chain locations","items":{"type":"object","properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"location name"},"public_title":{"type":"string","description":"Public-facing location name"},"business_group_id":{"type":"number","description":"Business group ID"},"business_type_id":{"type":"number","description":"Business type ID"},"country_id":{"type":"number","description":"Country ID"},"city_id":{"type":"number","description":"City ID"},"timezone":{"type":"number","description":"Timezone ID"},"timezone_name":{"type":"string","description":"Timezone name"},"address":{"type":"string","description":"Physical address"},"currency_short_title":{"type":"string","description":"Currency code"},"coordinate_lat":{"type":"number","description":"Latitude coordinate"},"coordinate_lon":{"type":"number","description":"Longitude coordinate"},"logo":{"type":"string","description":"Logo URL"},"zip":{"type":"string","description":"ZIP/postal code"},"phone":{"type":"string","description":"Phone number"},"phones":{"type":"array","description":"Phone numbers","items":{"type":"string"}},"site":{"type":"string","description":"Website URL"},"allow_delete_record":{"type":"boolean","description":"Allow deleting records"},"allow_change_record":{"type":"boolean","description":"Allow changing records"}}}},"access":{"type":"object","properties":{"settings_access":{"type":"number","description":"1 - there is access to the settings section, 0 - no access"},"clients_access":{"type":"number","description":"1 - there is access to the client base, 0 - no access"},"deposits_access":{"type":"number","description":"1 - there is access to client accounts, 0 - no access"},"deposit_types_access":{"type":"number","description":"1 - there is access to client account types, 0 - no access"},"users_access":{"type":"number","description":"1 - there is access to user management, 0 - no access"},"loyalty_access":{"type":"number","description":"1 - there is access to loyalty, 0 - no access"},"loyalty_abonement_types_access":{"type":"number","description":"1 - there is access to membership types, 0 - no access"},"loyalty_abonement_balance_edit_access":{"type":"number","description":"1 - there is access to edit membership balance, 0 - no access"},"loyalty_abonement_period_edit_access":{"type":"number","description":"1 - there is access to edit membership period, 0 - no access"},"loyalty_abonement_history_access":{"type":"number","description":"1 - there is access to membership history, 0 - no access"},"loyalty_cards_manual_transactions_access":{"type":"number","description":"1 - there is access to manual replenishment/withdrawal from loyalty cards, 0 - no access"},"loyalty_certificate_types_access":{"type":"number","description":"1 - there is access to certificate types, 0 - no access"},"loyalty_programs_access":{"type":"number","description":"1 - there is access to loyalty programs, 0 - no access"},"network_services_access":{"type":"number","description":"1 - there is access to chain services management, 0 - no access"},"analytics_access":{"type":"number","description":"1 - there is access to analytics, 0 - no access"}},"description":"User access rights on the chain"}}}},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Obtaining chains available to the user","example":{"success":true,"data":[{"id":509,"title":"Chain of salons in New York","companies":[{"id":38726,"title":"Location in New York"},{"id":39287,"title":"Location in New York"}],"access":{"settings_access":"1","clients_access":"1","users_access":"1","loyalty_access":"1","loyalty_cards_manual_transactions_access":"1","chain_services_access":"1"}},{"id":508,"title":"Chain of salons in New York","companies":[{"id":38545,"title":"Location in New York"},{"id":38704,"title":"Location in New York"}],"access":{"settings_access":"1","clients_access":"1","users_access":"1","loyalty_access":"1","loyalty_cards_manual_transactions_access":"1","chain_services_access":"1"}}]}}},"components/schemas/group_groupid_clients_response_data_types":{"id":"components/schemas/group_groupid_clients_response_data_types","kind":"json-schema","title":"Root Type for group_groupid_clients_response_data_types","data":{"title":"Root Type for group_groupid_clients_response_data_types","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status (true)"},"data":{"type":"object","properties":{"salon_group_id":{"type":"number","description":"Chain ID"},"phone":{"type":"string","description":"Customer phone"},"clients":{"type":"array","description":"Array of clients in chain locations","items":{"type":"object","properties":{"id":{"type":"number","description":"Client ID"},"company_id":{"type":"number","description":"Location ID"},"name":{"type":"string","description":"Client name"},"email":{"type":"string","description":"Client Email"}}}}},"description":"Object with data"},"meta":{"type":"array","description":"Metadata (empty array)","items":{"type":"object"}}},"description":"Get chain client by phone number","example":{"success":true,"data":{"salon_group_id":312,"phone":"+13155550175","clients":[{"id":4240880,"company_id":4564,"name":"lx","email":"client@example.com"},{"id":4243272,"company_id":24697,"name":"lx","email":"client@example.com"}]},"meta":[]}}},"components/schemas/group_groupid_clients_response_data_types400":{"id":"components/schemas/group_groupid_clients_response_data_types400","kind":"json-schema","title":"Root Type for group_groupid_clients_response_data_types400","data":{"title":"Root Type for group_groupid_clients_response_data_types400","type":"object","properties":{"success":{"type":"boolean","description":"Execution success status"},"data":{"type":"string","description":"Contains null"},"meta":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"description":"Object with error message"}},"description":"Get chain client by phone number","example":{"success":false,"meta":{"message":"Client not found"}}}},"components/schemas/loyalty_notification_message_template_request":{"id":"components/schemas/loyalty_notification_message_template_request","kind":"json-schema","title":"Root Type for LoyaltyNotificationMessageTemplateRequest","data":{"title":"Root Type for LoyaltyNotificationMessageTemplateRequest","type":"object","properties":{"type":{"type":"string","description":"Template option","enum":["none","big","mid","small","custom"]},"body":{"type":"string","description":"Template text (custom only)"}},"description":"Body of the request to bind the loyalty notification template","example":{"type":"custom","body":"Message text"}}},"components/schemas/loyalty_program_rule_request":{"id":"components/schemas/loyalty_program_rule_request","kind":"json-schema","title":"Root Type for LoyaltyProgramRuleRequest","data":{"title":"Root Type for LoyaltyProgramRuleRequest","type":"object","properties":{"parameter":{"type":"integer","description":"Rule Threshold (0 for Fixed Stock Types)","format":"int32"},"value":{"type":"number","description":"The value of the discount or bonus","format":"double"},"service_id":{"type":"integer","description":"Service ID (only for \"Discount by condition\" promotion)","format":"int32"}},"description":"The body of the request to change the rule for the loyalty promotion","example":{"parameter":10,"value":2.5,"service_id":0}}},"components/schemas/loyalty_program_create_request":{"id":"components/schemas/loyalty_program_create_request","kind":"json-schema","title":"Root Type for LoyaltyProgramCreateRequest","data":{"title":"Root Type for LoyaltyProgramCreateRequest","required":["company_ids","good_item_type","rules","service_item_type","title","type","value_unit"],"type":"object","properties":{"title":{"type":"string","description":"Share name"},"type":{"type":"string","description":"Promotion type","enum":["discount_static","discount_accumulative_visits","discount_accumulative_sold","discount_accumulative_paid","cashback_static_sold","cashback_static_paid","cashback_accumulative_paid","cashback_accumulative_sold","cashback_accumulative_paid_visits","cashback_accumulative_sold_visits","cashback_sold_visits","cashback_paid_visits","package_discount"]},"service_item_type":{"type":"string","description":"Type of application to services","enum":["any_allowed","not_allowed","custom_allowed"]},"good_item_type":{"type":"string","description":"Type of application to products","enum":["any_allowed","not_allowed","custom_allowed"]},"value_unit":{"type":"string","description":"Bonus or discount measurement unit (percentage, fixed amount)","enum":["percent","amount"]},"usage_limit":{"type":"integer","description":"Limit on the number of applications (only for cashback)","format":"int32"},"visit_multiplicity":{"type":"integer","description":"Multiplicity of application by visits (only for cashback)","format":"int32"},"sold_items_multiplicity":{"type":"integer","description":"How many services you need to pay to get a discount on promotional services (only for the promotion type \"Discount by condition\")","format":"int32"},"expiration_timeout":{"type":"integer","description":"Expiration date of bonuses or discounts","format":"int32"},"expiration_timeout_unit":{"type":"string","description":"The unit of measurement for the expiration date of bonuses or discounts","enum":["day","week","month","year"]},"expiration_notification_timeout":{"type":"integer","description":"How many days before the bonus or discount expires, a notification must be sent to the client","format":"int32"},"params_source_type":{"type":"string","description":"Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)","enum":["loyalty_card","active_companies","chain"]},"history_start_date":{"type":"string","description":"From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)","format":"date"},"loyalty_card_type_ids":{"type":"array","description":"Identifiers of types of cards for which the promotion is valid","items":{"type":"integer","format":"int32"}},"on_changed_notification_template":{"$ref":"#/components/schemas/loyalty_notification_message_template_request"},"on_expiration_notification_template":{"$ref":"#/components/schemas/loyalty_notification_message_template_request"},"rules":{"type":"array","description":"Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions)","items":{"$ref":"#/components/schemas/loyalty_program_rule_request"}},"company_ids":{"type":"array","description":"Identifiers of locations where the promotion is valid","items":{"type":"integer","format":"int32"}},"allowed_service_ids":{"type":"array","description":"Service and service category identifiers (if application type is set for some services)","items":{"type":"integer","format":"int32"}},"allowed_good_ids":{"type":"array","description":"Item IDs (if application type is set for some items)","items":{"type":"integer","format":"int32"}},"allowed_good_category_ids":{"type":"array","description":"Product category identifiers (if application type is set for some products)","items":{"type":"integer","format":"int32"}}},"description":"The body of the request to create a loyalty promotion","example":{"title":"Cumulative discount for some services and not for goods","type":"discount_accumulative_paid","service_item_type":"custom_allowed","good_item_type":"not_allowed","allowed_service_ids":[53,92],"allowed_good_ids":[],"allowed_good_category_ids":[],"value_unit":"percent","usage_limit":0,"visit_multiplicity":0,"sold_items_multiplicity":0,"expiration_timeout":6,"expiration_timeout_unit":"month","expiration_notification_timeout":7,"params_source_type":"chain","history_start_date":"2026-09-21","loyalty_card_type_ids":[51,29],"on_changed_notification_template":{"type":"custom","body":"Your discount has changed"},"on_expiration_notification_template":{"type":"big"},"rules":[{"parameter":10,"value":2.5,"service_id":0},{"parameter":30,"value":7.5,"service_id":0}],"company_ids":[49]}}},"components/schemas/loyalty_notification_message_template":{"id":"components/schemas/loyalty_notification_message_template","kind":"json-schema","title":"Root Type for LoyaltyNotificationMessageTemplate","data":{"title":"Root Type for LoyaltyNotificationMessageTemplate","type":"object","properties":{"id":{"type":"integer","description":"Template ID","format":"int32"},"type":{"type":"string","description":"Template option","enum":["big","mid","small","custom"]},"body":{"type":"string","description":"Template text"},"message_type":{"type":"string","description":"Message type","enum":["loyalty_discount_expiration","loyalty_cashback_expiration","loyalty_discount_increased","loyalty_discount_decreased","loyalty_card_created","loyalty_card_withdraw","loyalty_withdraw_cancelled","loyalty_card_manual","loyalty_card_manual_withdraw","loyalty_card_cashback","loyalty_card_cashback_cancelled","loyalty_card_income","loyalty_discount_changed","loyalty_cashback_changed","loyalty_settings_abonement_notification"]}},"description":"Loyalty notification template","example":{"id":12,"type":"small","message_type":"loyalty_discount_expiration","body":"Your discount expires tomorrow"}}},"components/schemas/loyalty_program_rule":{"id":"components/schemas/loyalty_program_rule","kind":"json-schema","title":"Root Type for LoyaltyProgramRule","data":{"title":"Root Type for LoyaltyProgramRule","type":"object","properties":{"id":{"type":"integer","description":"Rule ID","format":"int32"},"parameter":{"type":"integer","description":"Rule Threshold (0 for Fixed Stock Types)","format":"int32"},"value":{"type":"number","description":"The value of the discount or bonus","format":"float"},"loyalty_program_id":{"type":"integer","description":"Loyalty promotion ID","format":"int32"},"loyalty_type_id":{"type":"integer","description":"Loyalty promotion type ID","format":"int32"},"service_id":{"type":"integer","description":"Service ID (only for \"Discount by condition\" promotion)","format":"int32"}},"description":"Loyalty promotion rule","example":{"id":34,"parameter":0,"value":3.5,"loyalty_program_id":123,"loyalty_type_id":5,"service_id":0}}},"components/schemas/company":{"id":"components/schemas/company","kind":"json-schema","title":"company","data":{"required":["address","city","city_id","coordinate_lat","coordinate_lng","country","country_id","id","phone","timezone","title"],"type":"object","properties":{"id":{"type":"number","description":"location ID"},"title":{"type":"string","description":"Name of the organization"},"country":{"type":"string","description":"The name of the country in which the organization is located"},"country_id":{"type":"number","description":"Country ID"},"city":{"type":"string","description":"Name of the city where the organization is located"},"city_id":{"type":"number","description":"City ID"},"phone":{"type":"string","description":"location phone"},"timezone":{"type":"string","description":"location time zone"},"address":{"type":"string","description":"location address"},"coordinate_lat":{"type":"number","description":"Latitude"},"coordinate_lng":{"type":"number","description":"Longitude"}}}},"components/schemas/loyalty_entity_attendance_item":{"id":"components/schemas/loyalty_entity_attendance_item","kind":"json-schema","title":"Root Type for LoyaltyEntityAttendanceItem","data":{"title":"Root Type for LoyaltyEntityAttendanceItem","type":"object","properties":{"id":{"type":"integer","description":"Related entity ID","format":"int32"},"title":{"type":"string","description":"Related entity name"},"is_service":{"type":"boolean","description":"Flag: true - service/category of services, false - product/category of products"},"is_category":{"type":"boolean","description":"Flag: true - service/product category, false - service/product"}},"description":"The entity to which the action applies (if applied selectively)","example":{"id":234,"title":"Product category","is_service":false,"is_category":true}}},"components/schemas/loyalty_program":{"id":"components/schemas/loyalty_program","kind":"json-schema","title":"loyalty_program","data":{"type":"object","properties":{"id":{"type":"integer","description":"Stock ID","format":"int32"},"title":{"type":"string","description":"Share name"},"type":{"type":"string","description":"Promotion type","enum":["discount_static","discount_accumulative_visits","discount_accumulative_sold","discount_accumulative_paid","cashback_static_sold","cashback_static_paid","cashback_accumulative_paid","cashback_accumulative_sold","cashback_accumulative_paid_visits","cashback_accumulative_sold_visits","cashback_sold_visits","cashback_paid_visits","package_discount"]},"service_item_type":{"type":"string","description":"Type of application to services","enum":["any_allowed","not_allowed","custom_allowed"]},"good_item_type":{"type":"string","description":"Type of application to products","enum":["any_allowed","not_allowed","custom_allowed"]},"value_unit":{"type":"string","description":"Bonus or discount measurement unit (percentage, fixed amount)","enum":["percent","amount"]},"usage_limit":{"type":"integer","description":"Limit on the number of applications (only for cashback)","format":"int32"},"visit_multiplicity":{"type":"integer","description":"Multiplicity of application by visits (only for cashback)","format":"int32"},"sold_items_multiplicity":{"type":"integer","description":"How many services you need to pay to get a discount on promotional services (only for the type of promotion \"Discount by condition\")","format":"int32"},"expiration_timeout":{"type":"integer","description":"Expiration date of bonuses or discounts","format":"int32"},"expiration_timeout_unit":{"type":"string","description":"The unit of measurement for the expiration date of bonuses or discounts","enum":["day","week","month","year"]},"expiration_notification_timeout":{"type":"integer","description":"How many days before the bonus or discount expires, a notification must be sent to the client","format":"int32"},"params_source_type":{"type":"string","description":"Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)","enum":["loyalty_card","active_companies","chain"]},"history_start_date":{"type":"string","description":"From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)","format":"date"},"on_changed_notification_template_id":{"type":"integer","description":"Notification template ID when changing bonus or discount","format":"int32"},"on_expiration_notification_template_id":{"type":"integer","description":"Identifier of the notification template when a bonus or discount burns","format":"int32"},"loyalty_card_types":{"type":"array","description":"Type of cards for which the promotion is valid (on request)","items":{"$ref":"#/components/schemas/loyalty_card_type"}},"on_changed_notification_template":{"$ref":"#/components/schemas/loyalty_notification_message_template"},"on_expiration_notification_template":{"$ref":"#/components/schemas/loyalty_notification_message_template"},"rules":{"type":"array","description":"Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions) (on request)","items":{"$ref":"#/components/schemas/loyalty_program_rule"}},"companies":{"type":"array","description":"Locations where the promotion is valid (on request)","items":{"$ref":"#/components/schemas/company"}},"applicable_items":{"type":"array","description":"Related entities for selective application of the promotion (on request)","items":{"$ref":"#/components/schemas/loyalty_entity_attendance_item"}}},"description":"Loyalty promotion","example":{"id":34,"title":"Cumulative discount for some services and not for goods","type":"discount_accumulative_paid","service_item_type":"custom_allowed","good_item_type":"not_allowed","value_unit":"percent","usage_limit":0,"visit_multiplicity":0,"sold_items_multiplicity":0,"expiration_timeout":6,"expiration_timeout_unit":"month","expiration_notification_timeout":7,"params_source_type":"chain","history_start_date":"2026-09-21","on_changed_notification_template_id":55,"on_expiration_notification_template_id":84,"loyalty_card_types":[{"id":51,"title":"Card type 1"},{"id":29,"title":"Card type 2"}],"on_changed_notification_template":{"id":55,"type":"custom","body":"Your discount has changed","message_type":"loyalty_discount_changed"},"on_expiration_notification_template":{"id":84,"type":"big","body":"Detailed text about discount burning","message_type":"loyalty_discount_expiration"},"rules":[{"id":94,"parameter":10,"value":2.5,"loyalty_program_id":34,"loyalty_type_id":3,"service_id":0},{"id":74,"parameter":30,"value":7.5,"loyalty_program_id":34,"loyalty_type_id":3,"service_id":0}],"companies":[{"id":49,"title":"Location","country":"United States","country_id":5,"city":"New York","city_id":83,"phone":"+13155550175","timezone":"America/New_York","address":"Location address","coordinate_lat":40.73061,"coordinate_lng":18.63}],"applicable_items":[{"id":53,"title":"Service category 1","is_service":true,"is_category":true},{"id":92,"title":"Service category 2","is_service":true,"is_category":true}]}}},"components/schemas/loyalty_program_update_request":{"id":"components/schemas/loyalty_program_update_request","kind":"json-schema","title":"Root Type for LoyaltyProgramUpdateRequest","data":{"title":"Root Type for LoyaltyProgramUpdateRequest","type":"object","properties":{"title":{"type":"string","description":"Share name"},"usage_limit":{"type":"integer","description":"Limit on the number of applications (only for cashback)","format":"int32"},"expiration_timeout":{"type":"integer","description":"Expiration date of bonuses or discounts","format":"int32"},"expiration_timeout_unit":{"type":"string","description":"The unit of measurement for the expiration date of bonuses or discounts","enum":["day","week","month","year"]},"expiration_notification_timeout":{"type":"integer","description":"How many days before the bonus or discount expires, a notification must be sent to the client","format":"int32"},"loyalty_card_type_ids":{"type":"array","description":"Identifiers of types of cards for which the promotion is valid","items":{"type":"integer","format":"int32"}},"on_changed_notification_template":{"$ref":"#/components/schemas/loyalty_notification_message_template_request"},"on_expiration_notification_template":{"$ref":"#/components/schemas/loyalty_notification_message_template_request"},"rules":{"type":"array","description":"Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions)","items":{"$ref":"#/components/schemas/loyalty_program_rule_request"}},"company_ids":{"type":"array","description":"Identifiers of locations where the promotion is valid","items":{"type":"integer","format":"int32"}},"allowed_service_ids":{"type":"array","description":"Service and service category identifiers (if application type is set for some services)","items":{"type":"integer","format":"int32"}},"allowed_good_ids":{"type":"array","description":"Item IDs (if application type is set for some items)","items":{"type":"integer","format":"int32"}},"allowed_good_category_ids":{"type":"array","description":"Product category identifiers (if application type is set for some products)","items":{"type":"integer","format":"int32"}}},"description":"The body of the request to change the loyalty promotion","example":{"title":"Cumulative discount for some services and not for goods","allowed_service_ids":[53,92],"allowed_good_ids":[],"allowed_good_category_ids":[],"usage_limit":0,"expiration_timeout":6,"expiration_timeout_unit":"month","expiration_notification_timeout":7,"loyalty_card_type_ids":[51,29],"on_changed_notification_template":{"type":"custom","body":"Your discount has changed"},"on_expiration_notification_template":{"type":"big"},"rules":[{"parameter":10,"value":2.5,"service_id":0},{"parameter":30,"value":7.5,"service_id":0}],"company_ids":[49]}}},"components/schemas/loyalty_transaction":{"id":"components/schemas/loyalty_transaction","kind":"json-schema","title":"Root Type for LoyaltyTransaction","data":{"title":"Root Type for LoyaltyTransaction","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":"Transaction ID"},"visit_id":{"type":"number","description":"Visit ID"},"status_id":{"type":"number","description":"Transaction status ID"},"amount":{"type":"number","description":"Loyalty payment amount","format":"double"},"type_id":{"type":"number","description":"Type of loyalty transaction"},"card_id":{"type":"number","description":"Loyalty card ID"},"program_id":{"type":"number","description":"Loyalty program ID"},"certificate_id":{"type":"number","description":"Loyalty certificate ID"},"abonement_id":{"type":"number","description":"Loyalty membership ID"},"salon_group_id":{"type":"number","description":"ID of the location chain, within the loyalty of which this transaction was created"},"item_id":{"type":"number","description":"Position ID in the order, if the transaction is related to the sale of a product or service"},"item_type_id":{"type":"number","description":"Item type in the order to which this transaction relates (1 Provision of service, 7 Sale of products), if applicable"},"item_record_id":{"type":"number","description":"ID of the appointment to which the item in the order belongs, if applicable"},"goods_transaction_id":{"type":"number","description":"Item sale transaction ID"},"services_transaction_id":{"type":"number","description":"Service Transaction ID"},"is_discount":{"type":"boolean"},"is_loyalty_withdraw":{"type":"boolean"},"type":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"}}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of items in the response)"}},"description":"Loyalty transaction"}},"components/schemas/tax_system_response_data__types":{"id":"components/schemas/tax_system_response_data__types","kind":"json-schema","title":"Root Type for tax_system_response_data_Types","data":{"title":"Root Type for tax_system_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":{"title":{"type":"string","description":"Name of the taxation system"},"slug":{"type":"string","description":"Code name for the taxation system"},"vats":{"type":"array","description":"List of available VAT for the taxation system","items":{"type":"object","properties":{"title":{"type":"string","description":"Name of VAT"},"slug":{"type":"string","description":"VAT code name"}}}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of taxation systems found)"}},"description":"List request example","example":{"success":true,"data":[{"title":"General DOS","slug":"ru_osn","vats":[{"title":"0%","slug":"ru_vat_0"},{"title":"10%","slug":"ru_vat_10"},{"title":"20%","slug":"ru_vat_20"},{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Simplified simplified tax system (Income)","slug":"ru_usn","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Simplified simplified tax system (Income minus Expense)","slug":"ru_usnr","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Single tax on imputed income UTII","slug":"ru_envd","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Unified agricultural tax UST","slug":"ru_esn","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Patent taxation system","slug":"ru_psn","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]}],"meta":{"count":6}}}},"components/schemas/fiscalization_request_data_types":{"id":"components/schemas/fiscalization_request_data_types","kind":"json-schema","title":"Root Type for fiscalization_request_data_types","data":{"title":"Root Type for fiscalization_request_data_types","type":"object","properties":{"id":{"type":"string","description":"Unique ID of the sales document"},"date":{"type":"string","description":"Date and time the document was sent for printing (in ISO-8601 format)","format":"date-time"},"document_id":{"type":"integer","description":"Internal document identifier in the Altegio system","format":"int32"},"type":{"type":"string","description":"Document type (list of possible values)","enum":["sale","return"]},"print_receipt":{"type":"boolean","description":"Whether to print a paper check at the checkout during fiscalization"},"customer":{"type":"object","properties":{"email":{"type":"string","description":"Client Email"},"phone":{"type":"string","description":"Customer phone"}},"description":"Client entity"},"positions":{"type":"array","description":"List of positions in the check","items":{"type":"object","properties":{"type":{"type":"string","description":"Position type (\"service\" - service / \"commodity\" - product / \"payment\" - payment)"},"title":{"type":"string","description":"Position name"},"price":{"type":"number","description":"Position price with an accuracy of 2 decimal places","format":"double"},"quantity":{"type":"integer","description":"Quantity","format":"int32"},"discount_amount":{"type":"number","description":"Discount applied to a position with an accuracy of 2 decimal places","format":"double"},"vat":{"type":"string","description":"Type of VAT (slug from VAT list)"},"payment_method":{"type":"string","description":"Settlement sign (\"payment\" - payment / \"prepayment\" - prepayment)"},"barcode":{"type":"string","description":"Product barcode"}}}},"payments":{"type":"array","description":"List of fees applied per check","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of payment (\"card\" - non-cash payment / \"cash\" - cash payment / \"prepaid\" - advance payment)"},"sum":{"type":"number","description":"Payment amount with an accuracy of 2 decimal places","format":"double"}}}},"tax":{"type":"string","description":"Type of taxation system (slug from the list of taxation systems)"},"cashier":{"type":"object","properties":{"uid":{"type":"string","description":"Cashier ID"},"name":{"type":"string","description":"Cashier's name"},"position":{"type":"string","description":"Cashier position (maximum line length - 64 characters)"}},"description":"The Essence of a Cashier"},"pos":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is it necessary to accept a card through a POS-terminal before fiscalization?"},"slip_count":{"type":"integer","description":"Number of receipts to be printed after a successful POS transaction","format":"int32"}},"description":"Options for the connected POS terminal"},"callback_url":{"type":"string","description":"Link to update fiscal status"},"custom_text":{"type":"string","description":"Arbitrary text for printing on a receipt"}},"description":"Example of a request for fiscalization of a document","example":{"id":"d72fece5-6825-4895-9395-0133195612a4","date":"2026-09-21T23:00:00.000-05:00","document_id":239083104,"type":"sale","print_receipt":true,"customer":{"email":"customer@example.com","phone":"+13155550175"},"positions":[{"type":"service","title":"Consultation","price":13.19,"quantity":1,"discount_amount":2.54,"vat":"ru_vat_10","payment_method":"payment","barcode":"12345"}],"payments":[{"type":"card","sum":5.55},{"type":"cash","sum":4.55},{"type":"prepaid","sum":0.55}],"tax":"ru_osn","cashier":{"uid":"4895-9395-0133195612a4","name":"John Smith","position":"Cashier"},"pos":{"enabled":true,"slip_count":2},"callback_url":"https://app.alteg.io/api/v1/integration/kkm/callback/","custom_text":"some custom text"}}},"components/schemas/license_option":{"id":"components/schemas/license_option","kind":"json-schema","title":"license_option","data":{"required":["id","title"],"type":"object","properties":{"id":{"type":"number","description":"option id"},"title":{"type":"string","description":"Option name"}}}},"components/schemas/image":{"id":"components/schemas/image","kind":"json-schema","title":"image","data":{"required":["height","id","image_group_id","path","type","version","width"],"type":"object","properties":{"id":{"type":"number","description":"image id"},"path":{"type":"string","description":"Image Path"},"width":{"type":"number","description":"Image Width"},"height":{"type":"number","description":"Image Height"},"type":{"type":"string","description":"Image type"},"image_group_id":{"type":"number","description":"Image group id"},"version":{"type":"string","description":"Image version"}}}},"components/schemas/image_group":{"id":"components/schemas/image_group","kind":"json-schema","title":"image_group","data":{"required":["id","image_binded","image_group","images"],"type":"object","properties":{"id":{"type":"number","description":"image group id"},"entity":{"type":"string","description":"The name of the entity to which the group is bound"},"entity_id":{"type":"number","description":"Entity ID"},"images":{"$ref":"#/components/schemas/image"},"image_binded":{"type":"boolean","description":"The status of linking images to an entity"},"image_group":{"type":"object","description":"Image group object"}}}},"components/schemas/tips_setting_response_data_types":{"id":"components/schemas/tips_setting_response_data_types","kind":"json-schema","title":"Root Type for tips_setting_response_data_types","data":{"title":"Root Type for tips_setting_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":"Setting ID"},"location_id":{"type":"integer","format":"int32"},"staff_id":{"type":"number","description":"team member ID"},"hash":{"type":"string","description":"Hash token"},"status":{"type":"number","description":"Setting status"},"status_title":{"type":"string","description":"Status name"},"is_enabled":{"type":"boolean","description":"Is tip setting enabled"},"landing_external":{"type":"string"},"master_tips_form_link":{"type":"string","description":"Link to the page where you can leave a tip to the team member"},"invite_sms_sent":{"type":"boolean"},"staff":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"name":{"type":"string","description":"Team Member name"},"specialization":{"type":"string","description":"Specialization"},"avatar":{"type":"string","description":"Path to team member profile picture"},"employee":{"type":"object","properties":{"id":{"type":"number","description":"team member ID"},"phone":{"type":"string","description":"Telephone"}},"description":"team member"},"user":{"type":"object","properties":{"id":{"type":"number","description":"User ID"},"name":{"type":"string","description":"Username"},"email":{"type":"string","description":"User email address"},"phone":{"type":"string","description":"User phone"}},"description":"User"},"position":{"type":"object","properties":{"id":{"type":"number","description":"Job ID"},"title":{"type":"string","description":"Job title"}},"description":"Position"}},"description":"Team Member"}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","format":"int32"}},"description":"Metadata (contains the number of found team members)"}},"description":"Get a list of location team members with their tips","example":{"success":true,"data":[{"id":1,"location_id":253859,"staff_id":742418,"hash":"ba816199-eecf-4bd2-9f1d-db470545bfaf","status":3,"status_title":"pending account","is_enabled":true,"landing_external":"https://app.alteg.io/tips/external/253859/ba816199-eecf-4bd2-9f1d-db470545bfaf/","master_tips_form_link":"https://app.alteg.io/companies/253859/staff/742418/tips/pay/","invite_sms_sent":false,"staff":{"id":742418,"name":"Fusa","specialization":"cosmetologist","avatar":"https://assets.alteg.io/masters/sm/c/c7/c77a4bf2b6b3896_20210304004333.png","employee":{"id":733043,"phone":"+13155550175"},"user":{"id":1553930,"name":"James Smith","email":"j.smith@example.com","phone":"+13155550175"},"position":{"id":103883,"title":"Yogist"}}},{"id":152763,"location_id":253859,"staff_id":743018,"hash":"b7c81cab-290a-4b0a-ad05-9c4b98ef3565","status":4,"status_title":"everything is set","is_enabled":true,"landing_external":"https://app.alteg.io/tips/external/253859/b7c81cab-290a-4b0a-ad05-9c4b98ef3565/","master_tips_form_link":"https://app.alteg.io/companies/253859/staff/743018/tips/pay/","invite_sms_sent":false,"staff":{"id":743018,"name":"Natasha M","specialization":"manicurist","avatar":"https://api.alteg.io/images/no-master-sm.png","employee":{"id":733547,"phone":"+13155550175"},"user":{"id":6259059,"name":"Alice Smith","email":"a.smith@example.com","phone":"+13155550175"},"position":{"id":103731,"title":"Manicurist"}}}],"meta":{"count":2}}}},"schema_279":{"kind":"json-schema","data":{"type":"string"},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"number"},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["staff","positions","accounts","storages","expenses"]}},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"string","default":"application/vnd.api.v2+json"},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"required":["master_id","seance_length","technological_card_id"],"type":"object","properties":{"master_id":{"type":"number","description":"ID of a team member who provides the service.","example":123},"seance_length":{"type":"number","description":"Duration of service provision by the specified team member in seconds,\nminimum 300 seconds (5 minutes), maximum 86100 seconds (23 hours 55 minutes).\n","example":3600},"technological_card_id":{"type":["number","null"],"description":"ID of bill of materials used while providing the service.","example":123}}},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/master_service_link"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"required":["seance_length","technological_card_id"],"type":"object","properties":{"seance_length":{"type":"number","description":"Duration of service provision by the specified team member in seconds,\nminimum 300 seconds (5 minutes), maximum 86100 seconds (23 hours 55 minutes).\n","example":3600},"technological_card_id":{"type":["number","null"],"description":"ID of bill of materials used while providing the service.","example":123}}},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"object","required":["service_id","team_member_settings","resource_ids","translations"],"properties":{"service_id":{"type":"integer","description":"Service ID to update","example":10832939},"team_member_settings":{"type":"array","description":"List of team members providing this service with duration and tech cards","items":{"type":"object","properties":{"team_member_id":{"type":"integer","description":"Team member ID","example":2033728},"tech_card_id":{"type":"integer","description":"Tech card ID for this team member's service delivery","example":291341},"hours":{"type":"integer","description":"Service duration hours","minimum":0,"example":0},"minutes":{"type":"integer","description":"Service duration minutes","minimum":0,"maximum":59,"example":45},"price":{"oneOf":[{"type":"object","description":"Custom price for this team member.\nSet to null to use default service price.\n","properties":{"min":{"type":"number","format":"float","description":"Minimum price (\"from\" price)","example":999.99},"max":{"oneOf":[{"type":"number","format":"float"},{"type":"null"}],"description":"Maximum price (\"to\" price), null for fixed price","example":null}}},{"type":"null"}]}}}},"resource_ids":{"type":"array","description":"List of resource IDs required to provide this service","items":{"type":"integer"},"example":[62173]},"translations":{"type":"array","description":"Service name translations for different languages","items":{"type":"object","properties":{"language_id":{"type":"integer","description":"Language ID","example":2},"translation":{"type":"string","description":"Translated service name (empty string to clear)","example":"Massage"}}}}}},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object"},"meta":{"type":"array","example":[]}}},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object"}}},"id":"schema_290"},"schema_291":{"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_291"},"schema_292":{"kind":"json-schema","data":{"type":"string","enum":["services"]},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/service_category_title"}},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"required":["name","specialization","position_id","phone_number","user_email","user_phone","is_user_invite"],"type":"object","properties":{"name":{"type":"string","description":"Name of a team member.","example":"John Johnson"},"specialization":{"type":"string","description":"Specialization of a team member.","example":"Cosmetologist"},"position_id":{"type":["number","null"],"description":"ID of a position that should be linked to a team member.","example":123},"phone_number":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Phone number of a user that should be linked to a team member (without \"+\", 9 to 15 digits)."},"children":[]}]}]}],"example":11234567890},"user_email":{"type":"string","format":"email","description":"Email address of the user to be created or linked to the team member.","example":"john.johnson@example.com"},"user_phone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User phone number (without \"+\", 9 to 15 digits). Can be the same as phone_number or different for user account login."},"children":[]}]}]}],"example":11234567890},"is_user_invite":{"type":"boolean","description":"Whether to send an invitation email to the user. Set to true to send invitation, false to create without sending invitation.","example":false},"is_paid_staff":{"type":"boolean","description":"Whether the team member is a paid staff member.","example":false}}},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/master_with_position"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"required":["title"],"type":"object","properties":{"title":{"type":"string","description":"Title of a position.","example":"Position"}}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/position"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"required":["name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Client name"},"surname":{"type":"string","description":"Client surname"},"middle_name":{"type":"string","description":"Client middle name"},"phone":{"type":"string","description":"Customer phone"},"email":{"type":"string","description":"Client Email"},"gender_id":{"type":"number","description":"Gender of the client (1 - male, 2 - female, 0 - unknown)"},"importance_id":{"type":"number","description":"Client priority level (0 - none, 1 - bronze, 2 - silver, 3 - gold)"},"discount":{"type":"number","description":"Customer Discount"},"card":{"type":"string","description":"Client card number"},"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. For a location in Kazakhstan the value must be a valid individual IIN — 12 digits with a correct check digit — otherwise the request is rejected with 422 Unprocessable Entity. Optional."},"children":[]}]}]}]},"birth_date":{"type":"string","description":"Date of birth of the client in the format yyyy-mm-dd"},"comment":{"type":"string","description":"A comment"},"spent":{"type":"number","description":"How much money spent in the location at the time of adding"},"balance":{"type":"number","description":"Client balance"},"sms_check":{"type":"number","description":"1 - Happy Birthday by SMS, 0 - do not congratulate"},"sms_not":{"type":"number","description":"1 - Exclude the client from SMS mailings, 0 - do not exclude"},"categories":{"type":"object","description":"Array of customer tag IDs"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Array of additional client fields as \"api-key\": \"value\" pairs"}},"example":{"name":"James","surname":"Smith","middle_name":"James","phone":13155550179,"email":"j.smith@example.com","gender_id":1,"discount":15,"importance_id":1,"card":555888666,"birth_date":"952041600","comment":"throws show-off","sms_check":0,"sms_not":0,"spent":1000,"balance":-200,"categories":[101,102],"custom_fields":{"key-1":"value-1"},"national_id":"950315300129"}},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"required":["name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Client name"},"surname":{"type":"string","description":"Client surname"},"middle_name":{"type":"string","description":"Client middle name"},"phone":{"type":"string","description":"Customer phone"},"email":{"type":"string","description":"Client Email"},"gender_id":{"type":"number","description":"Gender of the client (1 - male, 2 - female, 0 - unknown)"},"importance_id":{"type":"number","description":"Client priority level (0 - none, 1 - bronze, 2 - silver, 3 - gold)"},"discount":{"type":"number","description":"Customer Discount"},"card":{"type":"string","description":"Client card number"},"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. For a location in Kazakhstan the value must be a valid individual IIN — 12 digits with a correct check digit — otherwise the request is rejected with 422 Unprocessable Entity. Optional."},"children":[]}]}]}]},"birth_date":{"type":"string","description":"Date of birth of the client in the format yyyy-mm-dd"},"comment":{"type":"string","description":"A comment"},"spent":{"type":"number","description":"How much money spent in the location at the time of adding"},"balance":{"type":"number","description":"Client balance"},"sms_check":{"type":"number","description":"1 - Happy Birthday by SMS, 0 - do not congratulate"},"sms_not":{"type":"number","description":"1 - Exclude the client from SMS mailings, 0 - do not exclude"},"labels":{"type":"object","description":"Array of customer tag IDs"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Array of additional client fields as \"api-key\": \"value\" pairs"}},"example":{"name":"James","surname":"Smith","middle_name":"James","phone":13155550179,"email":"j.smith@example.com","gender_id":1,"discount":15,"importance_id":1,"card":555888666,"birth_date":"952041600","comment":"throws show-off","sms_check":0,"sms_not":0,"spent":1000,"balance":-200,"labels":[101,102],"custom_fields":{"key-1":"value-1"},"national_id":"950315300129"}},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"required":["name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Client name"},"surname":{"type":"string","description":"Client surname"},"middle_name":{"type":"string","description":"Client middle name"},"phone":{"type":"string","description":"Customer phone"},"email":{"type":"string","description":"Client Email"},"gender_id":{"type":"number","description":"Gender of the client (1 - male, 2 - female, 0 - unknown)"},"importance_id":{"type":"number","description":"Client priority level (0 - none, 1 - bronze, 2 - silver, 3 - gold)"},"discount":{"type":"number","description":"Customer Discount"},"card":{"type":"string","description":"Client card number"},"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. For a location in Kazakhstan the value must be a valid individual IIN — 12 digits with a correct check digit — otherwise the row is skipped and reported in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional."},"children":[]}]}]}]},"birth_date":{"type":"string","description":"Date of birth of the client in the format yyyy-mm-dd"},"comment":{"type":"string","description":"A comment"},"spent":{"type":"number","description":"How much money spent in the location at the time of adding"},"balance":{"type":"number","description":"Client balance"},"sms_check":{"type":"number","description":"1 - Happy Birthday by SMS, 0 - do not congratulate"},"sms_not":{"type":"number","description":"1 - Exclude the client from SMS mailings, 0 - do not exclude"},"categories":{"type":"object","description":"Array of customer tag IDs"}},"example":[{"name":"James","surname":"Smith","middle_name":"James","phone":13155550181,"email":"j.smith@example.com","gender_id":1,"discount":15,"importance_id":1,"card":555888666,"birth_date":"952041600","comment":"throws show-off","sms_check":0,"sms_not":0,"spent":1000,"balance":-200,"categories":[101,102],"national_id":"950315300129"},{"name":"James","surname":"Smith","middle_name":"James","phone":13155550181},{"phone":13155550182},{"name":"James","surname":"Smith","middle_name":"James","phone":13155550183},{"name":"Theodore","surname":"Hicks","middle_name":"Richardson"}]},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/client_comment_container"}},"meta":{"$ref":"#/components/schemas/response_meta_count_object"}}},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"required":["text"],"type":"object","properties":{"text":{"type":"string","description":"Text of a comment for a client.","example":"Comment for a client"}}},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/client_comment_container"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"required":["client_id","client_phone","from","to","payment_statuses","attendance"],"type":"object","properties":{"client_id":{"type":["number","null"],"description":"Client ID.","example":123},"client_phone":{"type":["string","null"],"description":"Customer phone number.","example":13155550184},"from":{"type":["string","null"],"description":"Period start date.","format":"date","example":"2022-01-31"},"to":{"type":["string","null"],"description":"Period end date.","format":"date","example":"2022-02-01"},"payment_statuses":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit payment status:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is not paid, no payments were made for the visit;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_not_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is partially paid;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the visit is paid in full, there is no overpayment;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_over"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - there is an overpayment for the visit."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the filter by payment status is not required, then an empty array "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be passed."},"children":[]}]}]}],"items":{"type":"string","enum":["not_paid","paid_not_full","paid_full","paid_over"]}},"attendance":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visit status:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - the client did not come;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - waiting for the client;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - the client has arrived;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": - the client has confirmed the appointment."},"children":[]}]}]}],"enum":[-1,0,1,2]}}},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/client_visits_history"},"meta":{"$ref":"#/components/schemas/response_meta_date_paginator_object"}}},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["user_permissions"]}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/user_role_with_salon_and_user"}},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/user_role_permissions"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"object","properties":{"user_role":{"type":"string","description":"Name of role","enum":["worker","administrator","accountant","manager","owner","free_readonly","free_readonly_admin"]},"user_permissions":{"type":"array","description":"List of user permissions values","items":{"$ref":"#/components/schemas/user_permission_value"}},"staff_id":{"type":"number","description":"team member ID attached to user"}}},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"object","required":["invites"],"properties":{"invites":{"type":"array","description":"Array of invites","items":{"type":"object","properties":{"name":{"type":"string","description":"User name","example":"Olivia"},"search":{"type":"string","description":"Phone number or email address of the user","example":"mail@gmail.com"},"position":{"type":["string","null"],"description":"Position","example":"Administrator"},"user_role":{"type":["string","null"],"description":"Role name","enum":["worker","administrator","accountant","manager","owner"],"example":"administrator"},"user_permissions":{"type":["array","null"],"description":"List of user permissions","items":{"$ref":"#/components/schemas/user_permission_value"}},"staff_id":{"type":["number","null"],"description":"team member ID bound to user","example":12}}}}}},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"type":"object","properties":{"user_company_links":{"type":"array","description":"List of locations to copy the user to","items":{"type":"object","properties":{"company_id":{"type":"number","description":"location ID","example":123},"user_permissions":{"type":"array","description":"User permission values to override on copying","items":{"$ref":"#/components/schemas/user_permission_value"}}},"required":["company_id"]},"minItems":1,"uniqueItems":true}},"required":["user_company_links"]},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"type":"object","properties":{"user_company_links":{"type":"array","description":"List of locations to remove the user from","items":{"type":"object","properties":{"company_id":{"type":"number","description":"location ID","example":123}},"required":["company_id"]},"minItems":1,"uniqueItems":true}},"required":["user_company_links"]},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"required":["client_id","schedule_days_ids"],"type":"object","properties":{"client_id":{"type":"number","description":"ID of client for creating a client schedule.","example":123},"comer_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of client`s comer for creating a client schedule."},"children":[]}]}]}],"example":123},"schedule_days_ids":{"type":"array","description":"IDs of schedule series, min of 1 series, max of 7 series.","minItems":1,"maxItems":7,"items":{"type":"number","example":123}}}},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/timetable_event_schedule_client_schedule"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"required":["schedule_days_ids"],"type":"object","properties":{"schedule_days_ids":{"type":"array","description":"IDs of schedule series, min of 1 series, max of 7 series.","minItems":1,"maxItems":7,"items":{"type":"number","example":123}}}},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/event_dates_range"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/event_filter"}},"meta":{"$ref":"#/components/schemas/response_meta_count_object"}}},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"type":"object"},"id":"schema_320"},"schema_321":{"kind":"json-schema","data":{"required":["repeat_mode_id","title"],"type":"object","properties":{"title":{"type":"string","description":"Name"},"days":{"type":"array","description":"Recurrence Days for Weekly Mode","items":{"type":"object"}},"repeat_mode_id":{"type":"number","description":"Repeat Mode"},"interval":{"type":"number","description":"Break in searching for dates"},"content_type":{"type":"number","description":"Duplicate appointments? 1 - no, 2 - yes"}}},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"required":["date","is_working"],"type":"object","properties":{"date":{"type":"string","description":"date in iso8601 format."},"is_working":{"type":"boolean","description":"Free time or not."},"slots":{"type":"array","description":"An array of (from, to) working timeslots.","items":{"type":"object"}}}},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"required":["date","is_working","slots"],"type":"object","properties":{"date":{"type":"string","description":"date"},"is_working":{"type":"boolean","description":"Working date or not"},"slots":{"type":"object","description":"Array of (from, to) working hours"}},"example":[{"date":"2026-09-21T23:00:00.000-05:00","is_working":true,"slots":[{"from":"10:00","to":"14:30"},{"from":"15:00","to":"22:00"}]},{"date":"2026-09-21T23:00:00.000-05:00","is_working":true,"slots":[{"from":"10:00","to":"14:00"},{"from":"15:00","to":"23:15"}]}]},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"required":["is_free","time"],"type":"object","properties":{"time":{"type":"string","description":"Session time"},"is_free":{"type":"boolean","description":"free time or not"}}},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"type":"string","enum":["record","activity"]},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["days","days.events_master","days.events_labels","days.events_resource_instances"]}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/timetable_event_schedule"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["days"]}},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"required":["original_entity_type","original_entity_id","date_end","add_clients_from_original_entity","days"],"type":"object","properties":{"original_entity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of entity the schedule will be based on:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - individual appointment, currently not supported;"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - group event."},"children":[]}]}]}],"enum":["record","activity"],"example":"activity"},"original_entity_id":{"type":"number","description":"ID of entity the schedule will be based on.","example":123},"date_end":{"type":"string","description":"Date of the schedule end.","format":"date","example":"2022-02-01"},"add_clients_from_original_entity":{"type":"boolean","description":"Add clients from original entity to all scheduled events.","example":false},"days":{"type":"array","description":"Each object represents schedule series settings for a specific day of the week. A minimum of 1 and a maximum of 7 schedule series can be defined (one for each day of the week).","minItems":1,"maxItems":7,"items":{"required":["day_of_week","events_master_id","events_time","events_duration","events_capacity"],"type":"object","properties":{"day_of_week":{"type":"string","description":"The day of the week for the schedule series.","enum":["mon","tue","wed","thu","fri","sat","sun"],"example":"mon"},"events_master_id":{"type":"number","description":"The ID of the team member assigned to the events in the schedule series.","example":123},"events_time":{"type":"string","description":"Start time of the events in the schedule series, formatted as HH:MM:SS.","example":"14:00:00"},"events_duration":{"type":"number","description":"Duration of each event in the schedule series, in seconds.","example":3600},"events_capacity":{"type":"number","description":"The capacity of activities in the schedule series. For appointments, this should be set to 1.","example":4},"labels_ids":{"type":"array","description":"An array of tag IDs associated with the events in the schedule series.","items":{"type":"number","example":123}},"resource_instances_ids":{"type":"array","description":"An array of resource instance IDs used in the events of the schedule series.","items":{"type":"number","example":123}}}}}}},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"type":"object","properties":{"date_end":{"type":"string","description":"Date of the schedule end.","format":"date","example":"2022-02-01"}}},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["events_master","events_labels","events_resource_instances","events"]}},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"required":["day_of_week","events_master_id","events_time","events_duration","events_capacity"],"type":"object","properties":{"day_of_week":{"type":"string","description":"The day of the week for the schedule series.","enum":["mon","tue","wed","thu","fri","sat","sun"],"example":"mon"},"events_master_id":{"type":"number","description":"The ID of the team member assigned to the events in the schedule series.","example":123},"events_time":{"type":"string","description":"Start time of the events in the schedule series, formatted as HH:MM:SS.","example":"14:00:00"},"events_duration":{"type":"number","description":"Duration of each event in the schedule series, in seconds.","example":3600},"events_capacity":{"type":"number","description":"The capacity of activities in the schedule series. For appointments, this should be set to 1.","example":4},"labels_ids":{"type":"array","description":"An array of tag IDs associated with the events in the schedule series.","items":{"type":"number","example":123}},"resource_instances_ids":{"type":"array","description":"An array of resource instance IDs used in the events of the schedule series.","items":{"type":"number","example":123}}}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/timetable_event_schedule_day"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"required":["force"],"type":"object","properties":{"force":{"type":"boolean","description":"Flag for force override of manual changes in scheduled appointments/events.","example":false},"events_master_id":{"type":"number","description":"The ID of the team member assigned to the events in the schedule series.","example":123},"events_time":{"type":"string","description":"Start time of the events in the schedule series, formatted as HH:MM:SS.","example":"14:00:00"},"events_duration":{"type":"number","description":"Duration of each event in the schedule series, in seconds.","example":3600},"events_capacity":{"type":"number","description":"The capacity of activities in the schedule series. For appointments, this should be set to 1.","example":4},"labels_ids":{"type":"array","description":"An array of tag IDs associated with the events in the schedule series.","items":{"type":"number","example":123}},"resource_instances_ids":{"type":"array","description":"An array of resource instance IDs used in the events of the schedule series.","items":{"type":"number","example":123}}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/timetable_event_schedule_event"}},"meta":{"$ref":"#/components/schemas/response_meta_count_object"}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["busy_intervals","off_day_type"]}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"type":"object","properties":{"staff_id":{"type":"integer","description":"Team member ID","example":12345},"date":{"type":"string","format":"date","description":"Schedule date (YYYY-MM-DD)","example":"2026-01-31"},"slots":{"type":"array","description":"Working time intervals","items":{"type":"object","properties":{"from":{"type":"string","description":"Interval start time (HH:mm)","example":"10:00"},"to":{"type":"string","description":"Interval end time (HH:mm)","example":"19:00"}}}},"busy_intervals":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time intervals occupied by appointments or events."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=busy_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","properties":{"entity_type":{"type":"string","description":"Entity type occupying the interval","enum":["record","activity"],"example":"record"},"entity_id":{"type":"integer","description":"Entity ID (appointment or event ID)","example":456789},"from":{"type":"string","description":"Interval start time (HH:mm:ss)","example":"11:00:00"},"to":{"type":"string","description":"Interval end time (HH:mm:ss)","example":"12:00:00"}}}},"off_day_type":{"oneOf":[{"type":"integer"},{"type":"null"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Off-day type ID (if this is a non-working day)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include[]=off_day_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":3}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of schedule entries","example":15}}}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"type":"object","properties":{"schedules_to_set":{"type":"array","description":"Schedules to create or update","items":{"type":"object","properties":{"team_member_id":{"type":"integer","description":"Team member ID","example":12345},"dates":{"type":"array","description":"Dates to set schedule for (YYYY-MM-DD)","items":{"type":"string","format":"date"},"example":["2026-01-31","2026-02-01"]},"slots":{"type":"array","description":"Working time intervals","items":{"type":"object","properties":{"from":{"type":"string","description":"Interval start time (HH:mm)","example":"10:00"},"to":{"type":"string","description":"Interval end time (HH:mm)","example":"19:00"}}}}}}},"schedules_to_delete":{"type":"array","description":"Schedules to delete (make non-working days)","items":{"type":"object","properties":{"team_member_id":{"type":"integer","description":"Team member ID","example":12345},"dates":{"type":"array","description":"Dates to delete schedule for (YYYY-MM-DD)","items":{"type":"string","format":"date"},"example":["2026-02-02","2026-02-03"]}}}}}},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","description":"Resulting schedules for modified team members","items":{"type":"object","properties":{"team_member_id":{"type":"integer","example":12345},"date":{"type":"string","format":"date","example":"2026-01-31"},"slots":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","example":"10:00"},"to":{"type":"string","example":"19:00"}}}}}}},"meta":{"type":"object","properties":{"count":{"type":"integer","example":2}}}}},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","required":["date","is_working","slots"],"properties":{"date":{"type":"string","format":"date","description":"Schedule date (YYYY-MM-DD)","example":"2026-01-15"},"is_working":{"type":"boolean","description":"Whether the team member is working on this date","example":true},"slots":{"type":"array","description":"Working time intervals","items":{"type":"object","properties":{"from":{"type":"string","description":"Interval start time (HH:mm)","example":"10:00"},"to":{"type":"string","description":"Interval end time (HH:mm)","example":"14:30"}}}}}}},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"type":"object","properties":{"delete_consumables":{"type":"number","description":"Whether to remove consumables along with deleting bill of materials. Default 0"}},"example":[]},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/company_salonid_sale_documentid_payment_account"},{"$ref":"#/components/schemas/company_salonid_sale_documentid_payment_deposit"},{"$ref":"#/components/schemas/company_salonid_sale_documentid_payment_certificate"},{"$ref":"#/components/schemas/company_salonid_sale_documentid_payment_abonements"},{"$ref":"#/components/schemas/company_salonid_sale_documentid_payment_referal"},{"$ref":"#/components/schemas/company_salonid_sale_documentid_payment_loyalty_card"},{"$ref":"#/components/schemas/company_salonid_sale_documentid_payment_loyalty_program"}]},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Insufficient funds on the account. Refill your balance."}}}}},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","description":"Timeslot settings object","properties":{"is_enabled":{"type":"boolean","description":"Whether custom timeslots are enabled","example":true},"weekdays_settings":{"type":"array","description":"Settings for each day of the week","items":{"type":"object","properties":{"weekday":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of week (1 = Monday, 7 = Sunday)"},"children":[]}]}]}],"minimum":1,"maximum":7,"example":1},"timeslots":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available timeslots in seconds from midnight."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only used when grid_base_type = \"predefined\"."},"children":[]}]}]}],"items":{"type":"integer"},"example":[7200,14400,21600]},"setting":{"type":"object","description":"Grid generation rules","properties":{"grid_first_timeslot":{"type":"integer","description":"Earliest available slot time in seconds from midnight","example":0},"grid_last_timeslot":{"type":"integer","description":"Latest available slot time in seconds from midnight","example":85800},"grid_display_step":{"type":"integer","description":"Interval between displayed slots in seconds","example":7200},"grid_nearest_timeslot_delay":{"type":"integer","description":"Minimum delay before nearest available slot in seconds","example":1800},"grid_base_type":{"type":"string","description":"Grid type: predefined, schedule, or timeslots","enum":["predefined","schedule","timeslots"],"example":"predefined"},"is_grid_flexible":{"type":"boolean","description":"Whether to add a flexible slot option","example":false}}}}}},"dates_settings":{"type":"array","description":"Per-date overrides (e.g., holidays, special days)","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Date for override (YYYY-MM-DD)","example":"2026-12-25"},"timeslots":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available timeslots for this date (empty = unavailable)"},"children":[]}]}]}],"items":{"type":"integer"},"example":[]},"setting":{"type":"object","description":"Grid generation rules","properties":{"grid_first_timeslot":{"type":"integer","example":0},"grid_last_timeslot":{"type":"integer","example":85800},"grid_display_step":{"type":"integer","example":7200},"grid_nearest_timeslot_delay":{"type":"integer","example":1800},"grid_base_type":{"type":"string","enum":["predefined","schedule","timeslots"],"example":"predefined"},"is_grid_flexible":{"type":"boolean","example":false}}}}}}}},"meta":{"type":"array","example":[]}}},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/analytics_report_overall_chart_daily_row"}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/analytics_report_overall_chart_scalar_item"}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"string","enum":["common","client","record","activity"]},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"required":["account_id","amount","client_id","deposit_id"],"type":"object","properties":{"client_id":{"type":"number","description":"ID of the client, the owner of the client account"},"deposit_id":{"type":"number","description":"client account ID"},"amount":{"type":"number","description":"replenishment amount"},"master_id":{"type":"number","description":"team member ID"},"account_id":{"type":"number","description":"Checkout ID for payment"}}},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"type":"object","properties":{"deposit_transaction":{"type":"object","description":"Client account transaction details","properties":{"id":{"type":"integer","description":"Transaction ID","example":1},"salon_id":{"type":"integer","description":"Location ID where transaction occurred","example":720441},"salon_group_id":{"type":"integer","description":"Chain ID","example":706028},"user_id":{"type":"integer","description":"User ID associated with the client account","example":123456},"amount":{"type":"number","format":"double","description":"Transaction amount (positive for top-up, negative for withdrawal)","example":100.5},"balance_after":{"type":"number","format":"double","description":"Personal account balance after this transaction","example":12239.56},"reserved_balance_after":{"type":"number","format":"double","description":"Personal account reserved balance after this transaction","example":0},"date_create":{"type":"string","format":"date-time","description":"Transaction creation date and time","example":"2026-01-15T14:30:00.000000Z"},"comment":{"type":"string","description":"Transaction comment","example":"Top-up payment"},"deleted":{"type":"boolean","description":"Whether transaction has been deleted","example":false}}},"deposit_transaction_type":{"type":"object","description":"Transaction type information","properties":{"id":{"type":"integer","description":"Transaction type ID","example":1},"comment":{"type":"string","description":"Transaction type name","example":"Top-up"}}}}}},"meta":{"type":"array","example":[]}}},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string"}}}}},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/loyalty_card_type"}},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"required":["amount"],"type":"object","properties":{"amount":{"type":"number","description":"Withdraw/deposit amount. Positive for deposit, negative for withdraw.","example":100.5},"title":{"type":"string","description":"Optional comment"}}},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/loyalty_card"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"array","items":{"type":"number"}},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Membership instance ID","example":"5248829"},"type":{"type":"string","example":"loyalty_abonement"},"attributes":{"type":"object","properties":{"number":{"type":"string","description":"Subscription number","example":"690348"},"balance":{"type":"integer","description":"Remaining visits","example":10}}},"relationships":{"type":"object","properties":{"loyalty_abonement_type":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":"489159"},"type":{"type":"string","example":"loyalty_abonement_type"}}}}}}}}}},"included":{"type":"array","description":"Related membership types and availability intervals","items":{"type":"object"}}}},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Event not found"}}}}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Check result ID","example":"check_1"},"type":{"type":"string","example":"loyalty_abonement_check"},"attributes":{"type":"object","properties":{"last_booking_date":{"type":"string","format":"date-time","description":"Last possible appointment date (based on membership expiration)","example":"2026-03-31T23:59:59+00:00"},"available_visits":{"type":"integer","description":"Number of visits available in membership","example":10},"can_book_all_days":{"type":"boolean","description":"Whether membership can cover all requested schedule days","example":true},"bookable_day_ids":{"type":"array","description":"Schedule day IDs that can be booked","items":{"type":"integer"},"example":[1,2,3,4,5]}}}}}}},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Invalid schedule_day_ids"}}}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"string","enum":["discount_static","discount_accumulative_visits","discount_accumulative_sold","discount_accumulative_paid","cashback_static_sold","cashback_static_paid","cashback_accumulative_paid","cashback_accumulative_sold","cashback_accumulative_paid_visits","cashback_accumulative_sold_visits","cashback_sold_visits","cashback_paid_visits","package_discount"]},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"required":["data","meta","success"],"type":"object","properties":{"LoyaltyGenerateCode200Option":{"$ref":"#/components/schemas/loyalty_generate_code200_option"},"data":{"$ref":"#/components/schemas/loyalty_generate_code200_data_option"},"meta":{"type":"array","items":{"type":"object"}},"success":{"type":"boolean"}}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"required":["meta","success"],"type":"object","properties":{"LoyaltyGenerateCodeErrorOption":{"$ref":"#/components/schemas/loyalty_generate_code_error_option"},"meta":{"$ref":"#/components/schemas/loyalty_generate_code_error_meta_option"},"success":{"type":"boolean"}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/salary_staff_calculation_daily"},"meta":{"$ref":"#/components/schemas/response_meta_count_object"}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/salary_staff_calculation"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/salary_staff_schemes_count"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/salary_staff_calculation"}},"meta":{"$ref":"#/components/schemas/response_meta_count_object"}}},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/salary_payroll_calculation_container"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/salary_staff_period_daily"},"meta":{"$ref":"#/components/schemas/response_meta_count_object"}}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"$ref":"#/components/schemas/salary_staff_period"},"meta":{"$ref":"#/components/schemas/response_meta_empty_object"}}},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"$ref":"#/components/schemas/response_success_true_object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/salary_staff_scheme"}},"meta":{"$ref":"#/components/schemas/response_meta_count_object"}}},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"required":["freeze_till"],"type":"object","properties":{"freeze_till":{"type":"string","format":"date-time","description":"Date until which the membership will be frozen (ISO 8601 format)","example":"2026-12-31T23:59:59-05:00"}}},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"integer","example":123},"number":{"type":"string","example":"123456"},"is_frozen":{"type":"boolean","example":true},"freeze_period":{"type":"integer","description":"Total freeze period in days","example":14},"freeze_till":{"type":"string","format":"date-time","description":"Date until which membership is frozen","example":"2026-12-31T23:59:59-05:00"}}},"meta":{"type":"array","example":[]}}},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Subscription cannot be frozen"}}}}},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","additionalProperties":false,"properties":{"message":{"type":"string","example":"Freeze period exceeds limit"},"errors":{"type":"object","description":"Validation errors by field","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"type":"object","properties":{},"description":"Empty body required (or omit entirely)"},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"integer","example":123},"number":{"type":"string","example":"123456"},"is_frozen":{"type":"boolean","example":false},"freeze_period":{"type":"integer","description":"Total freeze period that was applied (in days)","example":14}}},"meta":{"type":"array","example":[]}}},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Subscription is not frozen"}}}}},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"object","properties":{"united_balance_services_count":{"type":"integer","description":"New visit count for unified balance subscriptions","example":10},"services_balance_count":{"type":"array","description":"New balance for separate balance subscriptions (per service/category)","items":{"type":"object","required":["service_id","balance"],"properties":{"service_id":{"type":"integer","description":"Service or category ID","example":13160808},"balance":{"type":"integer","description":"New visit count for this service/category","example":5}}},"example":[{"service_id":13160808,"balance":5},{"service_id":13160809,"balance":3}]}}},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"integer","example":123},"united_balance_services_count":{"type":"integer","example":10},"balance_container":{"type":"object","description":"Updated balance details"}}},"meta":{"type":"array","example":[]}}},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Cannot change balance"}}}}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Invalid service ID"}}}}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"required":["period","period_unit_id"],"type":"object","properties":{"period":{"type":"integer","description":"Duration value","example":90},"period_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period unit: 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"enum":[1,2,3,4],"example":1}}},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"integer","example":123},"period":{"type":"integer","description":"Updated period duration","example":90},"period_unit_id":{"type":"integer","description":"Period unit type","example":1},"expiration_date":{"type":"string","format":"date-time","description":"New expiration date","example":"2026-03-31T23:59:59+00:00"}}},"meta":{"type":"array","example":[]}}},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Cannot change period"}}}}},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Invalid period unit"}}}}},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/chain_loyalty_membership_type"}},"meta":{"type":"object","properties":{"total_count":{"type":"integer","example":5}}}}},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"required":["title","salon_group_id","cost","service_categories","is_united_balance","united_balance_services_count"],"type":"object","properties":{"title":{"type":"string","description":"Membership type name","example":"Fitness 10-pack"},"salon_group_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain ID (API uses salon_group_id parameter name)"},"children":[]}]}]}],"example":1},"cost":{"type":"number","format":"float","description":"Subscription price","example":500},"location_ids":{"type":"array","description":"List of location IDs where this membership type is available","items":{"type":"integer"},"example":[123,456]},"period":{"type":"integer","description":"Validity period duration","example":30},"period_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period unit type: 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"enum":[1,2,3,4],"example":3},"allow_freeze":{"type":"boolean","description":"Whether membership can be frozen","default":false,"example":true},"freeze_limit":{"type":"integer","description":"Maximum total freeze period","example":14},"freeze_limit_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freeze period unit: 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"enum":[1,2,3,4],"example":1},"service_price_correction":{"type":"boolean","description":"Whether service price can be adjusted when using membership","default":false,"example":true},"expiration_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":"Activation type: 1 = on sale, 2 = on first use, 3 = from specific date"},"children":[]}]}]}],"enum":[1,2,3],"example":1},"is_allow_empty_code":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal vs shared subscription."},"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":"true = personal (only purchaser can use)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false = shared (multiple people can use with code)"},"children":[]}]}]}]}],"default":true,"example":true},"is_united_balance":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance type: true = unified balance, false = separate balance"},"children":[]}]}]}],"example":false},"united_balance_services_count":{"type":"integer","description":"Number of visits for unified balance","example":10},"balance_edit_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":"Balance adjustment permission: 0 = prohibited, 1 = only at sale location, 2 = at all locations"},"children":[]}]}]}],"enum":[0,1,2],"example":2},"is_online_sale_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether online sale is enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, online_sale_price becomes required."},"children":[]}]}]}],"default":false,"example":false},"online_sale_title":{"type":"string","description":"Subscription title for online sale","example":"Fitness Pack - 10 sessions"},"online_sale_description":{"type":"string","description":"Subscription description for online sale","example":"Perfect for beginners. Valid for 3 months."},"online_sale_price":{"type":"number","format":"float","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price for online sale (required if is_online_sale_enabled = true)"},"children":[]}]}]}],"example":450},"online_image":{"type":"string","description":"Image URL for online sale","example":"https://example.com/images/fitness-pack.jpg"},"autoactivation_period":{"type":"integer","description":"Maximum autoactivation period","example":3},"autoactivation_time_in_days":{"type":"integer","description":"Time units for autoactivation","example":10},"autoactivation_time_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autoactivation time unit: 1 = days, 2 = weeks, 3 = months, 4 = years"},"children":[]}]}]}],"enum":[1,2,3,4],"example":1},"is_archived":{"type":"boolean","description":"Whether membership type is archived","default":false,"example":false},"category":{"type":"string","description":"Subscription category type (always \"standard\")","default":"standard","example":"standard"},"salon_ids":{"type":"array","description":"List of location IDs where this membership type is available","items":{"type":"integer"},"example":[720441,703092]},"services":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with service IDs as keys and usage count as values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For separate balance: count = number of visits per service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For unified balance: use empty object {}."},"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":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is an object (key-value pairs), NOT an array."},"children":[]}]}]}],"additionalProperties":{"type":"integer"},"example":{"13160808":5,"13160809":3}},"service_categories":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object with service category IDs as keys and usage count as values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For separate balance: count = number of visits per category."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For unified balance: count value is ignored (set to any number or 0)."},"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":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This is an object (key-value pairs), NOT an array."},"children":[]}]}]}],"additionalProperties":{"type":"integer"},"example":{"13160806":10}},"delete_online_image":{"type":"boolean","description":"Whether to delete existing online sale image","default":false,"example":false},"availability":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time-based availability rules. Empty array = available anytime."},"children":[]}]}]}],"items":{"type":"object","properties":{"week_days":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days of week when rule applies: 1 = Monday, 7 = Sunday"},"children":[]}]}]}],"items":{"type":"integer","minimum":1,"maximum":7},"example":[1,2,3]},"intervals":{"type":"array","description":"Time intervals when membership is valid","items":{"type":"object","properties":{"from":{"type":"integer","description":"Interval start in seconds from midnight","example":28800},"to":{"type":"integer","description":"Interval end in seconds from midnight","example":64800}}}}}}}}},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"$ref":"#/components/schemas/chain_loyalty_membership_type"},"meta":{"type":"array","example":[]}}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"required":["title","salon_group_id","cost","service_categories","is_united_balance","united_balance_services_count"],"type":"object","properties":{"title":{"type":"string","description":"Membership type name","example":"Updated Fitness 10-pack"},"salon_group_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chain ID (API uses salon_group_id parameter name)"},"children":[]}]}]}],"example":1},"cost":{"type":"number","format":"float","description":"Subscription price","example":550},"location_ids":{"type":"array","description":"List of location IDs where this membership type is available","items":{"type":"integer"},"example":[123,456]},"period":{"type":"integer","description":"Validity period duration","example":90},"period_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period unit type: 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"enum":[1,2,3,4],"example":1},"allow_freeze":{"type":"boolean","description":"Whether membership can be frozen","default":false,"example":true},"freeze_limit":{"type":"integer","description":"Maximum total freeze period","example":30},"freeze_limit_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freeze period unit: 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"enum":[1,2,3,4],"example":1},"service_price_correction":{"type":"boolean","description":"Whether service price can be adjusted when using membership","default":false,"example":true},"expiration_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":"Activation type: 1 = on sale, 2 = on first use, 3 = from specific date"},"children":[]}]}]}],"enum":[1,2,3],"example":1},"is_allow_empty_code":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal vs shared subscription."},"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":"true = personal (only purchaser can use)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false = shared (multiple people can use with code)"},"children":[]}]}]}]}],"default":true,"example":true},"is_united_balance":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance type: true = unified balance, false = separate balance"},"children":[]}]}]}],"example":false},"united_balance_services_count":{"type":"integer","description":"Number of visits for unified balance","example":10},"balance_edit_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":"Balance adjustment permission: 0 = prohibited, 1 = only at sale location, 2 = at all locations"},"children":[]}]}]}],"enum":[0,1,2],"example":2},"is_online_sale_enabled":{"type":"boolean","description":"Whether online sale is enabled","default":false,"example":false},"online_sale_title":{"type":"string","description":"Subscription title for online sale","example":"Updated Fitness Pack"},"online_sale_description":{"type":"string","description":"Subscription description for online sale","example":"Updated description"},"online_sale_price":{"type":"number","format":"float","description":"Price for online sale","example":500},"online_image":{"type":"string","description":"Image URL for online sale","example":"https://example.com/images/updated.jpg"},"autoactivation_period":{"type":"integer","description":"Maximum autoactivation period","example":3},"autoactivation_time_in_days":{"type":"integer","description":"Time units for autoactivation","example":10},"autoactivation_time_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Autoactivation time unit: 1 = days, 2 = weeks, 3 = months, 4 = years"},"children":[]}]}]}],"enum":[1,2,3,4],"example":1},"is_archived":{"type":"boolean","description":"Whether membership type is archived","default":false,"example":false},"services":{"type":"array","description":"List of service IDs. Pass empty array to preserve existing services.\n","items":{"type":"integer"},"example":[]},"service_categories":{"type":"array","description":"List of service category IDs. Pass empty array to preserve existing categories.\n","items":{"type":"integer"},"example":[]},"availability":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time-based availability rules. Empty array = available anytime."},"children":[]}]}]}],"items":{"type":"object","properties":{"week_days":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Days of week when rule applies: 1 = Monday, 7 = Sunday"},"children":[]}]}]}],"items":{"type":"integer","minimum":1,"maximum":7},"example":[1,2,3]},"intervals":{"type":"array","description":"Time intervals when membership is valid","items":{"type":"object","properties":{"from":{"type":"integer","description":"Interval start in seconds from midnight","example":28800},"to":{"type":"integer","description":"Interval end in seconds from midnight","example":64800}}}}}}}}},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"null"},"meta":{"type":"array","example":[]}}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"required":["restore_in_title"],"type":"object","properties":{"restore_in_title":{"type":"string","description":"New title for the restored membership type","example":"Fitness Membership"}}},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"required":["is_archived"],"type":"object","properties":{"is_archived":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archive status:"},"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":"true = archived (cannot be sold)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false = active (available for sale)"},"children":[]}]}]}]}],"example":true}}},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"integer","default":10,"maximum":100},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":289056},"title":{"type":"string","example":"Gift Certificate 1000"},"balance":{"type":"number","example":1000},"is_multi":{"type":"boolean","example":true},"company_group_id":{"type":"integer","example":706028},"category_id":{"type":["integer","null"],"example":null},"weight":{"type":"integer","example":1},"item_type_id":{"type":"integer","example":0},"expiration_type_id":{"type":"integer","example":2},"expiration_date":{"type":["string","null"],"format":"date-time","example":null},"expiration_timeout":{"type":"integer","example":6},"expiration_timeout_unit_id":{"type":"integer","example":3},"balance_edit_type_id":{"type":"integer","example":1},"is_allow_empty_code":{"type":"boolean","example":false},"is_serial_number_limited":{"type":"boolean","example":false},"is_archived":{"type":"boolean","example":false},"date_archived":{"type":["string","null"],"example":null},"online_sale_is_enabled":{"type":"boolean","example":false},"online_sale_title":{"type":"string","example":"Gift Certificate 1000"},"online_sale_description":{"type":"string","example":""},"online_sale_price":{"type":"number","example":0},"online_sale_image":{"type":["string","null"],"example":null},"released_total":{"type":"integer","example":0},"item_type":{"type":"object","properties":{"id":{"type":"integer","example":0},"title":{"type":"string","example":"All services and products"}}},"service_ids":{"type":"array","items":{"type":"integer"},"example":[]},"salon_ids":{"type":"array","items":{"type":"integer"},"example":[720441]}}}},"meta":{"type":"object","properties":{"total_count":{"type":"integer","description":"Total number of certificate types","example":1}}}}},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"required":["title","balance","is_multi","item_type_id","is_allow_empty_code","balance_edit_type_id","service_ids","salon_ids","expiration","online_sale"],"type":"object","properties":{"title":{"type":"string","description":"Certificate type name","example":"Gift Certificate 1000"},"balance":{"type":"number","description":"Certificate face value","example":1000},"is_multi":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true = multiple use, false = single use"},"children":[]}]}]}],"example":true},"item_type_id":{"type":"integer","description":"Usage restrictions (0-4)","enum":[0,1,2,3,4],"example":0},"is_allow_empty_code":{"type":"boolean","description":"Allow selling without code?","example":false},"category_id":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service category restriction (null = no restriction)"},"children":[]}]}]}],"example":null},"balance_edit_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":"Balance editability (1 = editable, 2 = not editable)"},"children":[]}]}]}],"enum":[1,2],"example":1},"service_ids":{"type":"array","description":"Specific service IDs (empty if no restriction)","items":{"type":"integer"},"example":[]},"salon_ids":{"type":"array","description":"Location IDs where certificate is valid","items":{"type":"integer"},"example":[720441]},"expiration":{"type":"object","description":"Expiration settings","required":["type_id"],"properties":{"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":"Expiration type: 0 = none, 1 = fixed date, 2 = period from sale"},"children":[]}]}]}],"enum":[0,1,2],"example":2},"date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed expiration date (ISO 8601, required if type_id = 1)"},"children":[]}]}]}],"example":"2026-12-31T23:59:59+00:00"},"timeout":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration value (required if type_id = 2)"},"children":[]}]}]}],"example":6},"timeout_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration unit (required if type_id = 2): 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"enum":[1,2,3,4],"example":3}}},"online_sale":{"type":"object","description":"Online sale settings","required":["is_enabled"],"properties":{"is_enabled":{"type":"boolean","description":"Enable online purchase?","example":false},"title":{"type":"string","description":"Title for online store","example":"Gift Certificate"},"description":{"type":"string","description":"Description for online store","example":"Perfect gift for any occasion"},"price":{"type":"number","description":"Online sale price","example":1000}}}}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"integer","description":"Certificate type ID","example":289056},"title":{"type":"string","example":"Gift Certificate 1000"},"balance":{"type":"number","example":1000},"is_multi":{"type":"boolean","example":true},"company_group_id":{"type":"integer","description":"Chain ID","example":706028},"category_id":{"type":["integer","null"],"example":null},"weight":{"type":"integer","description":"Sort order","example":1},"item_type_id":{"type":"integer","example":0},"expiration_type_id":{"type":"integer","example":2},"expiration_date":{"type":["string","null"],"format":"date-time","example":null},"expiration_timeout":{"type":"integer","example":6},"expiration_timeout_unit_id":{"type":"integer","example":3},"balance_edit_type_id":{"type":"integer","example":1},"is_allow_empty_code":{"type":"boolean","example":false},"is_serial_number_limited":{"type":"boolean","example":false},"is_archived":{"type":"boolean","example":false},"date_archived":{"type":["string","null"],"example":null},"online_sale_is_enabled":{"type":"boolean","example":false},"online_sale_title":{"type":"string","example":"Gift Certificate 1000"},"online_sale_description":{"type":"string","example":""},"online_sale_price":{"type":"number","example":0},"online_sale_image":{"type":["string","null"],"example":null},"released_total":{"type":"integer","description":"Total certificates issued","example":0},"item_type":{"type":"object","properties":{"id":{"type":"integer","example":0},"title":{"type":"string","example":"All services and products"}}},"service_ids":{"type":"array","items":{"type":"integer"},"example":[]},"salon_ids":{"type":"array","items":{"type":"integer"},"example":[720441]}}},"meta":{"type":"array","example":[]}}},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"An error has occurred"},"errors":{"type":"object","description":"Field-specific validation errors"}}}}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"integer","example":289056},"title":{"type":"string","example":"Gift Certificate 1000"},"balance":{"type":"number","example":1000},"is_multi":{"type":"boolean","example":true},"company_group_id":{"type":"integer","example":706028},"category_id":{"type":["integer","null"],"example":null},"weight":{"type":"integer","example":1},"item_type_id":{"type":"integer","example":0},"expiration_type_id":{"type":"integer","example":2},"expiration_date":{"type":["string","null"],"format":"date-time","example":null},"expiration_timeout":{"type":"integer","example":6},"expiration_timeout_unit_id":{"type":"integer","example":3},"balance_edit_type_id":{"type":"integer","example":1},"is_allow_empty_code":{"type":"boolean","example":false},"is_serial_number_limited":{"type":"boolean","example":false},"is_archived":{"type":"boolean","example":false},"date_archived":{"type":["string","null"],"example":null},"online_sale_is_enabled":{"type":"boolean","example":false},"online_sale_title":{"type":"string","example":"Gift Certificate 1000"},"online_sale_description":{"type":"string","example":""},"online_sale_price":{"type":"number","example":0},"online_sale_image":{"type":["string","null"],"example":null},"released_total":{"type":"integer","example":0},"item_type":{"type":"object","properties":{"id":{"type":"integer","example":0},"title":{"type":"string","example":"All services and products"}}},"service_ids":{"type":"array","items":{"type":"integer"},"example":[]},"salon_ids":{"type":"array","items":{"type":"integer"},"example":[720441]}}},"meta":{"type":"array","example":[]}}},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"required":["title","balance","is_multi","item_type_id","is_allow_empty_code","balance_edit_type_id","service_ids","salon_ids","expiration","online_sale"],"type":"object","properties":{"title":{"type":"string","description":"Certificate type name","example":"Gift Certificate 1500"},"balance":{"type":"number","description":"Certificate face value","example":1500},"is_multi":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true = multiple use, false = single use"},"children":[]}]}]}],"example":true},"item_type_id":{"type":"integer","description":"Usage restrictions (0-4)","enum":[0,1,2,3,4],"example":0},"is_allow_empty_code":{"type":"boolean","description":"Allow selling without code?","example":false},"category_id":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service category restriction (null = no restriction)"},"children":[]}]}]}],"example":null},"balance_edit_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":"Balance editability (1 = editable, 2 = not editable)"},"children":[]}]}]}],"enum":[1,2],"example":1},"service_ids":{"type":"array","description":"Specific service IDs (empty if no restriction)","items":{"type":"integer"},"example":[]},"salon_ids":{"type":"array","description":"Location IDs where certificate is valid","items":{"type":"integer"},"example":[720441]},"expiration":{"type":"object","description":"Expiration settings","required":["type_id"],"properties":{"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":"Expiration type: 0 = none, 1 = fixed date, 2 = period from sale"},"children":[]}]}]}],"enum":[0,1,2],"example":2},"date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed expiration date (ISO 8601, required if type_id = 1)"},"children":[]}]}]}],"example":"2026-12-31T23:59:59+00:00"},"timeout":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration value (required if type_id = 2)"},"children":[]}]}]}],"example":6},"timeout_unit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration unit (required if type_id = 2): 1 = day, 2 = week, 3 = month, 4 = year"},"children":[]}]}]}],"enum":[1,2,3,4],"example":3}}},"online_sale":{"type":"object","description":"Online sale settings","required":["is_enabled"],"properties":{"is_enabled":{"type":"boolean","description":"Enable online purchase?","example":false},"title":{"type":"string","description":"Title for online store","example":"Gift Certificate"},"description":{"type":"string","description":"Description for online store","example":"Perfect gift for any occasion"},"price":{"type":"number","description":"Online sale price","example":1500}}}}},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"id":{"type":"integer","example":289056},"title":{"type":"string","example":"Gift Certificate 1500"},"balance":{"type":"number","example":1500},"is_multi":{"type":"boolean","example":true},"company_group_id":{"type":"integer","example":706028},"category_id":{"type":["integer","null"],"example":null},"weight":{"type":"integer","example":1},"item_type_id":{"type":"integer","example":0},"expiration_type_id":{"type":"integer","example":2},"expiration_date":{"type":["string","null"],"example":null},"expiration_timeout":{"type":"integer","example":6},"expiration_timeout_unit_id":{"type":"integer","example":3},"balance_edit_type_id":{"type":"integer","example":1},"is_allow_empty_code":{"type":"boolean","example":false},"is_serial_number_limited":{"type":"boolean","example":false},"is_archived":{"type":"boolean","example":false},"date_archived":{"type":["string","null"],"example":null},"online_sale_is_enabled":{"type":"boolean","example":false},"online_sale_title":{"type":"string","example":"Gift Certificate 1500"},"online_sale_description":{"type":"string","example":""},"online_sale_price":{"type":"number","example":0},"online_sale_image":{"type":["string","null"],"example":null},"released_total":{"type":"integer","example":0},"item_type":{"type":"object","properties":{"id":{"type":"integer","example":0},"title":{"type":"string","example":"All services and products"}}},"service_ids":{"type":"array","items":{"type":"integer"},"example":[]},"salon_ids":{"type":"array","items":{"type":"integer"},"example":[720441]}}},"meta":{"type":"array","example":[]}}},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"An error has occurred"},"errors":{"type":"object"}}}}},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Cannot delete certificate type with issued certificates"}}}}},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"type":"string","enum":["applicable_items","rules","companies","loyalty_card_types","on_changed_notification_template","on_expiration_notification_template"]},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["1","2","3","4","5","6","7","8","9","10","11"]}},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/loyalty_notification_message_template"}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"required":["document_id","type"],"type":"object","properties":{"document_id":{"type":"number","description":"Document ID"},"type":{"type":"number","description":"type of operation with location account (see table of types of all operations)"},"is_pos_enabled":{"type":"boolean","description":"enable POS terminal (default false)"}}},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"required":["active","deactivation_date","id","is_paid_rights_model","name","options","salon_id","staff_limit","start_date"],"type":"object","properties":{"LicenseOption":{"$ref":"#/components/schemas/license_option"},"active":{"type":"number","description":"Is the subscription active"},"deactivation_date":{"type":"string","description":"Subscription expiration date"},"id":{"type":"number","description":"Subscription ID"},"name":{"type":"string","description":"Subscription name"},"options":{"type":"array","description":"Subscription options","items":{"type":"object"}},"salon_id":{"type":"number","description":"location ID"},"staff_limit":{"type":"number","description":"team member limit"},"is_paid_rights_model":{"type":"boolean","description":"Whether the location uses paid rights licensing model"},"start_date":{"type":"string","description":"Subscription start date"}}},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"required":["image"],"properties":{"company_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location ID for image binding (for entity=service)"},"children":[]}]}]}]},"service_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service ID for image binding (for entity=service)"},"children":[]}]}]}]},"master_id":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"team member ID for image binding (for entity=team_member)"},"children":[]}]}]}]},"image":{"type":"string","description":"transferred image (image/jpeg, image/png)"}}},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"required":["image_group"],"type":"object","properties":{"ImageGroup":{"$ref":"#/components/schemas/image_group"},"image_group":{"$ref":"#/components/schemas/image_group"}}},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"required":["image_group_id"],"properties":{"image_group_id":{"type":"number","description":"Image group ID to delete"}}},"id":"schema_411"}},"exampleStore":{"paths/~1auth/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":123456,"user_token":"wec23fh8cDfFV4432fc352456","name":"James Smith","phone":"+13155550175","login":"j.smith","email":"j.smith@example.com","avatar":"https://assets.alteg.io/general/0/01/123456789098765_12345678909876.png","is_approved":true,"is_email_confirmed":false},"meta":[]},"id":"paths/~1auth/post/responses/201/content/application~1json/example"},"paths/~1service_categories~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":3,"title":"Haircut very feminine","api_id":"adw322","weight":111,"staff":[5006,8901]},"meta":[]},"id":"paths/~1service_categories~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1services~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":10279685,"salon_service_id":11486182,"title":"Service name","booking_title":"Service name","category_id":10279684,"price_min":0,"price_max":0,"duration":3600,"discount":0,"comment":"","weight":1,"active":1}],"meta":[]},"id":"paths/~1services~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1services~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":83169,"title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"duration":3600,"discount":0,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":1796,"seance_length":3600},{"id":34006,"seance_length":3600}]},"meta":[]},"id":"paths/~1services~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1services~1{location_id}~1{service_id}/put/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":83169,"title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"duration":3600,"discount":0,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":1796,"seance_length":3600},{"id":34006,"seance_length":3600}]},"meta":[]},"id":"paths/~1services~1{location_id}~1{service_id}/put/responses/201/content/application~1json/example"},"paths/~1services~1{location_id}~1{service_id}/patch/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"booking_title":"Men's haircut","tax_variant":0,"vat_id":2,"print_title":"Men's haircut","service_type":1,"api_service_id":0,"repeat_visit_days_step":"null","seance_search_start":1800,"seance_search_finish":84600,"seance_search_step":900,"step":300,"is_need_limit_date":true,"date_from":"2022-09-19","date_to":"2022-09-30","schedule_template_type":2,"online_invoicing_status":0,"is_abonement_autopayment_enabled":0,"autopayment_before_visit_time":0,"abonement_restriction_value":0,"is_chain":false,"is_price_managed_only_in_chain":false,"is_comment_managed_only_in_chain":false,"price_prepaid_amount":0,"price_prepaid_percent":100,"id":10832934,"salon_service_id":12192004,"title":"Men's haircut","category_id":10832928,"price_min":250,"price_max":1200,"discount":0,"comment":"","weight":0,"active":1,"api_id":0,"prepaid":"forbidden","is_multi":false,"capacity":0,"image_group":[],"staff":[{"id":5905,"seance_length":2700,"technological_card_id":0},{"id":5907,"seance_length":3600,"technological_card_id":0}],"dates":["2022-09-19","2022-09-20","2022-09-21","2022-09-22","2022-09-23","2022-09-24","2022-09-25","2022-09-26","2022-09-27","2022-09-28","2022-09-29","2022-09-30"],"duration":3600,"resources":[],"is_online":true},"meta":[]},"id":"paths/~1services~1{location_id}~1{service_id}/patch/responses/200/content/application~1json/example"},"paths/~1service_category~1{location_id}~1{id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":3,"salon_service_id":15,"title":"Haircuts for women","weight":12,"staff":[5006,8901]},"meta":[]},"id":"paths/~1service_category~1{location_id}~1{id}/get/responses/200/content/application~1json/example"},"paths/~1service_category~1{location_id}~1{id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":3,"salon_service_id":15,"title":"Haircuts for women","weight":15,"staff":[5006,8901]},"meta":[]},"id":"paths/~1service_category~1{location_id}~1{id}/put/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":345,"salon_service_id":353,"title":"Haircuts for men","api_id":"adw322","weight":10,"staff":[5006,8901,26514,26516,26519,26520]},{"id":3456,"salon_service_id":3252,"title":"Haircuts for women","api_id":"adw323","weight":9,"staff":[5006,8901]}],"meta":{"total_count":2}},"id":"paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/403/content/application~1json/example":{"value":{"success":false,"meta":{"message":"It is necessary to renew the license in the branch with id: {location_id}"}},"id":"paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/403/content/application~1json/example"},"paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/404/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"Location not specified."},{"message":"Location not found."},{"message":"Service category does not exist."},{"message":"Team Member not found."}]}},"id":"paths/~1company~1{location_id}~1service_categories~1{id}/get/responses/404/content/application~1json/example"},"paths/~1company~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":79067,"title":"shaving head","category_id":4,"price_min":1000,"price_max":1000,"discount":0,"comment":"","weight":2,"active":1,"api_id":"","staff":[]},{"id":83169,"title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"discount":0,"comment":"","weight":6,"active":1,"api_id":42,"staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":17969,"seance_length":3600},{"id":34006,"seance_length":3600}],"image_group":{"id":72234,"entity":"settings_service","entity_id":389927,"images":{"basic":{"id":186791,"path":"https://app.alteg.io/path/to/image/tagret-image.jpeg","width":"372","height":"280","type":"jpeg","image_group_id":72234,"version":"basic"}}}}],"meta":{"total_count":2}},"id":"paths/~1company~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1services~1{service_id}/get/responses/403/content/application~1json/example":{"value":{"success":false,"meta":{"message":"It is necessary to renew the license in the branch with id: {location_id}"}},"id":"paths/~1company~1{location_id}~1services~1{service_id}/get/responses/403/content/application~1json/example"},"paths/~1company~1{location_id}~1services~1{service_id}/get/responses/404/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"Location not specified."},{"message":"Location not found."},{"message":"Service not listed."},{"message":"Service not found."},{"message":"Team Member not found."},{"message":"Category not found."}]}},"id":"paths/~1company~1{location_id}~1services~1{service_id}/get/responses/404/content/application~1json/example"},"paths/~1company~1{location_id}~1services~1links/post/requestBody/content/application~1json/example":{"value":{"service_id":10832939,"team_member_settings":[{"team_member_id":2033728,"tech_card_id":291341,"hours":0,"minutes":45,"price":{"min":999.99,"max":null}},{"team_member_id":1987799,"tech_card_id":291341,"hours":1,"minutes":15,"price":null}],"resource_ids":[62173],"translations":[{"language_id":2,"translation":""},{"language_id":2,"translation":"Massage"}]},"id":"paths/~1company~1{location_id}~1services~1links/post/requestBody/content/application~1json/example"},"paths/~1service_categories~1{location_id}~1{id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":345,"title":"Haircuts for men","api_id":"adw322","weight":10,"staff":[5006,8901,26514,26516,26519,26520]},{"id":3456,"title":"Haircuts for women","api_id":"adw323","weight":9,"staff":[5006,8901]}],"meta":[]},"id":"paths/~1service_categories~1{location_id}~1{id}/get/responses/200/content/application~1json/example"},"paths/~1services~1{location_id}~1{service_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":79067,"title":"shaving head","category_id":4,"price_min":1000,"price_max":1000,"duration":3600,"discount":0,"comment":"","weight":2,"active":1,"api_id":"","staff":[]},{"id":83169,"title":"Men's haircut","category_id":83167,"price_min":1300,"price_max":1300,"duration":3600,"discount":0,"comment":"","weight":6,"active":1,"api_id":"00000000042","staff":[{"id":5905,"seance_length":2700},{"id":5907,"seance_length":3600},{"id":8973,"seance_length":3600},{"id":13616,"seance_length":3600},{"id":16681,"seance_length":3600},{"id":17969,"seance_length":3600},{"id":34006,"seance_length":3600}],"image_group":{"id":72234,"entity":"settings_service","entity_id":389927,"images":{"basic":{"id":186791,"path":"https://app.alteg.io/path/to/image/tagret-image.jpeg","width":"372","height":"280","type":"jpeg","image_group_id":72234,"version":"basic"}}}}],"meta":[]},"id":"paths/~1services~1{location_id}~1{service_id}/get/responses/200/content/application~1json/example"},"paths/~1staff~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":17969,"api_id":42,"name":"Basil","specialization":"the hairdresser","position":{"id":1,"title":"Administrator"},"show_rating":false,"rating":0,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20151018220924_4963.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20151018220924_4963.jpg","comments_count":0,"weight":10,"information":"<span><span><span>&nbsp;</span></span></span>","hidden":0,"fired":0,"status":0},"meta":[]},"id":"paths/~1staff~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1staff~1{location_id}~1{team_member_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":17969,"name":"Basil","specialization":"the hairdresser","position":{"id":1,"title":"Administrator"},"show_rating":0,"rating":0,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20151018220924_4963.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20151018220924_4963.jpg","comments_count":0,"weight":"10","information":"<span><span><span>&nbsp;</span></span></span>","hidden":"0","fired":"0","status":"0","image_group":{"id":72250,"entity":"master","entity_id":26427,"images":{"sm":{"id":186817,"path":"https://app.alteg.io/uploads/masters/sm/9/90/9041171cfdabe4c_20170327202542.jpeg","width":"100","height":"100","type":"jpeg","image_group_id":72250,"version":"sm"},"norm":{"id":186818,"path":"https://app.alteg.io/uploads/masters/norm/a/aa/aa37b29b7eb322d_20170327202542.jpeg","width":"180","height":"220","type":"jpeg","image_group_id":72250,"version":"norm"},"origin":{"id":186819,"path":"https://app.alteg.io/uploads/masters/origin/6/65/654dbeb4ea0bbc3_20170327202542.jpeg","width":"800","height":"600","type":"jpeg","image_group_id":72250,"version":"origin"}}}},{"id":34006,"api_id":"42","name":"Denis","specialization":"the hairdresser","position":[],"show_rating":0,"rating":0,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20151116091208_4369.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20151116091208_4369.jpg","comments_count":0,"weight":"9","information":"<span><span>&nbsp;</span></span>","hidden":"0","fired":"0","status":"0","image_group":[]},{"id":13616,"name":"Alexander","specialization":"the hairdresser","position":[],"show_rating":0,"rating":4.76921,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20251112123913_5162.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20251112123913_5162.jpg","comments_count":26,"weight":"8","information":"<span><span><span>&nbsp;</span></span></span>","hidden":"0","fired":"0","status":"0","image_group":[]}],"meta":[]},"id":"paths/~1staff~1{location_id}~1{team_member_id}/get/responses/200/content/application~1json/example"},"paths/~1staff~1{location_id}~1{team_member_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":17969,"api_id":42,"name":"Basil","specialization":"the hairdresser","position":{"id":1,"title":"Administrator"},"show_rating":0,"rating":0,"votes_count":0,"user_id":12345,"avatar":"https://app.alteg.io/uploads/masters/sm/20151018220924_4963.jpg","avatar_big":"https://app.alteg.io/uploads/masters/norm/20151018220924_4963.jpg","comments_count":0,"weight":"10","information":"<span><span><span>&nbsp;</span></span></span>","hidden":"0","fired":"0","status":"0","is_paid_staff":false,"is_included_in_payment_policy":true},"meta":[]},"id":"paths/~1staff~1{location_id}~1{team_member_id}/put/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1001539,"name":"team member 1","company_id":176275,"specialization":"team member","position":{"id":1,"title":"Administrator"},"avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","fired":0,"status":0,"hidden":0,"user_id":12345,"is_paid_staff":false,"is_included_in_payment_policy":true}],"meta":{"total_count":1}},"id":"paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/403/content/application~1json/example":{"value":{"success":false,"meta":{"message":"It is necessary to renew the license in the branch with id: {location_id}"}},"id":"paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/403/content/application~1json/example"},"paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/404/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"Location not specified."},{"message":"Team Member not listed"},{"message":"Team Member with ID {team_member_id} was not found in branch {location_id}."}]}},"id":"paths/~1company~1{location_id}~1staff~1{team_member_id}/get/responses/404/content/application~1json/example"},"paths/~1clients~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":1121412,"name":"James","surname":"Smith","middle_name":"James","phone":13155550179,"email":"j.smith@example.com","categories":[],"gender":"Male","gender_id":1,"discount":15,"importance_id":1,"importance":"Bronze","card":555888666,"birth_date":"952041600","comment":"throws show-off","sms_check":0,"sms_not":0,"spent":1000,"balance":-1200,"visits":0,"last_change_date":"2026-05-01T12:00:00-0500","custom_fields":{"key-1":"value-1"},"national_id":"950315300129"},"meta":[]},"id":"paths/~1clients~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1company~1{location_id}~1clients~1search/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"name":"James Smith","id":2},{"name":"Taylor Reed","id":3},{"name":"James Smith","id":1}],"meta":{"total_count":908}},"id":"paths/~1company~1{location_id}~1clients~1search/post/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1clients~1search/post/responses/400/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Invalid filter value","errors":{"filters":["Invalid filter state value"]}}},"id":"paths/~1company~1{location_id}~1clients~1search/post/responses/400/content/application~1json/example"},"paths/~1company~1{location_id}~1clients~1search/post/responses/402/content/application~1json/example":{"value":{"success":false,"meta":{"message":"It is necessary to renew the license in the branch with id: {location_id}"}},"id":"paths/~1company~1{location_id}~1clients~1search/post/responses/402/content/application~1json/example"},"paths/~1company~1{location_id}~1clients~1search/post/responses/404/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"Location not specified."},{"filters":["Invalid filter state value"]}]}},"id":"paths/~1company~1{location_id}~1clients~1search/post/responses/404/content/application~1json/example"},"paths/~1client~1{location_id}~1{id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":16,"name":"James","surname":"Smith","middle_name":"James","phone":13155550178,"email":"","categories":[],"gender":"unknown","discount":0,"importance":"No importance class","card":"","birth_date":null,"comment":"","sms_check":0,"sms_not":0,"spent":0,"balance":0,"visits":3,"last_change_date":"2026-03-01T12:00:00-0500","custom_fields":[],"national_id":""},"meta":[]},"id":"paths/~1client~1{location_id}~1{id}/get/responses/200/content/application~1json/example"},"paths/~1client~1{location_id}~1{id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":1121412,"name":"James","surname":"Smith","middle_name":"James","phone":13155550179,"email":"j.smith@example.com","categories":[],"gender":"Male","gender_id":1,"discount":15,"importance_id":1,"importance":"Bronze","card":555888666,"birth_date":"952041600","comment":"throws show-off","sms_check":0,"sms_not":0,"spent":1000,"balance":-1200,"visits":0,"last_change_date":"2026-06-01T12:00:00-0500","custom_fields":{"key-1":"value-1"},"national_id":"950315300129"},"meta":[]},"id":"paths/~1client~1{location_id}~1{id}/put/responses/200/content/application~1json/example"},"paths/~1clients~1{location_id}~1bulk/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"created":[{"id":19153889,"name":"James","surname":"Smith","middle_name":"James","phone":13155550181,"email":"j.smith@example.com","card":555888666,"birth_date":"952041600","comment":"throws show-off","discount":15,"visits":0,"gender_id":1,"gender":"Male","sms_check":0,"sms_bot":0,"spent":1000,"paid":0,"balance":-1200,"importance_id":1,"importance":"Bronze","categories":[{"id":101,"title":"Loyal","color":"#bfd4f2"},{"id":102,"title":"Constant","color":"#009800"}],"last_change_date":"2026-09-08T13:33:39-0500","custom_fields":[],"national_id":"950315300129"}],"errors":[{"phone":13155550181,"name":"James Smith","error":"The client with the specified phone number already exists in the database"},{"phone":13155550182,"error":"Client name not specified"},{"phone":13155550183,"name":"James Smith","error":"Phone must contain 9 to 15 digits"},{"name":"Theodore Hicks","error":"Customer phone number cannot be empty"}]},"meta":[]},"id":"paths/~1clients~1{location_id}~1bulk/post/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1clients~1files~1{client_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":123,"client_id":123456,"name":"test.txt","description":"","date_create":"2026-01-01T12:00:00-0500","extension":"txt","mime":"text/plain","link":"/client_files/download/456/123/","user_name":"Viktor Sitnikov","user_avatar":"/images/no-master.png","size":"9 B","can_edit":false},{"id":789,"client_id":123456,"name":"photo.jpg","description":"","date_create":"2026-01-30T12:30:00-0500","extension":"jpg","mime":"image/jpeg","link":"/client_files/download/456/789/","user_name":"Viktor Sitnikov","user_avatar":"/images/no-master.png","size":"96.65 KB","can_edit":true}],"meta":{"count":2}},"id":"paths/~1company~1{location_id}~1clients~1files~1{client_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/responses/202/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1company~1{location_id}~1clients~1files~1{client_id}~1{file_id}/delete/responses/202/content/application~1json/example"},"paths/~1clients~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":66,"name":"James","surname":"Smith","middle_name":"James","phone":13155550177,"email":"asdfgh@g.com","categories":[{"id":3,"title":"Black list","color":"#0f0f0f"},{"id":4,"title":"VIP","color":"#e8d313"}],"gender_id":0,"gender":"unknown","discount":10,"importance_id":3,"importance":"Gold","card":123456789,"birth_date":"2026-09-21","comment":"test","sms_check":1,"sms_not":0,"spent":71842,"balance":0,"visits":34,"last_change_date":"2026-02-01T12:00:00-0500","custom_fields":[]},{"id":16,"name":"James","surname":"Smith","middle_name":"James","phone":13155550178,"email":"","categories":[],"gender_id":0,"gender":"unknown","discount":0,"importance_id":0,"importance":"No importance class","card":"","birth_date":null,"comment":"","sms_check":0,"sms_not":0,"spent":0,"balance":0,"visits":3,"last_change_date":"2026-04-01T12:00:00-0500","custom_fields":[]}],"meta":{"page":1,"total_count":8}},"id":"paths/~1clients~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1users/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":10,"name":"Bob Williams","phone":"+13155550175","email":"b.williams@example.com","information":"Manager","is_approved":false,"is_non_deletable":false},{"id":11,"name":"Oliver Davis","phone":"+13155550176","email":"o.davis@example.com","information":"Administrator","is_approved":true,"is_non_deletable":true}],"meta":{"count":2}},"id":"paths/~1company~1{location_id}~1users/get/responses/200/content/application~1json/example"},"paths/~1user~1permissions~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"timetable":{"timetable_access":true,"master_id":1000238,"position_id":0,"last_days_count":1000,"schedule_edit_access":true,"timetable_phones_access":true,"timetable_transferring_record_access":true,"timetable_statistics_access":true},"record_form":{"record_form_access":true,"record_form_client_access":true,"records_autocomplete_access":true,"create_records_access":true,"edit_records_access":true,"edit_records_attendance_access":true,"records_services_cost_access":true,"records_services_discount_access":true,"record_edit_full_paid_access":true,"delete_records_access":true,"delete_customer_came_records_access":true,"delete_paid_records_access":true,"records_goods_access":true,"records_goods_create_transaction_access":true,"records_goods_create_last_days_count":-1,"records_goods_edit_transaction_access":true,"records_goods_edit_last_days_count":-1,"records_goods_cost_access":true,"records_goods_discount_access":true,"records_finances_access":true,"records_finances_last_days_count":-1,"records_finances_pay_from_deposits_access":true,"records_group_id_access":true,"records_group_id":134178},"finances":{"finances_access":true,"finances_accounts_ids":[],"finances_transactions_access":true,"finances_last_days_count":-1,"finances_create_transactions_access":true,"finances_create_last_days_count":-1,"finances_edit_transactions_access":true,"finances_edit_last_days_count":-1,"finances_delete_transactions_access":true,"finances_transactions_excel_access":true,"finances_expenses_ids":[],"finances_accounts_access":true,"finances_accounts_banalce_access":true,"finances_suppliers_read_access":true,"finances_suppliers_create_access":true,"finances_suppliers_update_access":true,"finances_suppliers_delete_access":true,"finances_suppliers_excel_access":true,"finances_expenses_read_access":true,"expenses_read_access":true,"finances_expenses_create_access":true,"expenses_create_access":true,"finances_expenses_update_access":true,"expenses_update_access":true,"finances_expenses_delete_access":true,"expenses_delete_access":true,"finances_kkm_transactions_access":true,"kkm_transactions_accounts_access":true,"finances_kkm_settings_read_access":true,"kkm_settings_reed_access":true,"finances_kkm_settings_update_access":true,"kkm_settings_update_access":true,"finances_settings_invoicing_read_access":true,"settings_invoicing_read_access":true,"finances_settings_invoicing_update_access":true,"settings_invoicing_update_access":true,"finances_options_read_access":true,"options_read_access":true,"finances_options_update_access":true,"options_update_access":true,"finances_salary_schemes_access":true,"finances_salary_calc_access":true,"finances_salary_not_limitation_today_access":true,"finances_payroll_calculation_create_access":true,"finances_payroll_calculation_create_not_limitation_today_access":true,"finances_salary_access_master_checkbox":true,"finances_salary_access_master_id":1000237,"get_salary_access_master_id":1000237,"finances_salary_master_not_limitation_today_access":true,"finances_payroll_calculation_create_by_master_access":true,"calculation_create_by_master_not_limitation_today_access":true,"finances_period_report_access":true,"finances_period_report_excel_access":true,"finances_year_report_access":true,"finances_year_report_excel_access":true,"finances_print_check_access":true,"finances_z_report_access":true,"finances_z_report_no_limit_today_access":true,"finances_z_report_excel_access":true},"clients":{"clients_access":true,"client_phones_access":true,"clients_phones_email_access":true,"clients_card_phone_access":true,"clients_delete_access":true,"clients_excel_access":true,"excel_access":true,"client_comments_list_access":true,"client_comments_add_access":true,"client_comments_own_edit_access":true,"client_comments_other_edit_access":true,"client_files_list_access":true,"client_files_upload_access":true,"client_files_delete_access":true,"clients_visit_master_id":0,"get_visit_master_id":0},"dashboard":{"dashboard_access":true,"dash_access":true,"dash_phones_access":true,"dash_records_access":true,"dash_records_last_days_count":-1,"dash_records_excel_access":true,"dash_records_phones_access":true,"dash_message_access":true,"dash_message_excel_access":true,"dash_message_phones_access":true,"dash_reviews_access":true,"dash_reviews_delete_access":true,"dashboard_calls_access":true,"dashboard_calls_excel_access":true,"dashboard_calls_phones_access":true},"notification":{"notification":true,"web_push":true,"web_phone_push":true,"notification_sms_ending_license":true,"notification_sms_low_balance":true,"notification_email_ending_license":true},"loyalty":{"loyalty_access":true,"has_loyalty_access":true,"loyalty_cards_manual_transactions_access":true,"has_loyalty_cards_manual_transactions_access":true,"loyalty_certificate_and_abonement_manual_transactions_access":true},"storages":{"storages_access":true,"storages_ids":[],"storages_transactions_access":true,"storages_last_days_count":-1,"storages_move_goods_access":true,"storages_create_transactions_access":true,"storages_create_last_days_count":-1,"storages_create_transactions_buy_access":true,"storages_create_transactions_sale_access":true,"storages_edit_transactions_access":true,"storages_edit_last_days_count":-1,"storages_edit_transactions_buy_access":true,"storages_edit_transactions_sale_access":true,"storages_delete_transactions_access":true,"storages_transactions_excel_access":true,"storages_transactions_types":[],"storages_inventory_access":true,"storages_inventory_create_edit_access":true,"storages_inventory_delete_access":true,"storages_inventory_excel_access":true,"storages_remnants_report_access":true,"storages_remnants_report_excel_access":true,"storages_sales_report_access":true,"storages_sales_report_excel_access":true,"storages_consumable_report_access":true,"storages_consumable_report_excel_access":true,"storages_write_off_report_access":true,"storages_write_off_report_excel_access":true,"storages_turnover_report_access":true,"storages_turnover_report_excel_access":true,"storages_goods_crud_access":true,"storages_goods_create_access":true,"storages_goods_update_access":true,"storages_goods_title_edit_access":true,"storages_goods_category_edit_access":true,"storages_goods_selling_price_edit_access":true,"storages_goods_cost_price_edit_access":true,"storages_goods_units_edit_access":true,"storages_goods_critical_balance_edit_access":true,"storages_goods_masses_edit_access":true,"storages_goods_comment_edit_access":true,"storages_goods_archive_access":true,"storages_goods_delete_access":true},"settings":{"settings_access":true,"settings_basis_access":true,"settings_information_access":true,"users_access":true,"delete_users_access":true,"create_users_access":true,"edit_users_access":true,"limited_users_access":false,"settings_services_access":true,"settings_services_create_access":true,"services_edit":true,"settings_services_edit_title_access":true,"settings_services_relation_category_access":true,"settings_services_edit_price_access":true,"settings_services_edit_image_access":true,"settings_services_edit_online_seance_date_time_access":true,"settings_services_edit_online_pay_access":true,"settings_services_edit_services_related_resource_access":true,"settings_positions_read":true,"settings_positions_create":true,"settings_positions_delete":true,"edit_master_service_and_duration":true,"tech_card_edit":true,"services_delete":true,"settings_master_access":true,"master_create":true,"master_edit":true,"master_delete":true,"settings_master_dismiss_access":true,"schedule_edit":true,"settings_notifications_access":true,"settings_email_notifications_access":true,"settings_template_notifications_access":true,"webhook_read_access":true},"other":{"stat_access":true,"billing_access":true,"send_sms":true,"auth_enable_check_ip":false,"auth_list_allowed_ip":[]}},"meta":[]},"id":"paths/~1user~1permissions~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1company_users~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":224348,"firstname":"James","login":"j.smith","email":"j.smith@example.com","phone":"+13155550175","information":"Test user","access":{"stat_access":true,"schedule_edit_access":false,"client_phones_access":false,"clients_access":false,"settings_access":false,"edit_records_access":false,"timetable_access":true,"billing_access":false,"users_access":false,"excel_access":false,"finances_access":false,"storages_access":false,"send_sms":true,"master_id":0}},{"id":11,"firstname":"James","login":"j.smith","email":"j.smith@example.com","phone":"+13155550175","information":"Test user","access":{"stat_access":true,"schedule_edit_access":true,"client_phones_access":true,"clients_access":true,"settings_access":true,"edit_records_access":true,"timetable_access":true,"billing_access":true,"users_access":false,"excel_access":true,"finances_access":true,"storages_access":true,"send_sms":true,"master_id":0}}],"meta":[]},"id":"paths/~1company_users~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1records~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":2,"company_id":4564,"staff_id":9,"services":[{"id":1,"title":"Hair extension","cost":100,"manual_cost":100,"cost_per_unit":100,"discount":0,"first_cost":100,"amount":1}],"goods_transactions":[],"staff":{"id":9,"name":"Alex Taylor","specialization":"hair extension","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"date":"2026-01-16T16:00:00-05:00","datetime":"2026-01-16T16:00:00-05:00","create_date":"2026-01-16T20:35:11-0500","comment":"do not write down","online":false,"visit_attendance":0,"attendance":0,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":0,"api_id":"","from_url":"","review_requested":0,"visit_id":8262996,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-16T20:35:15-0500","custom_color":"","custom_font_color":"","record_labels":[],"activity_id":0,"custom_fields":[],"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-01-16 16:00:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"sms_remain_hours":5,"email_remain_hours":1,"bookform_id":0,"record_from":"","is_mobile":0,"is_sale_bill_printed":false,"consumables":[],"finance_transactions":[]},{"id":9,"company_id":4564,"staff_id":49,"services":[],"goods_transactions":[],"staff":{"id":49,"name":"Sam Carter","specialization":"stylist","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"date":"2026-01-16T16:00:00-05:00","datetime":"2026-01-16T16:00:00-05:00","create_date":"2026-01-16T20:35:11-0500","comment":"","online":true,"visit_attendance":1,"attendance":1,"confirmed":1,"seance_length":10800,"length":10800,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":1,"api_id":"","from_url":"","review_requested":0,"visit_id":8262996,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-09T20:45:30-0500","custom_color":"f44336","custom_font_color":"#ffffff","record_labels":[{"id":67345,"title":"the team member is not important","color":"#009800","icon":"unlock","font_color":"#ffffff"},{"id":104474,"title":"important category","color":"#3b2c54","icon":"star","font_color":"#ffffff"}],"activity_id":0,"custom_fields":[],"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-01-16 16:00:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"sms_remain_hours":5,"email_remain_hours":1,"bookform_id":0,"record_from":"","is_mobile":0,"is_sale_bill_printed":false,"consumables":[],"finance_transactions":[]}],"meta":{"page":1,"total_count":10}},"id":"paths/~1records~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1records~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":[{"id":2,"company_id":4564,"staff_id":9,"services":[{"id":1,"title":"Hair extension","cost":100,"manual_cost":100,"cost_per_unit":100,"discount":0,"first_cost":100,"amount":1}],"goods_transactions":[],"staff":{"id":9,"name":"Alex Taylor","specialization":"hair extension","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"date":"2026-01-21T02:45:00-05:00","datetime":"2026-01-21T02:45:00-05:00","create_date":"2026-07-02T05:47:36-05:00","comment":"do not write down","online":false,"visit_attendance":0,"attendance":0,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":0,"api_id":"","from_url":"","review_requested":0,"visit_id":8262996,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-16T20:35:15-0500","custom_color":"","custom_font_color":"","record_labels":[],"activity_id":0,"custom_fields":[],"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"consumables":[],"finance_transactions":[]},{"id":9,"company_id":4564,"staff_id":49,"services":[],"goods_transactions":[],"staff":{"id":49,"name":"Sam Carter","specialization":"stylist","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"date":"2026-01-21T02:45:00-05:00","datetime":"2026-01-21T02:45:00-05:00","create_date":"2026-07-02T05:47:36-05:00","comment":"","online":true,"visit_attendance":1,"attendance":1,"confirmed":1,"seance_length":10800,"length":10800,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":1,"api_id":"","from_url":"","review_requested":0,"visit_id":8262996,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-09T20:45:30-0500","custom_color":"f44336","custom_font_color":"#ffffff","record_labels":[{"id":67345,"title":"the team member is not important","color":"#009800","icon":"unlock","font_color":"#ffffff"},{"id":104474,"title":"important category","color":"#3b2c54","icon":"star","font_color":"#ffffff"}],"activity_id":0,"custom_fields":[],"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"consumables":[],"finance_transactions":[]}],"meta":{"page":1,"total_count":10}},"id":"paths/~1records~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1record~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":2,"company_id":4564,"staff_id":9,"services":[{"id":1,"title":"Hair extension","cost":100,"manual_cost":100,"cost_per_unit":100,"discount":0,"first_cost":100,"amount":1}],"goods_transactions":[],"staff":{"id":9,"name":"Alex Taylor","specialization":"hair extension","position":{"id":1,"title":"Administrator"},"avatar":"http://app.alteg.io/images/no-master-sm.png","avatar_big":"http://app.alteg.io/images/no-master.png","rating":0,"votes_count":0},"client":{"id":18936825,"name":"lx","phone":13155550175,"card":"","email":"client@example.com","success_visits_count":37,"fail_visits_count":3},"clients_count":1,"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-01-17T19:41:44-0500","comment":"do not write down","visit_attendance":0,"attendance":0,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":0,"sms_now":0,"sms_now_text":"","email_now":0,"notified":0,"master_request":0,"api_id":"","from_url":"","review_requested":0,"visit_id":8263004,"created_user_id":1073232,"deleted":false,"paid_full":0,"prepaid":false,"prepaid_confirmed":false,"last_change_date":"2026-01-17T19:44:14-0500","custom_color":"f44336","custom_font_color":"#ffffff","record_labels":[{"id":67345,"title":"the team member is not important","color":"#009800","icon":"unlock","font_color":"#ffffff"},{"id":104474,"title":"interesting category","color":"#3b2c54","icon":"star","font_color":"#ffffff"}],"activity_id":0,"custom_fields":[],"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":1073232,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}],"sms_remain_hours":5,"email_remain_hours":1,"bookform_id":0,"record_from":"","is_mobile":0,"is_sale_bill_printed":false,"consumables":[{"id":2173068,"document_id":8174153,"type_id":2,"company_id":4564,"good_id":4853087,"amount":-1,"cost_per_unit":0.03,"discount":0,"cost":0.03,"unit_id":216761,"operation_unit_type":2,"storage_id":91548,"supplier_id":0,"client_id":0,"master_id":0,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"","service_id":1,"user_id":1073232,"deleted":false,"pkg_amount":0}],"finance_transactions":[{"id":6024243,"document_id":8174152,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":90459,"amount":100,"client_id":18936825,"master_id":0,"supplier_id":0,"comment":"","item_id":1,"target_type_id":1,"record_id":2,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":90459,"title":"Main location account"},"client":{"id":18936825,"name":"James Smith","phone":"+13155550175"},"master":[],"supplier":[]}]},"meta":[]},"id":"paths/~1record~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example"},"paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_custom_fields":{"value":{"staff_id":8886,"services":[{"id":331,"first_cost":9000,"discount":50,"cost":4500}],"client":{"phone":"+13155550175","name":"James Smith","email":"j.smith@example.com"},"datetime":"2026-09-21T23:00:00.000-05:00","seance_length":3600,"custom_fields":{"my_custom_field":123,"some_another_field":["first value","second value"]}},"key":"update_custom_fields","summary":"Update custom fields on a standard Appointment","id":"paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_custom_fields"},"paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_group_event_custom_fields":{"value":{"activity_id":456789,"client":{"phone":"+13155550175","name":"James Smith","email":"j.smith@example.com"},"custom_fields":{"my_custom_field":123}},"key":"update_group_event_custom_fields","summary":"Update custom fields on a Group Event Appointment","id":"paths/~1record~1{location_id}~1{record_id}/put/requestBody/content/application~1json/examples/update_group_event_custom_fields"},"paths/~1record~1{location_id}~1{record_id}/put/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":999,"services":[{"id":331,"first_cost":9000,"discount":50,"cost":4500},{"id":333,"first_cost":2000,"discount":10,"cost":1800}],"client":{"phone":"+13155550175","name":"James Smith","email":"j.smith@example.com"},"clients_count":1,"staff":{"id":8886,"name":"Jack","spec":"stylist"},"datetime":"2026-09-21T23:00:00.000-05:00","seance_length":3600,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"test appointment!","visit_attendance":1,"confirmed":1,"sms_before":6,"sms_now":1,"sms_now_text":"","email_now":1,"notified":0,"master_request":1,"api_id":"","from_url":"","review_requested":0,"activity_id":0,"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}]},"meta":[]},"id":"paths/~1record~1{location_id}~1{record_id}/put/responses/201/content/application~1json/example"},"paths/~1records~1partner/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-11-17T00:00:00-0500","create_date":"2026-11-17T16:08:08-0500","comment":"","deleted":false,"attendance":0,"length":3600,"notify_by_sms":1,"notify_by_email":12,"master_requested":true,"online":false,"api_id":42,"last_change_date":"2026-11-18T16:58:59-0500","prepaid":0,"prepaid_confirmed":0,"activity_id":0,"services":[{"id":1,"title":"beard trim","cost":100,"price_min":500,"price_max":1500,"discount":0,"amount":1}],"company":{"id":1,"title":"Business Example","public_title":"Business Example","business_group_id":1,"business_type_id":1,"country_id":7,"city_id":1,"timezone":"-5","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"http://app.alteg.io/images/icon.png","zip":"0","phone":"","phones":[],"site":"www.example.com","allow_delete_record":true,"allow_change_record":true,"country":"United States","city":"New York"},"staff":{"id":1,"name":"James Smith","company_id":1,"specialization":"Barber","position":[],"rating":0,"show_rating":true,"comments_count":0,"votes_count":0,"average_score":0,"avatar":"http://app.alteg.io/images/no-master-sm.png","prepaid":"forbidden"},"client":{"id":1,"name":"James Smith","phone":"+13155550175","phone_code":"1","email":"j.smith@example.com"},"custom_fields":{"dop-telephone":"+13155550175"}}],"meta":{"count":1}},"id":"paths/~1records~1partner/get/responses/200/content/application~1json/example"},"paths/~1visits~1{visit_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"attendance":1,"datetime":"2026-09-21T23:00:00.000-05:00","comment":0,"records":[{"id":37955315,"company_id":4564,"staff_id":55436,"services":[],"events":[],"goods_transactions":[],"staff":{"id":55436,"name":"Kevin Spacey","specialization":"Manicure and pedicure","position":{"id":1,"title":"Administrator"},"avatar":"https://app.alteg.io/uploads/masters/sm/b/bb/bb59d4cc17d9b16_20171215174158.png","avatar_big":"https://app.alteg.io/uploads/masters/origin/c/cf/cfb8c5cee58000b_20171215174158.png","rating":4.89,"votes_count":0},"client":{"id":4240788,"name":"dev1","phone":13155550175,"card":415,"email":"","success_visits_count":58,"fail_visits_count":9},"date":"2026-09-21T23:00:00.000-05:00","datetime":"2026-09-21T23:00:00.000-05:00","create_date":"2026-03-22T17:55:14-05:00","comment":"","online":false,"visit_attendance":1,"attendance":1,"confirmed":1,"seance_length":3600,"length":3600,"sms_before":1,"sms_now":1,"sms_now_text":"","email_now":1,"notified":0,"master_request":0,"api_id":0,"from_url":"","review_requested":0,"visit_id":8260852,"created_user_id":999290,"deleted":0,"paid_full":0,"prepaid":0,"prepaid_confirmed":0,"last_change_date":"2026-03-28T17:46:48-05:00","custom_color":"","custom_font_color":"","record_labels":[],"activity_id":0,"custom_fields":[],"documents":[{"id":8172893,"type_id":7,"storage_id":0,"user_id":746310,"company_id":4564,"number":4163,"comment":"","date_created":"2026-09-21T23:00:00.000-05:00","category_id":0,"visit_id":3,"record_id":2,"type_title":"Visit"}]}]},"meta":[]},"id":"paths/~1visits~1{visit_id}/get/responses/200/content/application~1json/example"},"paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"payment_transactions":[{"id":6023813,"document_id":8172806,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":32299,"amount":10,"client_id":4241492,"master_id":0,"supplier_id":0,"comment":"","item_id":1162679,"target_type_id":1,"record_id":13136569,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":32299,"title":"Deposits (payment in cash)"},"client":{"id":4241492,"name":"ModulKassaClient","phone":"+13155550175"},"master":[],"supplier":[]}],"loyalty_transactions":[{"id":10614,"status_id":1,"amount":0.5,"type_id":2,"program_id":145,"card_id":20013,"salon_group_id":646,"item_id":0,"item_type_id":0,"item_record_id":0,"goods_transaction_id":0,"is_discount":false,"is_loyalty_withdraw":false,"type":{"id":2,"title":"Loyalty programs"}}],"kkm_transaction_details_container":{"last_operation_type":0,"transactions":[{"id":1047,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":1,"sum":13,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":2045,"type":7,"type_title":"Visit"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"items":[{"id":0,"item_id":1162679,"item_type_id":1,"record_id":13136569,"item_title":"Haircut at the TOP-specialist","amount":2,"first_cost":20,"manual_cost":10,"discount":50,"cost":10,"master_id":13136569,"good_id":0,"service_id":1162679,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]},"meta":[]},"id":"paths/~1visit~1details~1{location_id}~1{record_id}~1{visit_id}/get/responses/200/content/application~1json/example"},"paths/~1attendance~1receipt_print~1{visit_id}/get/responses/200/content/application~1pdf/example":{"value":"","id":"paths/~1attendance~1receipt_print~1{visit_id}/get/responses/200/content/application~1pdf/example"},"paths/~1comments~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":18437,"type":1,"master_id":8864,"text":"Fine!","date":"2026-09-21T23:00:00.000-05:00","rating":4,"user_id":157169,"user_name":"Victor Sitnikov","user_avatar":"/images/no-master.png","record_id":100001}],"meta":[]},"id":"paths/~1comments~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1comments~1{location_id}~1{team_member_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"type":1,"master_id":8864,"id":18437,"text":"Everything is very bad!","date":"2026-09-21T23:00:00.000-05:00","rating":4,"user_id":157169,"user_name":"Victor","user_avatar":"/images/no-master.png"},"meta":[]},"id":"paths/~1comments~1{location_id}~1{team_member_id}/post/responses/201/content/application~1json/example"},"paths/~1activity~1{location_id}~1search/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":3480140,"service_id":5243360,"company_id":68570,"staff_id":921105,"date":"2026-09-21T23:00:00.000-05:00","length":3600,"capacity":40,"records_count":0,"color":"","instructions":"","stream_link":"","font_color":"","notified":false,"prepaid":"forbidden","service":{"id":5243360,"category_id":5092305,"title":"Lecture on psychoanalysis","price_min":500,"price_max":500,"comment":"Not","image_url":"","salon_service_id":5792535,"prepaid":"forbidden","category":{"id":5092305,"category_id":1,"title":"Psychoanalysis"}},"staff":{"id":921105,"name":"Natalie","company_id":68570,"specialization":"Psychotherapist","rating":4.57,"show_rating":false,"avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master-sm.png","comments_count":7,"votes_count":0,"average_score":4.57,"prepaid":"forbidden","position":{"id":123340,"title":"Psychotherapist"}},"resource_instances":[{"id":83030,"title":"Psychotherapist's office. #one","resource_id":34895}],"labels":[]}],"meta":{"count":1}},"id":"paths/~1activity~1{location_id}~1search/get/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1search_dates/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":["2026-06-01","2026-06-02","2026-06-08","2026-07-04","2026-07-15"],"meta":[]},"id":"paths/~1activity~1{location_id}~1search_dates/get/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1search_dates_range/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"min_date":"2026-06-01","max_date":"2026-07-15"},"meta":[]},"id":"paths/~1activity~1{location_id}~1search_dates_range/get/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1filters/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"code":"staff","title":"Team Member","data":[{"id":1,"title":"Team Member 1","is_disabled":true},{"id":2,"title":"Team Member 2","is_disabled":false}]},{"code":"service","title":"Service","data":[{"id":1,"title":"Service 1","is_disabled":true},{"id":2,"title":"Service 2","is_disabled":false}]},{"code":"resource","title":"Resource","data":[{"id":1,"title":"Resource 1","is_disabled":true},{"id":2,"title":"Resource 2","is_disabled":false}]},{"code":"service_category","title":"Service category","data":[{"id":1,"title":"Category 1","is_disabled":true},{"id":2,"title":"Category 2","is_disabled":false}]}],"meta":{"count":4}},"id":"paths/~1activity~1{location_id}~1filters/get/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":9182,"service_id":1209148,"salon_id":4564,"master_id":1000265,"date":"2026-09-21T23:00:00.000-05:00","length":7200,"capacity":5,"records_count":0,"color":"","instructions":"","stream_link":"","font_color":"","notified":false,"timestamp":"2026-09-21T23:00:00.000-05:00","service":{"id":1209148,"category_id":1285356,"title":"Fitness \"test\"","price_min":2,"price_max":3,"prepaid":"forbidden"},"resource_instances":[{"id":1094,"title":"Massage room 1st floor","resource_id":464}],"master":{"id":1000265,"name":"Master","company_id":4564,"specialization":321,"rating":0,"show_rating":true,"prepaid":"allowed","position":[]},"records":[],"labels":[]}],"meta":{"count":2}},"id":"paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/409/content/application~1json/example":{"value":{"success":false,"meta":{"message":"The master is busy or not working: 2026-10-01 10:30","conflict":true}},"id":"paths/~1activity~1{location_id}~1{event_id}~1duplicate/post/responses/409/content/application~1json/example"},"paths/~1activity~1{location_id}~1services/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1209148,"title":"Fitness test","capacity":5,"price_min":2,"price_max":3,"is_multi":true,"category":{"id":1285356,"title":"Group services"},"staff":[{"id":37695,"name":"John Doe","length":7200}],"resources":[{"id":464,"title":"massage room","salon_id":4564}]}],"meta":{"count":1}},"id":"paths/~1activity~1{location_id}~1services/get/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1duplication_strategy/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":2,"company_id":4564,"title":"test pattern","repeat_mode_id":1,"repeat_mode":{"id":1,"title":"Daily"},"days":[],"interval":0,"content_type":1}],"meta":{"count":1}},"id":"paths/~1activity~1{location_id}~1duplication_strategy/get/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1duplication_strategy/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":3,"company_id":4564,"title":"Test duplication strategy","repeat_mode_id":5,"repeat_mode":{"id":5,"title":"Every week"},"days":[1,4],"interval":2,"content_type":1},"meta":[]},"id":"paths/~1activity~1{location_id}~1duplication_strategy/post/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":3,"company_id":4564,"title":"New test duplication strategy","repeat_mode_id":5,"repeat_mode":{"id":5,"title":"Every week"},"days":[2,3],"interval":3,"content_type":1},"meta":[]},"id":"paths/~1activity~1{location_id}~1duplication_strategy~1{strategy_id}/post/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1{event_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":108,"salon_id":4564,"service_id":1185299,"staff_id":26427,"date":"2026-09-21T23:00:00.000-05:00","length":3600,"capacity":9,"records_count":0,"color":"","font_color":"","service":{"id":1185299,"title":"Group manicure","category_id":754917},"staff":{"id":26427,"name":"Monica Bellucci","company_id":4564},"resource_instances":[{"id":3127,"title":"Manicure machine #1","resource_id":1364}]},"meta":[]},"id":"paths/~1activity~1{location_id}~1{event_id}/get/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1{event_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":108,"salon_id":4564,"service_id":1185299,"staff_id":26427,"date":"2026-09-21T23:00:00.000-05:00","length":3600,"capacity":9,"records_count":0,"color":"","font_color":"","service":{"id":1185299,"title":"Group manicure","category_id":754917},"staff":{"id":26427,"name":"Monica Bellucci","company_id":4564},"resource_instances":[{"id":3127,"title":"Manicure machine #1","resource_id":1364}]},"meta":[]},"id":"paths/~1activity~1{location_id}~1{event_id}/put/responses/200/content/application~1json/example"},"paths/~1activity~1{location_id}~1{event_id}/delete/responses/202/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1activity~1{location_id}~1{event_id}/delete/responses/202/content/application~1json/example"},"paths/~1activity~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":108,"salon_id":4564,"service_id":1185299,"staff_id":26427,"date":"2026-09-21T23:00:00.000-05:00","length":3600,"capacity":9,"records_count":0,"color":"","font_color":"","service":{"id":1185299,"title":"Group manicure","category_id":754917},"staff":{"id":26427,"name":"Monica Bellucci","company_id":4564},"resource_instances":[{"id":3127,"title":"Manicure machine #1","resource_id":1364}]},"meta":[]},"id":"paths/~1activity~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"date":"2026-09-21T23:00:00.000-05:00","is_working":1,"slots":[{"from":"10:00","to":"14:00"},{"from":"15:00","to":"23:15"}]},{"date":"2026-09-21T23:00:00.000-05:00","is_working":1,"slots":[{"from":"10:00","to":"14:30"},{"from":"15:00","to":"22:10"}]},{"date":"2026-09-21T23:00:00.000-05:00","is_working":0,"slots":[]},{"date":"2026-09-21T23:00:00.000-05:00","is_working":1,"slots":[{"from":"10:00","to":"14:00"},{"from":"15:00","to":"22:00"}]}],"meta":[]},"id":"paths/~1schedule~1{location_id}~1{team_member_id}~1{start_date}~1{end_date}/get/responses/200/content/application~1json/example"},"paths/~1timetable~1dates~1{location_id}~1{date}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":["2026-09-21T23:00:00.000-05:00","2026-09-21T23:00:00.000-05:00","2026-09-21T23:00:00.000-05:00","2026-09-21T23:00:00.000-05:00","2026-09-21T23:00:00.000-05:00","2026-09-21T23:00:00.000-05:00","2026-09-21T23:00:00.000-05:00"],"meta":[]},"id":"paths/~1timetable~1dates~1{location_id}~1{date}/get/responses/200/content/application~1json/example"},"paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"time":"10:00","is_free":true},{"time":"10:15","is_free":true},{"time":"10:30","is_free":true},{"time":"10:45","is_free":true},{"time":"11:00","is_free":false},{"time":"11:15","is_free":false},{"time":"11:30","is_free":false},{"time":"11:45","is_free":false},{"time":"12:00","is_free":false},{"time":"12:15","is_free":false},{"time":"12:30","is_free":false},{"time":"12:45","is_free":false},{"time":"13:00","is_free":true},{"time":"13:15","is_free":true},{"time":"13:30","is_free":true},{"time":"13:45","is_free":true},{"time":"14:00","is_free":true},{"time":"14:15","is_free":true},{"time":"14:30","is_free":true},{"time":"14:45","is_free":true},{"time":"15:00","is_free":true},{"time":"15:15","is_free":true},{"time":"15:30","is_free":true},{"time":"15:45","is_free":true},{"time":"16:00","is_free":true},{"time":"16:15","is_free":true},{"time":"16:30","is_free":false},{"time":"16:45","is_free":false},{"time":"17:00","is_free":false}],"meta":[]},"id":"paths/~1timetable~1seances~1{location_id}~1{team_member_id}~1{date}/get/responses/200/content/application~1json/example"},"paths/~1resources~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":70,"title":"Pedicure chair","instances":[{"id":181,"title":"Pedicure chair #1","resource_id":70}]},{"id":464,"title":"massage room","instances":[{"id":1094,"title":"Massage room 1st floor","resource_id":464},{"id":1162,"title":"Massage room 2nd floor","resource_id":464}]}],"meta":{"count":2}},"id":"paths/~1resources~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1settings~1timetable/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"record_type":0,"activity_record_clients_count_max":1},"meta":[]},"id":"paths/~1company~1{location_id}~1settings~1timetable/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1settings~1timetable/patch/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"record_type":90,"activity_record_clients_count_max":1},"meta":[]},"id":"paths/~1company~1{location_id}~1settings~1timetable/patch/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1staff~1schedule/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"team_member_id":12345,"date":"2026-01-31","slots":[{"from":"10:00","to":"12:00"},{"from":"13:00","to":"19:00"}],"busy_intervals":[{"entity_type":"record","entity_id":456789,"from":"11:00:00","to":"12:00:00"},{"entity_type":"activity","entity_id":123456,"from":"15:00:00","to":"16:00:00"}],"off_day_type":null}],"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1staff~1schedule/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1staff~1schedule/put/requestBody/content/application~1json/example":{"value":{"schedules_to_set":[{"team_member_id":12345,"dates":["2026-01-31","2026-02-01"],"slots":[{"from":"10:00","to":"14:00"},{"from":"15:00","to":"19:00"}]}],"schedules_to_delete":[{"team_member_id":12345,"dates":["2026-02-02"]}]},"id":"paths/~1company~1{location_id}~1staff~1schedule/put/requestBody/content/application~1json/example"},"paths/~1schedule~1{location_id}~1{team_member_id}/put/requestBody/content/application~1json/example":{"value":[{"date":"2026-01-15","is_working":true,"slots":[{"from":"10:00","to":"14:30"},{"from":"15:00","to":"22:00"}]},{"date":"2026-01-16","is_working":true,"slots":[{"from":"10:00","to":"14:00"},{"from":"15:00","to":"23:15"}]}],"id":"paths/~1schedule~1{location_id}~1{team_member_id}/put/requestBody/content/application~1json/example"},"paths/~1goods~1search~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"parent_id":0,"item_id":0,"category_id":123,"title":"Root category 1","is_chain":true,"is_category":true,"is_item":false},{"parent_id":0,"item_id":0,"category_id":456,"title":"Root category 2","is_chain":true,"is_category":true,"is_item":false}],"meta":{"count":2}},"id":"paths/~1goods~1search~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1goods~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"title":"Shampoo 1","value":"Shampoo 1","label":"Shampoo 1 (123)","good_id":123456,"cost":100500,"unit_id":4835,"unit_short_title":"PC","service_unit_id":3548,"service_unit_short_title":"gr","actual_cost":1050,"unit_actual_cost":105,"unit_actual_cost_format":"105 r","unit_equals":10,"barcode":"123","loyalty_abonement_type_id":"0","loyalty_certificate_type_id":"0","loyalty_allow_empty_code":true,"critical_amount":0,"desired_amount":0,"actual_amounts":[{"storage_id":987,"amount":1000000}],"last_change_date":"2026-01-01T12:00:00-0500"}],"meta":[]},"id":"paths/~1goods~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"},"paths/~1goods~1{location_id}~1{product_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"title":"Shampoo 1","value":"Shampoo 1","label":"Shampoo 1 (123)","good_id":123456,"cost":100500,"unit_id":4835,"unit_short_title":"PC","service_unit_id":3548,"service_unit_short_title":"gr","actual_cost":1050,"unit_actual_cost":105,"unit_actual_cost_format":"105 r","unit_equals":10,"barcode":"123","loyalty_abonement_type_id":"0","loyalty_certificate_type_id":"0","loyalty_allow_empty_code":true,"critical_amount":0,"desired_amount":0,"actual_amounts":[{"storage_id":987,"amount":1000000}],"last_change_date":"2026-01-01T12:00:00-0500"}],"meta":[]},"id":"paths/~1goods~1{location_id}~1{product_id}/put/responses/200/content/application~1json/example"},"paths/~1goods~1{location_id}~1{product_id}/put/responses/409/content/application~1json/example":{"value":{"success":false,"meta":{"message":"The product already has inventory operations, you need to specify the rules for converting units of measure for inventory operations","conflict":true}},"id":"paths/~1goods~1{location_id}~1{product_id}/put/responses/409/content/application~1json/example"},"paths/~1goods~1{location_id}~1{product_id}/put/responses/422/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"The specified taxation system is not available for this country."},{"message":"The specified VAT is not available for this taxation system."},{"[title]":["This field is missing."],"[category_id]":["This field is missing."],"[sale_unit_id]":["This field is missing."],"[service_unit_id]":["This field is missing."]}]}},"id":"paths/~1goods~1{location_id}~1{product_id}/put/responses/422/content/application~1json/example"},"paths/~1goods~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"title":"Shampoo 1","value":"Shampoo 1","label":"Shampoo 1 (123)","good_id":123456,"cost":100500,"unit_id":4835,"unit_short_title":"PC"}],"meta":[]},"id":"paths/~1goods~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1goods~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":[{"title":"Shampoo 1","value":"Shampoo 1","label":"Shampoo 1 (123)","good_id":123456,"cost":100500,"unit_id":4835,"unit_short_title":"PC","service_unit_id":3548,"service_unit_short_title":"gr","actual_cost":1050,"unit_actual_cost":105,"unit_actual_cost_format":"105 r","unit_equals":10,"barcode":"123","loyalty_abonement_type_id":"0","loyalty_certificate_type_id":"0","loyalty_allow_empty_code":true,"critical_amount":0,"desired_amount":0,"actual_amounts":[{"storage_id":987,"amount":1000000}],"last_change_date":"2026-01-01T12:00:00-0500"}],"meta":[]},"id":"paths/~1goods~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1goods~1{location_id}/post/responses/422/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Possible error messages","errors":[{"message":"The specified taxation system is not available for this country."},{"message":"The specified VAT is not available for this taxation system."},{"[title]":["This field is missing."],"[category_id]":["This field is missing."],"[sale_unit_id]":["This field is missing."],"[service_unit_id]":["This field is missing."]}]}},"id":"paths/~1goods~1{location_id}/post/responses/422/content/application~1json/example"},"paths/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":25214,"title":"Doughter 1","parent_category_id":24843},{"id":25213,"title":"Root 1"},{"id":25219,"title":"Root 2"}],"meta":{"count":94}},"id":"paths/~1company~1{location_id}~1goods_categories~1{parent_category_id}/get/responses/200/content/application~1json/example"},"paths/~1goods~1category_node~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"parent_id":0,"item_id":0,"category_id":123,"title":"Root category 1","is_chain":false,"is_category":true,"is_item":false,"children":[{"parent_id":123,"item_id":0,"category_id":456,"title":"Child category","is_chain":false,"is_category":true,"is_item":false},{"parent_id":123,"item_id":789,"category_id":0,"title":"Child product","is_chain":false,"is_category":false,"is_item":true}],"children_count":2}},"id":"paths/~1goods~1category_node~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example"},"paths/~1goods_categories~1multiple~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"title":"Category 1"},{"id":2,"title":"Category 2"}],"meta":[]},"id":"paths/~1goods_categories~1multiple~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1goods_categories~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":123456,"title":"Manicure","parent_category_id":123457},"meta":[]},"id":"paths/~1goods_categories~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1goods_categories~1{location_id}~1{category_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":123456,"title":"Manicure","parent_category_id":123457},"meta":[]},"id":"paths/~1goods_categories~1{location_id}~1{category_id}/put/responses/200/content/application~1json/example"},"paths/~1goods_categories~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"title":"Category 1"},{"id":2,"title":"Category 2"}],"meta":[]},"id":"paths/~1goods_categories~1{location_id}~1{category_id}/get/responses/200/content/application~1json/example"},"paths/~1storages~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"title":"Consumables","for_service":1,"for_sale":0,"comment":"To account for consumables"},{"id":2,"title":"Products","for_service":0,"for_sale":1,"comment":"To record store sales"},{"id":23061,"title":"Ors","for_service":0,"for_sale":1,"comment":"Nz"}],"meta":[]},"id":"paths/~1storages~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1storages~1transactions~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":123456789,"document_id":22256643,"type_id":987654321,"type":"Something","good":{"id":111222333,"title":"Something"},"storage":{"id":333222111,"title":"Storage 1"},"unit":{"id":333222111,"title":"milliliter"},"operation_unit_type":1,"create_date":"2026-12-21T19:08:00-0500","last_change_date":"2026-02-01T12:00:00-0500","cost_per_unit":1.07,"cost":0,"discount":10,"master":{"id":112233445,"title":"James Smith"},"supplier":{"id":11112222,"title":"Best Supplier Ever"},"record_id":1,"service":{"id":1234321,"title":"Service 4"},"clients":{"id":4321234,"name":"George Smith","phone":13155550176}}],"meta":[]},"id":"paths/~1storages~1transactions~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1storage_operations~1operation~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"document":{"id":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":91271,"user_id":999290,"company_id":4564,"number":1254,"comment":"test document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":91271,"title":"Secret place"},"company":{"id":4564,"title":"Business example","country_id":7,"city_id":2},"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com","user":{"id":999290,"name":"User name","phone":"+13155550175"}},"transactions":[{"id":3428012,"document_id":22255506,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"storage_id":91271,"supplier_id":0,"client_id":0,"master_id":0,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"test transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe"},"storage":{"id":91271,"title":"Secret place"},"supplier":[],"client":[],"master":[],"unit":{"id":1,"title":"Thing"}}]},"meta":[]},"id":"paths/~1storage_operations~1operation~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1storage_operations~1documents~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":22255503,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":36539,"user_id":999290,"company_id":4564,"number":1251,"comment":"Document comment","create_date":"2026-04-24 20:00:00","storage":{"id":36539,"title":"Products"},"company":{"id":4564,"title":"Business example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","ccoordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}},"meta":[]},"id":"paths/~1storage_operations~1documents~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1storage_operations~1documents~1{location_id}~1{document_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":22255503,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":36539,"user_id":999290,"company_id":4564,"number":1251,"comment":"Document comment","create_date":"2026-04-24 20:00:00","storage":{"id":36539,"title":"Products"},"company":{"id":4564,"title":"Business example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}},"meta":[]},"id":"paths/~1storage_operations~1documents~1{location_id}~1{document_id}/get/responses/200/content/application~1json/example"},"paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":22255503,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"storage_id":36539,"user_id":999290,"company_id":4564,"number":1251,"comment":"Updated document comment","create_date":"2026-09-21T23:00:00.000-05:00","storage":{"id":36539,"title":"Products"},"company":{"id":4564,"title":"Business example","country_id":7,"city_id":2,"timezone":"-5","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"https://app.alteg.io/uploads/s_120d9410f1472a4e6bdbafefe7eeba42.png","zip":"","phones":[],"site":"www.example.com"},"user":{"id":999290,"name":"User name","phone":"+13155550175"}},"meta":[]},"id":"paths/~1storage_operations~1documents~1{location_id}~1{document_id}/put/responses/200/content/application~1json/example"},"paths/~1storage_operations~1goods_transactions~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":3428010,"document_id":22254960,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"storage_id":36539,"supplier_id":0,"client_id":0,"master_id":26781,"create_date":"2026-09-21T23:00:00.000-05:00","last_change_date":"2026-02-01T12:00:00-0500","comment":"Transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe"},"storage":{"id":36539,"title":"Products"},"supplier":[],"client":[],"master":{"id":26781,"name":"Angelina Jolie"},"unit":{"id":1,"title":"Thing"}},"meta":[]},"id":"paths/~1storage_operations~1goods_transactions~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":3428010,"document_id":22254960,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"storage_id":36539,"supplier_id":0,"client_id":0,"master_id":26781,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"Transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe","unit":"PC.","value":"delete yy","label":"delete yy","article":"","category":"goose category","category_id":303603,"salon_id":91372,"good_id":15086312,"cost":500,"unit_id":216760,"unit_short_title":"PC","service_unit_id":216760,"service_unit_short_title":"PC","actual_cost":0,"unit_actual_cost":0,"unit_actual_cost_format":"0 USD","unit_equals":1,"barcode":"","loyalty_abonement_type_id":"0","loyalty_certificate_type_id":"0","loyalty_allow_empty_code":true,"actual_amounts":[],"last_change_date":"2026-03-05T18:21:34-0500"},"storage":{"id":36539,"title":"Products"},"sale_unit":null,"service_unit":null,"supplier":[],"client":[],"master":{"id":26781,"name":"Angelina Jolie"},"unit":{"id":1,"title":"Thing","short_title":"PC."}},"meta":[]},"id":"paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example"},"paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":3428010,"document_id":22254960,"type_id":1,"type":{"id":1,"title":"Sale of goods"},"company_id":4564,"good_id":232674,"amount":-1,"cost_per_unit":100,"discount":10,"cost":90,"unit_id":1,"operation_unit_type":1,"storage_id":36539,"supplier_id":0,"client_id":0,"master_id":26781,"create_date":"2026-09-21T23:00:00.000-05:00","last_change_date":"2026-02-01T12:00:00-0500","comment":"Updated transaction comment","deleted":false,"good":{"id":232674,"title":"Edition De Luxe"},"storage":{"id":36539,"title":"Products"},"supplier":[],"client":[],"master":{"id":26781,"name":"Angelina Jolie"},"unit":{"id":1,"title":"Thing"}},"meta":[]},"id":"paths/~1storage_operations~1goods_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example"},"paths/~1storage_operations~1documents~1goods_transactions~1{document_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":3728232,"document_id":22256643,"type_id":1,"company_id":4564,"good_id":587018,"amount":-10,"cost_per_unit":100,"discount":0,"cost":1000,"unit_id":88272,"operation_unit_type":1,"storage_id":36539,"supplier_id":0,"record_id":0,"client_id":0,"master_id":49754,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"","service_id":0,"user_id":3,"deleted":false,"pkg_amount":0},{"id":3728233,"document_id":22256643,"type_id":1,"company_id":4564,"good_id":232674,"amount":-10,"cost_per_unit":127.5,"discount":0,"cost":1275,"unit_id":1,"operation_unit_type":2,"storage_id":36539,"supplier_id":0,"record_id":0,"client_id":0,"master_id":49754,"create_date":"2026-09-21T23:00:00.000-05:00","comment":"","service_id":0,"user_id":3,"deleted":false,"pkg_amount":0}],"meta":{"count":2}},"id":"paths/~1storage_operations~1documents~1goods_transactions~1{document_id}/get/responses/200/content/application~1json/example"},"paths/~1technological_cards~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"title":"Tech map 1","technological_card_items":[{"id":3,"technological_card_id":1,"storage_id":4234,"good_id":34234,"amount":12,"unit":"l","price":0.0742,"title":"Consumable 3"}]},{"id":2,"title":"Tech map 2","technological_card_items":[{"id":4,"technological_card_id":2,"storage_id":4234,"good_id":34235,"amount":10,"unit":"l","price":0.02412,"title":"Consumable 4"}]}],"meta":[]},"id":"paths/~1technological_cards~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":1,"title":"Tech map 1","technological_card_items":[{"id":3,"technological_card_id":1,"storage_id":4234,"good_id":34234,"amount":12,"unit":"l","price":0.0742,"title":"Consumable 3"}]},"meta":[]},"id":"paths/~1technological_cards~1default_for_staff_and_service~1{location_id}~1{team_member_id}~1{service_id}/get/responses/200/content/application~1json/example"},"paths/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"service_id":21558,"record_id":1233243,"technological_cards":[{"id":36069,"title":"Tech map","technological_card_items":[{"id":208568,"technological_card_id":36069,"storage_id":91303,"good_id":6858783,"amount":10,"price":1000,"good":{"id":6858783,"title":"Product","unit":"G"}}]}],"consumables":[{"goods_transaction_id":2180771,"record_id":121793129,"service_id":695486,"storage_id":91303,"good_id":6858783,"price":1000,"amount":10,"good":{"id":6858783,"title":"Product","unit":"G"}}]}],"meta":[]},"id":"paths/~1technological_cards~1record_consumables~1{location_id}~1{record_id}/get/responses/200/content/application~1json/example"},"paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"service_id":21558,"record_id":1233243,"technological_cards":[{"id":36069,"title":"Tech map","technological_card_items":[{"id":208568,"technological_card_id":36069,"storage_id":91303,"good_id":6858783,"amount":10,"price":1000,"good":{"id":6858783,"title":"Product","unit":"G"}}]}],"consumables":[{"goods_transaction_id":2180771,"record_id":121793129,"service_id":695486,"storage_id":91303,"good_id":6858783,"price":1000,"amount":10,"good":{"id":6858783,"title":"Product","unit":"G"}}]}],"meta":[]},"id":"paths/~1technological_cards~1record_consumables~1consumables~1{location_id}~1{record_id}~1{service_id}/put/responses/200/content/application~1json/example"},"paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"service_id":7224099,"record_id":310013764,"technological_cards":[],"consumables":[]}],"meta":{"count":1}},"id":"paths/~1technological_cards~1record_consumables~1technological_cards~1{location_id}~1{record_id}~1{service_id}/delete/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1sale~1{document_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE Chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"chain":{"id":231,"title":"Example chain."},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}}]},"meta":[]},"id":"paths/~1company~1{location_id}~1sale~1{document_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"chain":{"id":231,"title":"Example chain."},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true},"chain":{"id":231,"title":"Example chain."}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}}]},"meta":[]},"id":"paths/~1company~1{location_id}~1sale~1{document_id}~1payment/post/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}}]},"meta":[]},"id":"paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1loyalty_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"state":{"items":[{"id":2181520,"type":"good","title":"item 12","amount":1,"default_cost_per_unit":1300,"default_cost_total":1300,"client_discount_percent":10,"cost_to_pay_total":1170},{"id":22017,"type":"service","document_id":8200391,"title":"Manicure","amount":1,"default_cost_per_unit":500,"default_cost_total":500,"client_discount_percent":10,"cost_to_pay_total":450}],"loyalty_transactions":[{"id":25042,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":9.9,"type_id":11,"created_at":"2026-09-21T23:00:00.000-05:00","deposit_transaction_id":775,"chain":{"id":500,"title":"YC BE Chain"},"type":{"id":11,"title":"Withdrawal from personal account"},"deposit":{"id":220,"balance":990.1,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}},{"id":25043,"document_id":8201102,"amount":0.1,"type_id":2,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_card_id":185395,"loyalty_program_id":264,"chain":{"id":231,"title":"Example chain."},"type":{"id":2,"title":"Loyalty programs"},"loyalty_card":{"id":185395,"type_id":265,"number":23100185395,"balance":50.15,"type":{"id":265,"type":"Loyalty program template test"},"chain":{"id":231,"title":"Example chain."}},"loyalty_program":{"id":264,"title":"CASHBACK BigBro","type_id":7,"is_value_percent":true,"type":{"id":7,"title":"Cumulative cashback (paid)"},"chain":{"id":231,"title":"Example chain."}}},{"id":25050,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","amount":100,"type_id":8,"created_at":"2026-09-21T23:00:00.000-05:00","loyalty_certificate_id":339,"chain":{"id":79,"title":"Bank 24"},"type":{"id":8,"title":"Write-off from the certificate"},"loyalty_certificate":{"id":339,"balance":0,"applicable_balance":0,"type":{"id":20,"title":"Test Certificate","is_code_required":true}}}],"payment_transactions":[{"id":6033940,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":32,"account":{"id":90218,"title":"Cash by default","is_cash":true,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6033941,"document_id":8200904,"sale_item_id":2181442,"sale_item_type":"good","expense_id":7,"account_id":90218,"amount":27,"account":{"id":90218,"title":"location account","is_cash":true,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034121,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":43,"account":{"id":23182,"title":"Cards - acquiring by default","is_cash":false,"is_default":true},"expense":{"id":7,"title":"Sale of goods"}},{"id":6034122,"document_id":8201102,"sale_item_id":2181521,"sale_item_type":"good","expense_id":7,"account_id":23182,"amount":12,"account":{"id":23182,"title":"Cards - acquiring","is_cash":false,"is_default":false},"expense":{"id":7,"title":"Sale of goods"}}]},"kkm_state":{"last_operation_type":1,"transactions":[{"id":2424,"document_id":8200904,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":1,"title":"Successfully"},"document":{"id":7215,"type":1,"type_title":"Sale of goods"},"cashier":{"id":746310,"name":"Jack Smith"}}]},"payment_methods":[{"slug":"account","is_applicable":false,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"account_id":36785,"account":{"id":36785,"title":"Location account - non-cash","is_cash":false}},{"slug":"loyalty_card","is_applicable":true,"applicable_amount":51.65,"applicable_count":0,"applicable_value":0,"loyalty_card_id":19283,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_program","is_applicable":true,"applicable_amount":234,"applicable_count":0,"applicable_value":20,"loyalty_card_id":19283,"loyalty_program_id":183,"loyalty_card":{"id":19283,"type_id":155,"number":31200019283,"balance":51.65,"type":{"id":155,"type":"discount card"},"chain":{"id":312,"title":"Trinity group"}},"loyalty_program":{"id":183,"title":"permanent discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":312,"title":"Trinity group"}}},{"slug":"loyalty_abonement","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_abonement_id":27,"loyalty_abonement":{"id":27,"is_united_balance":false,"united_balance":0,"type":{"id":7,"title":"subscription to 5000 QA net","is_code_required":true},"balance_container":{"links":[{"count":5,"category":{"id":229680,"category_id":1,"title":"Manicure"}},{"count":5,"category":{"id":429813,"category_id":429812,"title":"1 Lesson"}}]}}},{"slug":"loyalty_certificate","is_applicable":true,"applicable_amount":1170,"applicable_count":0,"applicable_value":0,"loyalty_certificate_id":338,"loyalty_certificate":{"id":338,"balance":10000,"applicable_balance":10000,"type":{"id":130,"title":"test","is_code_required":true}}},{"slug":"referral_loyalty_program","is_applicable":false,"applicable_amount":0,"applicable_count":0,"applicable_value":0,"loyalty_program_id":424,"loyalty_program":{"id":424,"title":"Fixed discount","type_id":1,"is_value_percent":true,"type":{"id":1,"title":"Fixed discount"},"chain":{"id":231,"title":"Example chain."}}},{"slug":"deposit","is_applicable":true,"applicable_amount":9.9,"applicable_count":0,"applicable_value":0,"deposit_id":220,"deposit":{"id":220,"balance":1000,"reserved_balance":0,"type":{"id":5,"title":"deposit 1"}}}]},"meta":[]},"id":"paths/~1company~1{location_id}~1sale~1{document_id}~1payment~1payment_transaction~1{payment_transaction_id}/delete/responses/200/content/application~1json/example"},"paths/~1storage_operations~1documents~1finance_transactions~1{document_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":9053737,"date":"2026-09-21T23:00:00.000-05:00","type_id":2640,"expense_id":2640,"account_id":35501,"amount":434,"client_id":4240788,"master_id":0,"supplier_id":0,"comment":"Transaction comment","item_id":0,"target_type_id":0,"record_id":0,"expense":{"id":2640,"title":"Provision of corporate services"},"account":{"id":35501,"title":"Location account","type_id":0,"type":0,"comment":"","company_id":4564},"client":{"id":4240788,"name":"Client","phone":"+13155550175"},"master":[],"supplier":[]},{"id":9053738,"date":"2026-09-21T23:00:00.000-05:00","type_id":2640,"expense_id":2640,"account_id":35501,"amount":434,"client_id":4240788,"master_id":0,"supplier_id":0,"comment":"Transaction comment","item_id":0,"target_type_id":0,"record_id":0,"expense":{"id":2640,"title":"Provision of corporate services"},"account":{"id":35501,"title":"Location account","type_id":0,"type":0,"comment":"","company_id":4564},"client":{"id":4240788,"name":"Client","phone":"+13155550175"},"master":[],"supplier":[]}],"meta":[]},"id":"paths/~1storage_operations~1documents~1finance_transactions~1{document_id}/get/responses/200/content/application~1json/example"},"paths/~1accounts~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":13881,"title":"Main location account","type":0,"comment":"Standing at the reception"},{"id":13882,"title":"Payment account","type":1,"comment":"For non-cash payments"},{"id":21961,"title":"Advances","type":0,"comment":""}],"meta":[]},"id":"paths/~1accounts~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1transactions~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":4815162342,"document_id":22256641,"expense":{"id":5,"title":"Provision of services"},"date":"2026-04-13T15:34:31-0500","amount":1000,"comment":"Comment","master":{"id":1926,"title":"Sweeney Todd"},"supplier":{"id":1968,"title":"George"},"account":{"id":23182,"title":"Cards"},"client":{"id":481516,"name":"John Turk","phone":13155550176},"last_change_date":"2026-02-01T12:00:00-0500","record_id":308786662,"visit_id":262551993,"sold_item_id":7134634,"sold_item_type":"service"}],"meta":[]},"id":"paths/~1transactions~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1timetable~1transactions~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":4815162342,"document_id":22256641,"expense":{"id":5,"title":"Provision of services"},"date":"2026-04-13T15:34:31-0500","amount":1000,"comment":"Comment","master":{"id":1926,"title":"Sweeney Todd"},"supplier":{"id":1968,"title":"George"},"account":{"id":23182,"title":"Cards"},"client":{"id":481516,"name":"John Turk","phone":13155550176},"last_change_date":"2026-02-01T12:00:00-0500","record_id":308786662,"visit_id":262551993,"sold_item_id":7134634,"sold_item_type":"service"}],"meta":[]},"id":"paths/~1timetable~1transactions~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1finance_transactions~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":277016617,"document_id":0,"date":"2026-09-21T23:00:00.000-05:00","type_id":5,"expense_id":5,"account_id":774020,"amount":100,"client_id":51520012,"master_id":921395,"supplier_id":0,"comment":"Transaction comment","item_id":0,"target_type_id":0,"record_id":0,"goods_transaction_id":0,"expense":{"id":5,"title":"Provision of services"},"account":{"id":774020,"title":"Archive location account","is_cash":true,"is_default":false},"client":{"id":51520012,"name":"Sweeney Todd","phone":"+13155550175","email":"mail@example.com"},"master":{"id":921395,"name":"Valeria"},"supplier":[]},"meta":[]},"id":"paths/~1finance_transactions~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1finance_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":4815162342,"document_id":22256641,"expense":{"id":5,"title":"Provision of services"},"date":"2026-04-13T15:34:31-0500","amount":1000,"comment":"Comment","master":{"id":1926,"title":"Sweeney Todd"},"supplier":{"id":1968,"title":"George"},"account":{"id":23182,"title":"Cards"},"client":{"id":481516,"name":"John Turk","phone":13155550176},"last_change_date":"2026-02-01T12:00:00-0500","record_id":308786662,"visit_id":262551993,"sold_item_id":7134634,"sold_item_type":"service"}],"meta":[]},"id":"paths/~1finance_transactions~1{location_id}~1{transaction_id}/get/responses/200/content/application~1json/example"},"paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":4815162342,"document_id":22256641,"expense":{"id":5,"title":"Provision of services"},"date":"2026-04-13T15:34:31-0500","amount":1000,"comment":"Comment","master":{"id":1926,"title":"Sweeney Todd"},"supplier":{"id":1968,"title":"George"},"account":{"id":23182,"title":"Cards"},"client":{"id":481516,"name":"John Turk","phone":13155550176},"last_change_date":"2026-02-01T12:00:00-0500","record_id":308786662,"visit_id":262551993,"sold_item_id":7134634,"sold_item_type":"service"}],"meta":[]},"id":"paths/~1finance_transactions~1{location_id}~1{transaction_id}/put/responses/200/content/application~1json/example"},"paths/~1sms~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1sms~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1sms~1clients~1by_id~1{location_id}/post/responses/202/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1sms~1clients~1by_id~1{location_id}/post/responses/202/content/application~1json/example"},"paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/202/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1sms~1clients~1by_filter~1{location_id}/post/responses/202/content/application~1json/example"},"paths/~1email~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1email~1clients~1by_id~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1email~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1email~1clients~1by_filter~1{location_id}/post/responses/201/content/application~1json/example"},"paths/~1delivery~1status/post/responses/200/content/application~1json/example":{"value":{"success":true},"id":"paths/~1delivery~1status/post/responses/200/content/application~1json/example"},"paths/~1delivery~1status/post/responses/400/content/application~1json/example":{"value":{"error_code":5,"error_message":"explicit error message"},"id":"paths/~1delivery~1status/post/responses/400/content/application~1json/example"},"paths/~1delivery~1status/post/responses/401/content/application~1json/example":{"value":{"error_code":20,"error_message":"explicit error message"},"id":"paths/~1delivery~1status/post/responses/401/content/application~1json/example"},"paths/~1delivery~1status/post/responses/404/content/application~1json/example":{"value":{"error_code":30,"error_message":"explicit error message"},"id":"paths/~1delivery~1status/post/responses/404/content/application~1json/example"},"paths/~1notification_settings~1{location_id}~1notification_types/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_move_admin","channels":{"push":1,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":1,"sms":1,"email":1}},{"type":"record_create_offline_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_create_online_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_delete_admin","channels":{"push":0,"sms":0,"email":1}},{"type":"record_delete_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}}],"meta":{"count":9}},"id":"paths/~1notification_settings~1{location_id}~1notification_types/get/responses/200/content/application~1json/example"},"paths/~1notification_settings~1{location_id}~1users~1{user_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"mode":"staff","notification_types":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_delete_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":0,"sms":0,"email":0}}]},"meta":[]},"id":"paths/~1notification_settings~1{location_id}~1users~1{user_id}/get/responses/200/content/application~1json/example"},"paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"mode":"staff","notification_types":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_create_offline_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"record_delete_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":0,"sms":0,"email":0}}]},"meta":[]},"id":"paths/~1notification_settings~1{location_id}~1users~1{user_id}/post/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1settings~1online/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"confirm_number":false,"any_master":true,"seance_delay_step":90,"activity_online_record_clients_count_max":1},"meta":[]},"id":"paths/~1company~1{location_id}~1settings~1online/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1settings~1online/patch/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"confirm_number":false,"any_master":true,"seance_delay_step":90,"activity_online_record_clients_count_max":1},"meta":[]},"id":"paths/~1company~1{location_id}~1settings~1online/patch/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1settings~1timeslots/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"is_enabled":true,"weekdays_settings":[{"weekday":1,"timeslots":[7200,14400],"setting":{"grid_first_timeslot":0,"grid_last_timeslot":85800,"grid_display_step":7200,"grid_nearest_timeslot_delay":1800,"grid_base_type":"predefined","is_grid_flexible":false}}],"dates_settings":[{"date":"2026-12-25","timeslots":[],"setting":{"grid_first_timeslot":0,"grid_last_timeslot":85800,"grid_display_step":7200,"grid_nearest_timeslot_delay":1800,"grid_base_type":"predefined","is_grid_flexible":false}}]},"meta":[]},"id":"paths/~1company~1{location_id}~1settings~1timeslots/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1booking_forms/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"title":"Name","is_default":false,"description":"Description","without_menu":false,"service_step_default":0,"service_step_hide":false,"master_step_default":0,"master_step_hide":false,"service_step_num":2,"master_step_num":1,"datetime_step_num":3,"show_button":true,"button_position":"bottom right","form_position":"right","button_color":"#1c84c6","button_animation":true,"html_code":"","ab_test_enabled":false}],"meta":[]},"id":"paths/~1company~1{location_id}~1booking_forms/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1booking_forms/post/responses/201/content/application~1json/example":{"value":{"success":true,"data":{"id":1,"title":"Name","is_default":false,"description":"Description","without_menu":false,"service_step_default":0,"service_step_hide":false,"master_step_default":0,"master_step_hide":false,"service_step_num":2,"master_step_num":1,"datetime_step_num":3,"show_button":true,"button_position":"bottom right","form_position":"right","button_color":"#1c84c6","button_animation":true,"html_code":"","ab_test_enabled":false},"meta":[]},"id":"paths/~1company~1{location_id}~1booking_forms/post/responses/201/content/application~1json/example"},"paths/~1company~1{location_id}~1booking_forms~1{form_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":1,"title":"Name","is_default":false,"description":"Description","without_menu":false,"service_step_default":0,"service_step_hide":false,"master_step_default":0,"master_step_hide":false,"service_step_num":2,"master_step_num":1,"datetime_step_num":3,"show_button":true,"button_position":"bottom right","form_position":"right","button_color":"#1c84c6","button_animation":true,"html_code":"","ab_test_enabled":false},"meta":[]},"id":"paths/~1company~1{location_id}~1booking_forms~1{form_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":1,"title":"Name","is_default":false,"description":"Description","without_menu":false,"service_step_default":0,"service_step_hide":false,"master_step_default":0,"master_step_hide":false,"service_step_num":2,"master_step_num":1,"datetime_step_num":3,"show_button":true,"button_position":"bottom right","form_position":"right","button_color":"#1c84c6","button_animation":true,"html_code":"","ab_test_enabled":false},"meta":[]},"id":"paths/~1company~1{location_id}~1booking_forms~1{form_id}/patch/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get/responses/200/content/application~1json/example":{"value":[{"label":"Working day occupancy, %","data":[["2026-09-21T23:00:00.000-05:00",89.7],["2026-09-21T23:00:00.000-05:00",91.2]]}],"id":"paths/~1company~1{location_id}~1analytics~1overall~1charts~1fullness_daily/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get/responses/200/content/application~1json/example":{"value":[{"label":"Revenue","data":[["2026-09-21T23:00:00.000-05:00",1000],["2026-09-21T23:00:00.000-05:00",500]]}],"id":"paths/~1company~1{location_id}~1analytics~1overall~1charts~1income_daily/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get/responses/200/content/application~1json/example":{"value":[{"label":"Administrator","data":10},{"label":"Widget","data":30}],"id":"paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_source/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get/responses/200/content/application~1json/example":{"value":[{"label":"Customer expectation","data":10},{"label":"The client came","data":30},{"label":"Customer confirmed","data":5},{"label":"Client didn't come","data":2}],"id":"paths/~1company~1{location_id}~1analytics~1overall~1charts~1record_status/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get/responses/200/content/application~1json/example":{"value":[{"label":"Number of records","data":[["2026-09-21T23:00:00.000-05:00",1000],["2026-09-21T23:00:00.000-05:00",500]]},{"label":"Number of online appointments","data":[["2026-09-21T23:00:00.000-05:00",1000],["2026-09-21T23:00:00.000-05:00",500]]},{"label":"Number of new customer appointments","data":[["2026-09-21T23:00:00.000-05:00",1000],["2026-09-21T23:00:00.000-05:00",500]]}],"id":"paths/~1company~1{location_id}~1analytics~1overall~1charts~1records_daily/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"income_stats":{"new":{"all_sum":0,"returned_sum":0},"old":{"all_sum":0,"returned_sum":0},"total":{"all_sum":0,"returned_sum":0}},"currency":{"id":1,"iso":"USD","name":"US Dollar","symbol":"USD","is_symbol_after_amount":true},"income_stats_by_day":[{"date":"2026-09-21","new_sum":0,"old_sum":0},{"date":"2026-09-21","new_sum":0,"old_sum":0}]},"meta":[]},"id":"paths/~1company~1{location_id}~1analytics~1loyalty_programs~1income/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"client_stats":{"all_count":1,"lost_count":0,"returned_count":1,"returned_percent":100},"staff":{"id":1140369,"name":"Doniella Davy"}}],"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1analytics~1loyalty_programs~1staff/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"client_stats":{"new":{"all_count":0,"lost_count":0,"returned_count":0,"returned_percent":0},"old":{"all_count":0,"lost_count":0,"returned_count":0,"returned_percent":0},"total":{"all_count":0,"lost_count":0,"returned_count":0,"returned_percent":0}},"visits_stats_by_day":[{"date":"2026-09-21","new_count":0,"old_count":0},{"date":"2026-09-21","new_count":0,"old_count":0}]},"meta":[]},"id":"paths/~1company~1{location_id}~1analytics~1loyalty_programs~1visits/get/responses/200/content/application~1json/example"},"paths/~1reports~1z_report~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"stats":{"clients":7,"clients_average":123.45,"records":14,"records_average":4231.51,"visit_records":13,"visit_records_average":100500.01,"non_visit_records":1,"non_visit_records_average":200,"targets":14,"targets_paid":10255,"goods":4,"goods_paid":12452.18,"certificates":1,"certificates_paid":9876,"abonement":0,"abonement_paid":0},"paids":{"accounts":[{"title":"Cards","amount":6987},{"title":"Cash","amount":54321.13},{"title":"Cash register","amount":12531}],"discount":[{"title":"Advance Discount","amount":1816.875},{"title":"Written off bonuses","amount":800},{"title":"Promotion discount","amount":123}],"total":{"accounts":2657.13,"discount":1241.875}},"z_data":{"2026-09-21T23:00:00.000-05:00":[{"client_id":11223344,"client_name":"John Smith","client_phone":"+13155550175","client_email":"j.smith@example.com","masters":[{"master_id":321123,"master_name":"Robert Brown","service":[{"item_title":"Highlighting from 9 strands","first_cost":3500,"discount":0,"result_cost":3500,"transactions":[{"accounts_amount":0,"loyalty_amount":700,"payment_type":"Card: Gold Card"},{"accounts_amount":0,"loyalty_amount":100,"payment_type":"Card: Gold Card"},{"accounts_amount":0,"loyalty_amount":1,"payment_type":"Card: Bonus card"}]}],"good":[{"item_title":"Spray For Hair","first_cost":15,"discount":2.25,"result_cost":12.75,"transactions":[{"accounts_amount":12.75,"loyalty_amount":0,"payment_type":"Cash"}]}],"others":{"item_title":"Other operations","first_cost":347,"discount":0,"result_cost":347,"transactions":[{"accounts_amount":23,"loyalty_amount":0,"payment_type":"Cash"},{"accounts_amount":324,"loyalty_amount":0,"payment_type":"Cash"}]}}]}]},"currency":"USD"},"meta":[]},"id":"paths/~1reports~1z_report~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1labels~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"title":"test","salon_id":68570,"color":"#00ff11","entity":1,"id":3599560},"meta":[]},"id":"paths/~1labels~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1labels~1{location_id}/post/responses/202/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Accepted"}},"id":"paths/~1labels~1{location_id}/post/responses/202/content/application~1json/example"},"paths/~1labels~1{location_id}~1{entity}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":241625,"salon_id":68570,"title":"VIP client","color":"#ff2828","icon":"star","entity":1,"deleted":0,"not_editable":0},{"id":241626,"salon_id":68570,"title":"Regular client","color":"#009800","icon":"user","entity":1,"deleted":0,"not_editable":0}],"meta":[]},"id":"paths/~1labels~1{location_id}~1{entity}/get/responses/200/content/application~1json/example"},"paths/~1labels~1{location_id}~1{tag_id}/put/responses/202/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1labels~1{location_id}~1{tag_id}/put/responses/202/content/application~1json/example"},"paths/~1labels~1{location_id}~1{tag_id}/delete/responses/200/content/application~1json/example":{"value":{"success":true,"meta":{"message":"Accepted"}},"id":"paths/~1labels~1{location_id}~1{tag_id}/delete/responses/200/content/application~1json/example"},"paths/~1labels~1{location_id}~1{tag_id}/delete/responses/202/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Accepted"}},"id":"paths/~1labels~1{location_id}~1{tag_id}/delete/responses/202/content/application~1json/example"},"paths/~1deposits~1company~1{location_id}~1client~1{client_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"deposit":{"id":1,"salon_group_id":1,"deposit_type_id":1,"initial_balance":0,"balance":1000,"reserved_balance":0,"blocked":false,"date_create":"2026-09-21T23:00:00.000-05:00"},"deposit_type":{"id":1,"salon_group_id":1,"title":"Account type header","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false}}],"meta":{"count":1}},"id":"paths/~1deposits~1company~1{location_id}~1client~1{client_id}/get/responses/200/content/application~1json/example"},"paths/~1deposits~1chain~1{chain_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"deposit":{"id":1,"salon_group_id":1,"deposit_type_id":1,"initial_balance":0,"balance":1000,"reserved_balance":0,"blocked":false,"date_create":"2026-09-21T23:00:00.000-05:00"},"deposit_type":{"id":1,"salon_group_id":1,"title":"Account type header","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false},"client":{"id":1,"name":"Client name","phone":13155550180}}],"meta":{"count":1}},"id":"paths/~1deposits~1chain~1{chain_id}/get/responses/200/content/application~1json/example"},"paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"deposit":{"id":1,"salon_group_id":1,"deposit_type_id":"1,","initial_balance":0,"balance":1000,"reserved_balance":0,"blocked":false,"date_create":"2026-09-21T23:00:00.000-05:00"},"deposit_type":{"id":1,"salon_group_id":1,"title":"Account type header","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false}}],"meta":{"count":1}},"id":"paths/~1deposits~1chain~1{chain_id}~1phone~1{phone}/get/responses/200/content/application~1json/example"},"paths/~1deposits_operations~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"document":{"id":1,"user_id":1,"salon_id":1,"type_id":9,"type":{"id":9,"title":"Account replenishment (advance payment)"},"comment":"","number":1,"salon":{"id":1,"title":"Location in New York","public_title":"Location in New York","business_group_id":1,"business_type_id":1,"country_id":7,"city_id":2,"timezone":"-5","timezone_name":"America/New_York","address":"New York, 787 Jackson Drive","coordinate_lat":40.73061,"coordinate_lon":-73.935242,"logo":"http://app.alteg.io/images/icon.png","zip":"129090","phone":"+13155550175","phones":[],"site":"www.example.com","allow_delete_record":true,"allow_change_record":true},"user":{"id":1,"name":"James Smith","phone":"+13155550175"}},"deposits_transactions":[{"id":1,"salon_id":1,"salon_group_id":1,"document_id":1,"deposit_id":1,"deposit_type_id":1,"master_id":1,"user_id":1,"amount":100.5,"balance_after":12239.56,"reserved_balance_after":0,"comment":"","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false,"deposit":{"id":1,"deposit_type_id":1,"salon_group_id":1,"initial_balance":10000,"balance":12239.56,"reserved_balance":0,"blocked":false,"date_create":"2026-09-21T23:00:00.000-05:00"},"deposit_type":{"id":1,"salon_group_id":1,"title":"Account type 1","date_create":"2026-09-21T23:00:00.000-05:00","deleted":false}}],"payment_transactions":[{"id":1,"document_id":1,"date":"2026-09-21T23:00:00.000-05:00","type_id":10,"expense_id":10,"account_id":1,"amount":100.5,"client_id":1,"master_id":1,"supplier_id":0,"comment":"","item_id":1,"target_type_id":0,"record_id":0,"goods_transaction_id":0,"type":{"id":10,"title":"Refill"}}]},"meta":[]},"id":"paths/~1deposits_operations~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1loyalty~1client_cards~1{client_id}/get/responses/200/content/application~1json/example":{"value":{"id":9210520,"balance":100,"points":0,"paid_amount":1000,"sold_amount":1000,"visits_count":1,"number":14507109210520,"type_id":10992,"salon_group_id":145071,"type":{"id":10992,"title":"5+2","salon_group_id":145071},"salon_group":{"id":145071,"title":"Dough chain1."},"programs":[{"id":18005,"title":"5+2","value":0,"loyalty_type_id":13,"item_type_id":3,"value_unit_id":1,"group_id":145071,"loyalty_type":{"id":13,"title":"Discount for a given number of accumulated services","is_discount":true,"is_cashback":false,"is_static":false,"is_accumulative":false},"rules":[{"id":72803,"loyalty_program_id":18005,"loyalty_type_id":13,"value":20,"parameter":0},{"id":72804,"loyalty_program_id":18005,"loyalty_type_id":13,"value":10,"parameter":0},{"id":72805,"loyalty_program_id":18005,"loyalty_type_id":13,"value":100,"parameter":0}]}]},"id":"paths/~1loyalty~1client_cards~1{client_id}/get/responses/200/content/application~1json/example"},"paths/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"id":9210520,"balance":100,"points":0,"paid_amount":1000,"sold_amount":1000,"visits_count":1,"number":14507109210520,"type_id":10992,"salon_group_id":145071,"type":{"id":10992,"title":"5+2","salon_group_id":145071},"salon_group":{"id":145071,"title":"Dough chain1."},"programs":[{"id":18005,"title":"5+2","value":0,"loyalty_type_id":13,"item_type_id":3,"value_unit_id":1,"group_id":145071,"loyalty_type":{"id":13,"title":"Discount for a given number of accumulated services","is_discount":true,"is_cashback":false,"is_static":false,"is_accumulative":false},"rules":[{"id":72803,"loyalty_program_id":18005,"loyalty_type_id":13,"value":20,"parameter":0},{"id":72804,"loyalty_program_id":18005,"loyalty_type_id":13,"value":10,"parameter":0},{"id":72805,"loyalty_program_id":18005,"loyalty_type_id":13,"value":100,"parameter":0}]}]},"id":"paths/~1loyalty~1cards~1{phone}~1{chain_id}~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1loyalty~1card_types~1salon~1{location_id}/get/responses/200/content/application~1json/example":{"value":[{"id":10992,"title":"Cashback","salon_group_id":145071,"salon_group":{"id":145071,"title":"Chain 1"}},{"id":8230,"title":"Referral program","salon_group_id":145071,"salon_group":{"id":145071,"title":"Chain 1"}}],"id":"paths/~1loyalty~1card_types~1salon~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get/responses/200/content/application~1json/example":{"value":[{"id":10992,"title":"Cashback","salon_group_id":145071,"salon_group":{"id":145071,"title":"Chain 1"}},{"id":8230,"title":"Referral program","salon_group_id":145071,"salon_group":{"id":145071,"title":"Chain 1"}}],"id":"paths/~1loyalty~1card_types~1client~1{location_id}~1{phone}/get/responses/200/content/application~1json/example"},"paths/~1loyalty~1cards~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"id":9250498,"balance":0,"points":0,"paid_amount":16300,"sold_amount":19320,"visits_count":5,"number":1010101,"type_id":8230,"salon_group_id":145071,"type":{"id":8230,"title":"cashmesh","salon_group_id":145071},"salon_group":{"id":145071,"title":"Dough chain1."},"programs":[{"id":12720,"title":"cumulative cache paid","value":10,"loyalty_type_id":7,"item_type_id":0,"value_unit_id":1,"group_id":145071,"loyalty_type":{"id":7,"title":"Cumulative cashback (paid)","is_discount":false,"is_cashback":true,"is_static":false,"is_accumulative":true},"rules":[{"id":71149,"loyalty_program_id":12720,"loyalty_type_id":7,"value":10,"parameter":100}]}]},"id":"paths/~1loyalty~1cards~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1loyalty~1abonements/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":659878,"number":788376,"balance_string":"Surfing (x10)","is_frozen":false,"freeze_period":0,"period":9999,"period_unit_id":3,"status":{"id":1,"title":"Released","extended_title":"Released"},"balance_container":{"links":[{"count":10,"category":{"id":3129591,"category_id":1,"title":"Surfing"}}]},"type":{"id":97804,"salon_group_id":145071,"title":89999,"period":9999,"period_unit_id":3,"allow_freeze":false,"freeze_limit":0,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0,"balance_container":{"links":[{"count":10,"category":{"id":3129591,"category_id":1,"title":"Surfing"}}]}}}],"meta":{"count":1}},"id":"paths/~1loyalty~1abonements/get/responses/200/content/application~1json/example"},"paths/~1user~1loyalty~1abonements/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":659878,"number":788376,"balance_string":"Surfing (x10)","is_frozen":false,"freeze_period":0,"period":9999,"period_unit_id":3,"status":{"id":1,"title":"Released","extended_title":"Released"},"balance_container":{"links":[{"count":10,"category":{"id":3129591,"category_id":1,"title":"Surfing"}}]},"type":{"id":97804,"salon_group_id":145071,"title":89999,"period":9999,"period_unit_id":3,"allow_freeze":false,"freeze_limit":0,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0,"balance_container":{"links":[{"count":10,"category":{"id":3129591,"category_id":1,"title":"Surfing"}}]}}}],"meta":{"count":1}},"id":"paths/~1user~1loyalty~1abonements/get/responses/200/content/application~1json/example"},"paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/200/content/application~1json/example":{"value":[{"success":true,"data":[{"id":123,"number":123456,"balance_string":"Services (x5)","created_date":"2026-09-21T23:00:00.000-05:00","activated_date":"2026-09-21T23:00:00.000-05:00","is_frozen":false,"freeze_period":0,"period":0,"period_unit_id":1,"status":{"id":2,"title":"activated","extended_title":"activated"},"is_united_balance":false,"united_balance_services_count":0,"balance_container":{"links":[{"count":9,"category":{"id":7182839,"category_id":1,"title":"Services"}}]},"type":{"id":896,"salon_group_id":279982,"title":"Subscription for everything","period":0,"period_unit_id":1,"allow_freeze":true,"freeze_limit":0,"is_allow_empty_code":true,"is_united_balance":false,"united_balance_services_count":0,"is_code_required":false,"balance_container":{"links":[{"count":10,"category":{"id":7182839,"category_id":1,"title":"Services"}}]}}},{"id":720,"number":208867,"balance_string":"Some services (x10)","created_date":"2026-09-21T23:00:00.000-05:00","is_frozen":false,"freeze_period":0,"period":0,"period_unit_id":1,"status":{"id":3,"title":"Overdue","extended_title":"Overdue"},"is_united_balance":false,"united_balance_services_count":0,"balance_container":{"links":[{"count":10,"category":{"id":7182839,"category_id":1,"title":"Some services"}}]},"type":{"id":897,"salon_group_id":279982,"title":"Subscription for everything","period":0,"period_unit_id":1,"allow_freeze":true,"freeze_limit":0,"is_allow_empty_code":true,"is_united_balance":false,"united_balance_services_count":0,"is_code_required":false,"balance_container":{"links":[{"count":10,"category":{"id":7182839,"category_id":1,"title":"Some services"}}]}}}],"meta":{"count":2}}],"id":"paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/200/content/application~1json/example"},"paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/400/content/application~1json/example":{"value":[{"success":false,"meta":{"message":"Subscription IDs or date range not specified."}}],"id":"paths/~1chain~1{chain_id}~1loyalty~1abonements/get/responses/400/content/application~1json/example"},"paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":12233,"salon_group_id":123,"title":"Subscription with the possibility of freezing for 14 days","period":0,"period_unit_id":0,"allow_freeze":true,"freeze_limit":14,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0}],"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1loyalty~1abonement_types~1fetch/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":12233,"salon_group_id":123,"title":"Subscription with the possibility of freezing for 14 days","period":0,"period_unit_id":0,"allow_freeze":true,"freeze_limit":14,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0},{"id":255789,"salon_group_id":456,"title":"Subscription for 6 months","period":6,"period_unit_id":3,"allow_freeze":false,"freeze_limit":0,"is_allow_empty_code":false,"is_united_balance":false,"united_balance_services_count":0}],"meta":{"count":2}},"id":"paths/~1company~1{location_id}~1loyalty~1abonement_types~1search/get/responses/200/content/application~1json/example"},"paths/~1loyalty~1certificates/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":409726,"number":888,"balance":9000,"default_balance":9000,"type_id":27841,"status_id":2,"created_date":"2026-09-21T23:00:00.000-05:00","expiration_date":"2026-09-21T23:00:00.000-05:00","type":{"id":27841,"title":"certificate 9000","balance":9000,"is_multi":true,"company_group_id":128284,"item_type_id":0,"expiration_type_id":2,"expiration_timeout":365,"expiration_timeout_unit_id":1,"is_allow_empty_code":false,"item_type":{"id":0,"title":"No limits"}},"status":{"id":2,"title":"activated"}}],"meta":{"count":1}},"id":"paths/~1loyalty~1certificates/get/responses/200/content/application~1json/example"},"paths/~1user~1loyalty~1certificates/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":409726,"number":888,"balance":9000,"default_balance":9000,"type_id":27841,"status_id":2,"created_date":"2026-09-21T23:00:00.000-05:00","expiration_date":"2026-09-21T23:00:00.000-05:00","type":{"id":27841,"title":"certificate 9000","balance":9000,"is_multi":true,"company_group_id":128284,"item_type_id":0,"expiration_type_id":2,"expiration_timeout":365,"expiration_timeout_unit_id":1,"is_allow_empty_code":false,"item_type":{"id":0,"title":"No limits"}},"status":{"id":2,"title":"activated"}}],"meta":{"count":1}},"id":"paths/~1user~1loyalty~1certificates/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"title":"Fixed burn date certificate without application restrictions","balance":10,"is_multi":true,"company_group_id":12,"item_type_id":0,"expiration_type_id":1,"expiration_date":"2026-09-21T23:00:00.000-05:00","expiration_timeout":0,"expiration_timeout_unit_id":0,"is_allow_empty_code":true}],"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1loyalty~1certificate_types~1fetch/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"title":"Fixed burn date certificate without application restrictions","balance":10,"is_multi":true,"company_group_id":12,"item_type_id":0,"expiration_type_id":1,"expiration_date":"2026-09-21T23:00:00.000-05:00","expiration_timeout":0,"expiration_timeout_unit_id":0,"is_allow_empty_code":true},{"id":11,"title":"Certificate valid for 6 months from the date of sale for any goods without services","balance":100,"is_multi":false,"company_group_id":12,"item_type_id":2,"expiration_type_id":2,"expiration_timeout":6,"expiration_timeout_unit_id":3,"is_allow_empty_code":false}],"meta":{"count":2}},"id":"paths/~1company~1{location_id}~1loyalty~1certificate_types~1search/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1loyalty~1programs~1search/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":53591,"title":"100 USD discount on Altegio Implementation Consultation","type":"discount_static","loyalty_type_id":1,"item_type_id":4,"service_item_type":"custom_allowed","good_item_type":"any_allowed","value_unit_id":2,"value_unit":"amount","group_id":502054,"usage_limit":0,"visit_multiplicity":1,"sold_items_multiplicity":1,"current_package_progress":0,"allowed_usages_amount":0,"expiration_timeout":0,"expiration_timeout_unit":"day","expiration_notification_timeout":0,"params_source_type":"loyalty_card","on_changed_notification_template_id":0,"on_expiration_notification_template_id":0}],"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1loyalty~1programs~1search/get/responses/200/content/application~1json/example"},"paths/~1visit~1loyalty~1transactions~1{visit_id}/get/responses/200/content/application~1json/example":{"value":[{"id":22989715,"status_id":1,"amount":100,"type_id":1,"program_id":12705,"card_id":0,"salon_group_id":145071,"item_id":5048371,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96082477,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion discount"},"program":{"id":12705,"title":"invited","value":10,"loyalty_type_id":1,"item_type_id":0,"value_unit_id":1,"group_id":145071}},{"id":22994127,"status_id":1,"amount":100,"type_id":4,"program_id":19044,"card_id":9234863,"salon_group_id":145071,"item_id":0,"item_type_id":0,"item_record_id":0,"goods_transaction_id":0,"is_discount":false,"is_loyalty_withdraw":false,"type":{"id":4,"title":"Referral program accrual"},"program":{"id":19044,"title":"inviter 2","value":100,"loyalty_type_id":6,"item_type_id":0,"value_unit_id":2,"group_id":145071}}],"id":"paths/~1visit~1loyalty~1transactions~1{visit_id}/get/responses/200/content/application~1json/example"},"paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"code":1},"meta":[]},"id":"paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/200/content/application~1json/example"},"paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/403/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Not enough rights"}},"id":"paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/403/content/application~1json/example"},"paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/404/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Not found"}},"id":"paths/~1loyalty~1generate_code~1{location_id}~1{product_id}/get/responses/404/content/application~1json/example"},"paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example":{"value":{"payment_transactions":[],"loyalty_transactions":[{"id":22985556,"status_id":1,"amount":20,"type_id":1,"program_id":20802,"card_id":9223622,"salon_group_id":145071,"item_id":5048384,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96063258,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion Discount"}}],"kkm_transaction_details_container":{"last_operation_type":1,"transactions":[]},"items":[{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]},"id":"paths/~1visit~1loyalty~1apply_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example"},"paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example":{"value":{"payment_transactions":[],"loyalty_transactions":[],"kkm_transaction_details_container":{"last_operation_type":1,"transactions":[]},"items":[{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]},"id":"paths/~1visit~1loyalty~1cancel_card_withdrawal~1{location_id}~1{card_id}/post/responses/200/content/application~1json/example"},"paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example":{"value":{"payment_transactions":[],"loyalty_transactions":[{"id":22985556,"status_id":1,"amount":20,"type_id":1,"program_id":20802,"card_id":9223622,"salon_group_id":145071,"item_id":5048384,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96063258,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion Discount"}}],"kkm_transaction_details_container":{"last_operation_type":1,"transactions":[]},"items":[{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]},"id":"paths/~1visit~1loyalty~1apply_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example"},"paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example":{"value":{"payment_transactions":[],"loyalty_transactions":[],"kkm_transaction_details_container":{"last_operation_type":1,"transactions":[]},"items":[{"id":96063258,"item_id":5048384,"item_type_id":7,"record_id":0,"item_title":"test two","amount":1,"first_cost":20,"manual_cost":20,"discount":0,"cost":20,"master_id":548096,"good_id":5048384,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true},{"id":0,"item_id":2560779,"item_type_id":1,"record_id":140878948,"item_title":"Deep bikini","amount":1,"first_cost":3000,"manual_cost":3000,"discount":0,"cost":3000,"master_id":140878948,"good_id":0,"service_id":2560779,"event_id":0,"is_service":true,"is_event":false,"is_good":false}]},"id":"paths/~1visit~1loyalty~1cancel_discount_program~1{location_id}~1{card_id}~1{program_id}/post/responses/200/content/application~1json/example"},"paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/responses/200/content/application~1json/example":{"value":{"payment_transactions":[],"loyalty_transactions":[{"id":22989715,"status_id":1,"amount":100,"type_id":1,"program_id":12705,"card_id":0,"salon_group_id":145071,"item_id":5048371,"item_type_id":7,"item_record_id":0,"goods_transaction_id":96082477,"is_discount":true,"is_loyalty_withdraw":false,"type":{"id":1,"title":"Promotion discount"}}],"kkm_transaction_details_container":{"last_operation_type":1,"transactions":[]},"items":[{"id":96082477,"item_id":5048371,"item_type_id":7,"record_id":0,"item_title":"test","amount":1,"first_cost":1000,"manual_cost":1000,"discount":0,"cost":1000,"master_id":548042,"good_id":5048371,"service_id":0,"event_id":0,"is_service":false,"is_event":false,"is_good":true}]},"id":"paths/~1visit~1loyalty~1apply_referral_program~1{location_id}~1{chain_id}/post/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"payroll_daily":[{"date":"2026-03-01","payroll_sum":{"income":0,"expense":0,"balance":240746.48}}],"currency":{"symbol":"$"}},"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1salary~1calculation~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"total_sum":{"income":0,"expense":0,"balance":240746.48},"currency":{"symbol":"$"}},"meta":[]},"id":"paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"staff_id":1112684,"salary_schemes_count":2},"meta":[]},"id":"paths/~1company~1{location_id}~1salary~1calculation~1staff~1{team_member_id}~1salary_schemes_count/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":123,"company_id":456,"staff_id":789,"amount":1000,"status":"confirmed","date_create":"2026-03-03","date_from":"2026-03-01","date_to":"2026-03-02","comment":"Calculation per day"}],"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":123,"company_id":456,"staff_id":789,"amount":1000,"status":"confirmed","date_create":"2026-03-03","date_from":"2026-03-01","date_to":"2026-03-02","comment":"Calculation per day","salary_items":[{"date":"2026-03-01","time":"12:00","item_id":123,"item_type_slug":"record","salary_sum":10,"record_id":123,"client_id":456,"cost":1000,"paid":{"money_sum":900,"discount_sum":30,"bonus_sum":70,"certificate_sum":0,"abonement_sum":0,"deposit_sum":0},"salary_calculation_info":{"criteria_title":"Applied calculation criterium","param_title":"Applied calculation parameter","scheme_title":"Applied calculation scheme"},"targets":[{"target_type_slug":"service","target_id":321,"title":"Cuttings","cost":1000,"net_cost":500,"salary_sum":10,"salary_promotion_sum":1,"salary_calculation":{"type_slug":"percent","value":1.5,"description":"1.5% of cost"}}],"salary_discrepancy":{"reason":"updated_rule","actual_sum":15,"difference_sum":5}}],"currency":{"id":2,"iso":"USD","name":"US Dollar","symbol":"$","is_symbol_after_amount":false}},"meta":[]},"id":"paths/~1company~1{location_id}~1salary~1payroll~1staff~1{team_member_id}~1calculation~1{calculation_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"period_calculation_daily":[{"date":"2026-03-01","period_calculation":{"working_days_count":32,"working_hours_count":353,"group_services_count":3,"services_count":0,"services_sum":0,"goods_sales_count":0,"goods_sales_sum":0,"total_sum":0,"salary":70600}}],"currency":{"symbol":"$"}},"meta":{"count":1}},"id":"paths/~1company~1{location_id}~1salary~1period~1staff~1daily~1{team_member_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"working_days_count":32,"working_hours_count":353,"group_services_count":3,"services_count":0,"services_sum":0,"goods_sales_count":0,"goods_sales_sum":0,"total_sum":0,"salary":70600,"currency":{"symbol":"$"}},"meta":[]},"id":"paths/~1company~1{location_id}~1salary~1period~1staff~1{team_member_id}/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"total_sum":{"income":0,"expense":0,"balance":240746.48},"currency":{"symbol":"$"}},"meta":[]},"id":"paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1calculation/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"working_days_count":32,"working_hours_count":353,"group_services_count":3,"services_count":0,"services_sum":0,"goods_sales_count":0,"goods_sales_sum":0,"total_sum":0,"salary":70600,"currency":{"symbol":"$"}},"meta":[]},"id":"paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1period/get/responses/200/content/application~1json/example"},"paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"staff_id":1112684,"date_start":"2026-09-21T23:00:00.000-05:00","date_end":"2026-09-21T23:00:00.000-05:00","salary_scheme":{"id":28681,"title":"Service 20%"}},{"staff_id":1112684,"date_start":"2026-09-21T23:00:00.000-05:00","salary_scheme":{"id":28680,"title":"Service 30%"}}],"meta":{"count":2}},"id":"paths/~1company~1{location_id}~1salary~1staff~1{team_member_id}~1salary_schemes/get/responses/200/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"salon_id":1,"custom_field":{"id":1,"code":"my_text_field","show_in_ui":true,"title":"test field","user_can_edit":true,"type":{"code":"text","title":"Text"}}}],"meta":[]},"id":"paths/~1custom_fields~1{field_category}~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":1,"salon_id":1,"custom_field":{"id":1,"code":"my_text_field","show_in_ui":true,"title":"test field","user_can_edit":true,"type":{"code":"text","title":"Text"}}},"meta":[]},"id":"paths/~1custom_fields~1{field_category}~1{location_id}/post/responses/200/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/202/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Saved"}},"id":"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/202/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/403/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Not enough access rights"}},"id":"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/403/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/404/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Not found"}},"id":"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/put/responses/404/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/200/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Deleted"}},"id":"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/200/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/403/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Not enough access rights"}},"id":"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/403/content/application~1json/example"},"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/404/content/application~1json/example":{"value":{"success":true,"data":null,"meta":{"message":"Not found"}},"id":"paths/~1custom_fields~1{field_category}~1{location_id}~1{field_id}/delete/responses/404/content/application~1json/example"},"paths/~1groups/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":509,"title":"Chain of locations in New York","companies":[{"id":38726,"title":"Location in New York"},{"id":39287,"title":"Location in New York"}],"access":{"settings_access":"1","clients_access":"1","users_access":"1","loyalty_access":"1","loyalty_cards_manual_transactions_access":"1","chain_services_access":"1"}},{"id":508,"title":"Chain of locations in New York","companies":[{"id":38545,"title":"Location in New York"},{"id":38704,"title":"Location in New York"}],"access":{"settings_access":"1","clients_access":"1","users_access":"1","loyalty_access":"1","loyalty_cards_manual_transactions_access":"1","chain_services_access":"1"}}]},"id":"paths/~1groups/get/responses/200/content/application~1json/example"},"paths/~1group~1{chain_id}~1clients/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"salon_group_id":312,"phone":"+13155550175","clients":[{"id":4240880,"company_id":4564,"name":"lx","email":"client@example.com"},{"id":4243272,"company_id":24697,"name":"lx","email":"client@example.com"}]},"meta":[]},"id":"paths/~1group~1{chain_id}~1clients/get/responses/200/content/application~1json/example"},"paths/~1group~1{chain_id}~1clients/get/responses/404/content/application~1json/example":{"value":{"success":false,"meta":{"message":"Client not found"}},"id":"paths/~1group~1{chain_id}~1clients/get/responses/404/content/application~1json/example"},"paths/~1kkm_transactions~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1059,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":1,"sum":10,"type":{"id":1,"title":"Sales return operation"},"status":{"id":3,"title":"Runtime error"},"document":{"id":2045,"type":7,"type_title":"Visit"},"cashier":{"id":746310,"name":"Jack Smith"}}],"meta":{"count":1}},"id":"paths/~1kkm_transactions~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"kkm_type":0,"kkm_transactions":[{"id":1954,"print_date":"2026-09-21T23:00:00.000-05:00","printed_count":0,"sum":0,"type":{"id":0,"title":"Sale operation"},"status":{"id":2,"title":"Sent for printing"},"document":{"id":164,"type":9,"type_title":"Deposit replenishment"},"cashier":{"id":1138453,"name":"Jack Smith"}}],"status":2,"bill_json":[[]]},"meta":[]},"id":"paths/~1kkm_transactions~1{location_id}~1print_document_bill/post/responses/200/content/application~1json/example"},"paths/~1integration~1kkm~1references~1tax_system~1{country_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"title":"General DOS","slug":"ru_osn","vats":[{"title":"0%","slug":"ru_vat_0"},{"title":"10%","slug":"ru_vat_10"},{"title":"20%","slug":"ru_vat_20"},{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Simplified simplified tax system (Income)","slug":"ru_usn","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Simplified simplified tax system (Income minus Expense)","slug":"ru_usnr","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Single tax on imputed income UTII","slug":"ru_envd","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Unified agricultural tax UST","slug":"ru_esn","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]},{"title":"Patent taxation system","slug":"ru_psn","vats":[{"title":"is not a subject to a tax","slug":"ru_vat_none"}]}],"meta":{"count":6}},"id":"paths/~1integration~1kkm~1references~1tax_system~1{country_id}/get/responses/200/content/application~1json/example"},"paths/~1https:~1~1your-api.url/post/responses/200/content/application~1json/example":{"value":{"id":"d72fece5-6825-4895-9395-0133195612a4","status":"success","code":0,"message":"OK"},"id":"paths/~1https:~1~1your-api.url/post/responses/200/content/application~1json/example"},"paths/~1license~1{location_id}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"id":1,"salon_id":4523464,"staff_limit":5,"deactivation_date":"08.11.2019","start_date":"07.05.2025","name":"Start","active":1,"is_paid_rights_model":false,"options":[{"id":3,"title":"Online payment"}]},"meta":[]},"id":"paths/~1license~1{location_id}/get/responses/200/content/application~1json/example"},"paths/~1validation~1validate_phone~1{phone}/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"is_valid":true},"meta":[]},"id":"paths/~1validation~1validate_phone~1{phone}/get/responses/200/content/application~1json/example"},"paths/~1images~1{entity}/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":{"image_binded":false,"image_group ":{"id":72256,"entity":"","entity_id":0,"images":{"basic":{"id":186826,"path":"https://app.alteg.io/uploads/setting_service_image/c/cf/cf01a5585348731_20170328195919.jpeg","width":"373","height":"280","type":"jpeg","image_group_id":72256,"version":"basic"}}}},"meta":[]},"id":"paths/~1images~1{entity}/post/responses/200/content/application~1json/example"},"paths/~1tips~1{location_id}~1settings/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":3120,"location_id":4564,"staff_id":1071804,"hash":"1a27116c-726d-4cec-a7dd-7bd6d669a8c1","status":1,"status_title":"new settings","is_enabled":false,"landing_external":"https://app.alteg.io/tips/external/4564/1a27116c-726d-4cec-a7dd-7bd6d669a8c1/","staff":{"id":1071804,"name":"Testimonials Location Business Example","specialization":"Reviews"}},{"id":1,"location_id":4564,"staff_id":37695,"hash":"abf52f53-e94c-41e8-9f76-93485fd76e5e","status":1,"status_title":"new settings","is_enabled":false,"landing_external":"https://app.alteg.io/tips/external/4564/abf52f53-e94c-41e8-9f76-93485fd76e5e/","staff":{"id":37695,"name":"Kim Kardashian","specialization":"Cosmetologist-makeup artist","user":{"id":746310,"name":"James Smith","email":"j.smith@example.com","phone":"+13155550175"},"position":{"id":452,"title":"Masseur"}}}]},"id":"paths/~1tips~1{location_id}~1settings/get/responses/200/content/application~1json/example"},"paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"location_id":253859,"staff_id":742418,"hash":"ba816199-eecf-4bd2-9f1d-db470545bfaf","status":3,"status_title":"pending account","is_enabled":true,"landing_external":"https://app.alteg.io/tips/external/253859/ba816199-eecf-4bd2-9f1d-db470545bfaf/","master_tips_form_link":"https://app.alteg.io/companies/253859/staff/742418/tips/pay/","invite_sms_sent":false,"staff":{"id":742418,"name":"Fusa","specialization":"team member","avatar":"https://assets.alteg.io/masters/sm/c/c7/c77a4bf2b6b3896_20210304004333.png","employee":{"id":733043,"phone":"+13155550175"},"user":{"id":1553930,"name":"James Smith","email":"j.smith@example.com","phone":"+13155550186"},"position":{"id":103883,"title":"Yogist"}}},{"id":152763,"location_id":253859,"staff_id":743018,"hash":"b7c81cab-290a-4b0a-ad05-9c4b98ef3565","status":4,"status_title":"everything is set","is_enabled":true,"landing_external":"https://app.alteg.io/tips/external/253859/b7c81cab-290a-4b0a-ad05-9c4b98ef3565/","master_tips_form_link":"https://app.alteg.io/companies/253859/staff/743018/tips/pay/","invite_sms_sent":false,"staff":{"id":743018,"name":"Natasha M","specialization":"manicurist","avatar":"https://api.alteg.io/images/no-master-sm.png","employee":{"id":733547,"phone":"+13155550175"},"user":{"id":6259059,"name":"Alice Smith","email":"a.smith@example.com","phone":"+13155550175"},"position":{"id":103731,"title":"Manicurist"}}}],"meta":{"count":2}},"id":"paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1disable/post/responses/200/content/application~1json/example"},"paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get/responses/200/content/application~1json/example":{"value":{"success":true,"data":[{"id":1,"location_id":253859,"staff_id":742418,"hash":"ba816199-eecf-4bd2-9f1d-db470545bfaf","status":3,"status_title":"pending account","is_enabled":true,"landing_external":"https://app.alteg.io/tips/external/253859/ba816199-eecf-4bd2-9f1d-db470545bfaf/","master_tips_form_link":"https://app.alteg.io/companies/253859/staff/742418/tips/pay/","invite_sms_sent":false,"staff":{"id":742418,"name":"Fusa","specialization":"team member","avatar":"https://assets.alteg.io/masters/sm/c/c7/c77a4bf2b6b3896_20210304004333.png","employee":{"id":733043,"phone":"+13155550175"},"user":{"id":1553930,"name":"James Smith","email":"j.smith@example.com","phone":"+13155550175"},"position":{"id":103883,"title":"Yogist"}}},{"id":152763,"location_id":253859,"staff_id":743018,"hash":"b7c81cab-290a-4b0a-ad05-9c4b98ef3565","status":4,"status_title":"everything is set","is_enabled":true,"landing_external":"https://app.alteg.io/tips/external/253859/b7c81cab-290a-4b0a-ad05-9c4b98ef3565/","master_tips_form_link":"https://app.alteg.io/companies/253859/staff/743018/tips/pay/","invite_sms_sent":false,"staff":{"id":743018,"name":"Natasha M","specialization":"manicurist","avatar":"https://api.alteg.io/images/no-master-sm.png","employee":{"id":733547,"phone":"+13155550175"},"user":{"id":6259059,"name":"Alice Smith","email":"a.smith@example.com","phone":"+13155550175"},"position":{"id":103731,"title":"Manicurist"}}}],"meta":{"count":2}},"id":"paths/~1tips~1{location_id}~1settings~1{master_tips_settings_id}~1enable/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"bearer":{"id":"bearer","type":"apiKey","in":"header","paramName":"Authorization"},"user":{"id":"user","type":"apiKey","in":"header","paramName":"Authorization"},"BearerPartner":{"id":"BearerPartner","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}"},"BearerPartnerUser":{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}},"servers":[{"url":"/_mock/en/b2b-v1/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.alteg.io/api/v1","description":"Production"}]},"options":{"sortRequiredPropsFirst":true,"hideSidebar":true,"mockServer":{"url":"/_mock/en/b2b-v1/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/en/b2b-v1/openapi.json?download"},{"url":"/_bundle/en/b2b-v1/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Business Management","description":"## Start here: get your credentials\n\nBusiness Management requests use a **Partner Token** and, when business data\nis involved, a **User Token**:\n\n1. Open the [Altegio Marketplace](https://app.alteg.io/appstore/developers/1)\n   and click **Developer account**. Complete the developer registration. Your\n   Partner Token then appears automatically under **Account settings → Account\n   details**.\n2. Choose how you will obtain the User Token:\n   - **Application system user:** create an application in Developer Account.\n     Under **API Access**, enter the system user's **User ID**, save it, copy the\n     generated **User Token**, and configure the application's credentials,\n     access rights, and connection settings. Then [install and activate the\n     application on a test Location](../developers/marketplace-quickstart.md).\n     The token can access that Location only after the installation is active.\n   - **Your own Business User:** call the [user authorization\n     endpoint](#tag/Authentication-B2B/operation/auth) with your Altegio login and\n     password. Use `data.user_token` from the response. No application installation\n     is needed, but that Business User must already have access to the Location.\n3. Send both values in the same header:\n\n   `Authorization: Bearer <partner_token>, User <user_token>`\n\nAn application's system user and your own Business User can have different\nLocations and permissions. A request that works with one token may therefore\nreturn `403` with the other. See [How to Get API Keys](../get-api-key.md) for the\ncomplete beginner walkthrough.\n\nFull-featured B2B API for business operations.\n\n**Base URL:** `https://api.alteg.io/api`\n\n## ⚠️ Version Status\n\n**V1 will be gradually deprecated.** We recommend using [V2 API](../b2b-v2/openapi.yaml) for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only.\n\n## V1 and V2 parameter aliases\n\nV1 accepts the canonical V2 terminology for query-string and request-body parameters while continuing to support legacy V1 names. This makes it possible to share request-building code between API versions. Common alias families include:\n\n- `location_id`, `company_id`, and `salon_id`\n- `chain_id`, `company_group_id`, and `salon_group_id`\n- `team_member_id`, `staff_id`, and `master_id`\n- `appointment_id` and `record_id`\n- `product_id` and `good_id`\n\nSingular, plural, and camelCase variants are supported where applicable. Send only one name from each alias family. If multiple aliases are supplied, explicitly supplied values are preserved and are not overwritten.\n"}},"baseSlug":"/en/b2b-v1/openapi","routesMapping":{}}