{"items":[{"type":"link","label":"Business Management","link":"/en/b2b-v2/openapi","routeSlug":"/en/b2b-v2/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-v2/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/en/b2b-v2/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-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Business Management (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/en/b2b-v2/openapi"}],"sectionId":"/en/b2b-v2/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":"/en/b2b-v1/openapi#tag/Authentication-B2B/operation/auth"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"v1 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"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your Altegio login and 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."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No application installation is needed, but that Business User must already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"Next-generation B2B API with improved design and consistency."},"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/v2"},"children":[]}]}]}]}],"sectionId":"/en/b2b-v2/openapi/section/start-here:-get-your-credentials"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/status"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API is in active development. New features and improvements are released here first."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend using this API for all new integrations."},"children":[]}]}]}]}],"sectionId":"/en/b2b-v2/openapi/section/status"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/required-media-type"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required Media Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every request must include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/vnd.api.v2+json\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/vnd.api.v2+json\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests without the v2 media type return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A charset parameter is accepted."},"children":[]}]}]}]}],"sectionId":"/en/b2b-v2/openapi/section/required-media-type"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/url-patterns"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL Patterns"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location-scoped resources use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/locations/{location_id}/..."},"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":"Positions and Tags preserve the literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter name for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SDK compatibility, but its value is the Location identifier. The legacy"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/companies/{company_id}/positions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/companies/{company_id}/tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" paths"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"remain accepted as compatibility aliases."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy path segments are accepted as compatibility aliases of the canonical ones:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team_members"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointments"},"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":"activities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_categories"},"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":"attendance_good_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attendance_product_items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"salon_groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chains"},"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":"A request through a legacy segment reaches the same handler and additionally returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Deprecation: @1782864000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (2026-07-01T00:00:00Z), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sunset: Mon, 01 Mar 2027 00:00:00 GMT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link: <https://developer.alteg.io/en/b2b-v3/openapi>; rel=\"deprecation\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc9745"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 9745"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8594"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 8594"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Canonical URLs do not return these headers."},"children":[]}]}]}]}],"sectionId":"/en/b2b-v2/openapi/section/url-patterns"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/parameter-aliases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter aliases"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use canonical names such as "},"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":"chain_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"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":"softbreak","inline":true,"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":"product_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for top-level query-string and request-body"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"parameters. V2 accepts the corresponding legacy names in both directions for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"compatibility, but canonical names are recommended for new integrations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alias expansion is not recursive: nested request fields must use the literal names shown"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by each endpoint. Responses are not transformed and retain their literal wire fields and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON:API resource type values; response schemas and examples show those exact names."},"children":[]}]}]}]}],"sectionId":"/en/b2b-v2/openapi/section/parameter-aliases"}]}]}},{"type":"link","label":"Start here: get your credentials","link":"/en/b2b-v2/openapi/section/start-here:-get-your-credentials","routeSlug":"/en/b2b-v2/openapi/section/start-here:-get-your-credentials","content":null},{"type":"link","label":"Status","link":"/en/b2b-v2/openapi/section/status","routeSlug":"/en/b2b-v2/openapi/section/status","content":null},{"type":"link","label":"Required Media Type","link":"/en/b2b-v2/openapi/section/required-media-type","routeSlug":"/en/b2b-v2/openapi/section/required-media-type","content":null},{"type":"link","label":"URL Patterns","link":"/en/b2b-v2/openapi/section/url-patterns","routeSlug":"/en/b2b-v2/openapi/section/url-patterns","content":null},{"type":"link","label":"Parameter aliases","link":"/en/b2b-v2/openapi/section/parameter-aliases","routeSlug":"/en/b2b-v2/openapi/section/parameter-aliases","content":null},{"type":"separator","label":"POS & Scheduling","content":null},{"type":"group","label":"Services","link":"/en/b2b-v2/openapi/services","routeSlug":"/en/b2b-v2/openapi/services","items":[{"label":"List Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/services/list_services","routeSlug":"/en/b2b-v2/openapi/services/list_services","metadata":{"seo":{"title":"List Services","description":"Retrieve Services for a Location, optionally filtered by Service IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_services","name":"List Services","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Services","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":"Retrieve Services for a Location, optionally filtered by Service IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response uses JSON:API resource objects. Pagination uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"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":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; pagination metadata is not returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related data can be requested by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, for"},"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=resources&include=company_links"},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1services/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[service_ids][]","in":"query","schemaId":"schema_446","description":"Filter by Service IDs"},{"name":"page","in":"query","schemaId":"schema_447","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_448","description":"Maximum number of Services to return"},{"name":"include","in":"query","schemaId":"schema_449","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related resources to include. The wire values are literal API keys:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains Location-specific Service links."},"children":[]}]}]}]}],"pointer":"/paths/~1locations~1{location_id}~1services/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/services","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[service_ids][]","in":"query","required":false,"schemaId":"schema_446"},{"name":"page","in":"query","required":false,"schemaId":"schema_447"},{"name":"limit","in":"query","required":false,"schemaId":"schema_448"},{"name":"include","in":"query","required":false,"schemaId":"schema_449","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/services","href":"services/list_services","openApiOperationId":"list_services","summary":"List Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Services retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452","exampleIds":["paths/~1locations~1{location_id}~1services/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_452","exampleIds":["paths/~1locations~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/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Services for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1services/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_452","exampleIds":["paths/~1locations~1{location_id}~1services/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452","exampleIds":["paths/~1locations~1{location_id}~1services/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/list_services"}],"panels":[]}]},"httpPath":"/locations/{location_id}/services"},{"label":"Get Service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/services/get_service","routeSlug":"/en/b2b-v2/openapi/services/get_service","metadata":{"seo":{"title":"Get Service","description":"Retrieve a Service for a Location as a JSON:API resource object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_service","name":"Get Service","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1services~1{service_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get 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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a Service for a Location as a JSON:API resource object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related data can be requested by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, for"},"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=resources&include=company_links"},"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_445","description":"Location ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_445","description":"Service ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1services~1{service_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_449","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related resources to include. The wire values are literal API keys:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains Location-specific Service links."},"children":[]}]}]}]}],"pointer":"/paths/~1locations~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_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1services~1{service_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/services/{service_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_449","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/services/{service_id}","href":"services/get_service","openApiOperationId":"get_service","summary":"Get Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Service retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453","exampleIds":["paths/~1locations~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_453","exampleIds":["paths/~1locations~1{location_id}~1services~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/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read this Service","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Service or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1services~1{service_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_453","exampleIds":["paths/~1locations~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453","exampleIds":["paths/~1locations~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/get_service"}],"panels":[]}]},"httpPath":"/locations/{location_id}/services/{service_id}"},{"label":"List Service Categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/services/list_service_categories","routeSlug":"/en/b2b-v2/openapi/services/list_service_categories","metadata":{"seo":{"title":"List Service Categories","description":"Retrieve Service Categories for a Location as JSON:API resource objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_service_categories","name":"List Service Categories","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1service_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List 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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve Service Categories for a Location as JSON:API resource objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"filter[staff_id]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return categories containing Services assigned to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1service_categories/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[staff_id]","in":"query","schemaId":"schema_454","description":"Filter by Team Member ID"}],"pointer":"/paths/~1locations~1{location_id}~1service_categories/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1service_categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/service_categories","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[staff_id]","in":"query","required":false,"schemaId":"schema_454"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/service_categories","href":"services/list_service_categories","openApiOperationId":"list_service_categories","summary":"List Service Categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Service Categories retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_455","exampleIds":["paths/~1locations~1{location_id}~1service_categories/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_455","exampleIds":["paths/~1locations~1{location_id}~1service_categories/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Service Categories for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1service_categories/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_455","exampleIds":["paths/~1locations~1{location_id}~1service_categories/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_455","exampleIds":["paths/~1locations~1{location_id}~1service_categories/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/list_service_categories"}],"panels":[]}]},"httpPath":"/locations/{location_id}/service_categories"},{"label":"List Attendance Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/services/list_attendance_services","routeSlug":"/en/b2b-v2/openapi/services/list_attendance_services","metadata":{"seo":{"title":"List Attendance Services","description":"Retrieve Service delivery options for the Location timetable. Each result combines a Service with its applicable Team Member, duration, price, and composite Service context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_attendance_services","name":"List Attendance Services","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1attendance_services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Attendance Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve Service delivery options for the Location timetable. Each result\ncombines a Service with its applicable Team Member, duration, price, and\ncomposite Service context.\n\nThe response is paginated and includes pagination metadata.\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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1attendance_services/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"team_member_id","in":"query","schemaId":"schema_454","description":"Filter by Team Member ID"},{"name":"filter[category_id]","in":"query","schemaId":"schema_454","description":"Filter by Service Category ID"},{"name":"filter[service_ids][]","in":"query","schemaId":"schema_446","description":"Filter by Service IDs"},{"name":"filter[term]","in":"query","schemaId":"schema_456","description":"Search Service names; surrounding whitespace is ignored"},{"name":"filter[is_available_for_timetable]","in":"query","schemaId":"schema_457","description":"Filter by timetable availability"},{"name":"filter[is_multi]","in":"query","schemaId":"schema_457","description":"Filter by multi-Service availability"},{"name":"filter[is_composite]","in":"query","schemaId":"schema_457","description":"Filter by composite Service status"},{"name":"page","in":"query","schemaId":"schema_447","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_448","description":"Maximum number of Attendance Services to return"}],"pointer":"/paths/~1locations~1{location_id}~1attendance_services/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1attendance_services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/attendance_services","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"team_member_id","in":"query","required":false,"schemaId":"schema_454"},{"name":"filter[category_id]","in":"query","required":false,"schemaId":"schema_454"},{"name":"filter[service_ids][]","in":"query","required":false,"schemaId":"schema_446"},{"name":"filter[term]","in":"query","required":false,"schemaId":"schema_456"},{"name":"filter[is_available_for_timetable]","in":"query","required":false,"schemaId":"schema_457"},{"name":"filter[is_multi]","in":"query","required":false,"schemaId":"schema_457"},{"name":"filter[is_composite]","in":"query","required":false,"schemaId":"schema_457"},{"name":"page","in":"query","required":false,"schemaId":"schema_447"},{"name":"limit","in":"query","required":false,"schemaId":"schema_448"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/attendance_services","href":"services/list_attendance_services","openApiOperationId":"list_attendance_services","summary":"List Attendance Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Attendance Services retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458","exampleIds":["paths/~1locations~1{location_id}~1attendance_services/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_458","exampleIds":["paths/~1locations~1{location_id}~1attendance_services/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No access to this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid filter or pagination value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1attendance_services/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_458","exampleIds":["paths/~1locations~1{location_id}~1attendance_services/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458","exampleIds":["paths/~1locations~1{location_id}~1attendance_services/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/list_attendance_services"}],"panels":[]}]},"httpPath":"/locations/{location_id}/attendance_services"},{"label":"List Composite Service Attendance Services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/services/list_composite_service_attendance_services","routeSlug":"/en/b2b-v2/openapi/services/list_composite_service_attendance_services","metadata":{"seo":{"title":"List Composite Service Attendance Services","description":"Retrieve the Service delivery options that make up a composite Service in a Location, including Team Member, duration, price, and position data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_composite_service_attendance_services","name":"List Composite Service Attendance Services","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Composite Service Attendance Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the Service delivery options that make up a composite Service in\na Location, including Team Member, duration, price, and position data.\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_445","description":"Location ID","required":true},{"name":"service_id","in":"path","schemaId":"schema_454","description":"Composite Service ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/composite_services/{service_id}/attendance_services","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"service_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/composite_services/{service_id}/attendance_services","href":"services/list_composite_service_attendance_services","openApiOperationId":"list_composite_service_attendance_services","summary":"List Composite Service Attendance Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Composite Service Attendance Services retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459","exampleIds":["paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_459","exampleIds":["paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No access to this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Composite Service or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid path parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_459","exampleIds":["paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459","exampleIds":["paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/list_composite_service_attendance_services"}],"panels":[]}]},"httpPath":"/locations/{location_id}/composite_services/{service_id}/attendance_services"},{"label":"List Attendance Service Suggestions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/services/list_attendance_service_suggestions","routeSlug":"/en/b2b-v2/openapi/services/list_attendance_service_suggestions","metadata":{"seo":{"title":"List Attendance Service Suggestions","description":"Retrieve Service suggestions for a Team Member. Supplying a Booking UserID adds suggestions based on that Booking User's prior Appointments andpopular Services."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_attendance_service_suggestions","name":"List Attendance Service Suggestions","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1attendance_service_suggestions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Attendance Service Suggestions","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":"Retrieve Service suggestions for a Team Member. Supplying a Booking User"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID adds suggestions based on that Booking User's prior Appointments and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"popular Services."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"include=attendance_service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"suggested Service delivery option or source Appointment. The literal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include value is retained by the wire contract."},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1attendance_service_suggestions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"team_member_id","in":"query","schemaId":"schema_454","description":"Team Member ID","required":true},{"name":"client_id","in":"query","schemaId":"schema_454","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User profile ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire name"},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_460","description":"Related Attendance Service or source Appointment to include"}],"pointer":"/paths/~1locations~1{location_id}~1attendance_service_suggestions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1attendance_service_suggestions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/attendance_service_suggestions","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"team_member_id","in":"query","required":true,"schemaId":"schema_454"},{"name":"client_id","in":"query","required":false,"schemaId":"schema_454"},{"name":"include","in":"query","required":false,"schemaId":"schema_460","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/attendance_service_suggestions","href":"services/list_attendance_service_suggestions","openApiOperationId":"list_attendance_service_suggestions","summary":"List Attendance Service Suggestions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Attendance Service suggestions retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461","exampleIds":["paths/~1locations~1{location_id}~1attendance_service_suggestions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_461","exampleIds":["paths/~1locations~1{location_id}~1attendance_service_suggestions/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No access to the Location or Booking User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location, Team Member, or Booking User not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid query parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1attendance_service_suggestions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_461","exampleIds":["paths/~1locations~1{location_id}~1attendance_service_suggestions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_461","exampleIds":["paths/~1locations~1{location_id}~1attendance_service_suggestions/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/services/list_attendance_service_suggestions"}],"panels":[]}]},"httpPath":"/locations/{location_id}/attendance_service_suggestions"}],"content":{"contentType":"group","meta":{"name":"Services"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Services","showPageActions":true},{"nodeType":"markdoc","content":"Service catalog management.\n\nRetrieve services and service categories for a location."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{location_id}/services","summary":"List Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/list_services","deprecated":false},{"title":"/locations/{location_id}/services/{service_id}","summary":"Get Service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/get_service","deprecated":false},{"title":"/locations/{location_id}/service_categories","summary":"List Service Categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/list_service_categories","deprecated":false},{"title":"/locations/{location_id}/attendance_services","summary":"List Attendance Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/list_attendance_services","deprecated":false},{"title":"/locations/{location_id}/composite_services/{service_id}/attendance_services","summary":"List Composite Service Attendance Services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/list_composite_service_attendance_services","deprecated":false},{"title":"/locations/{location_id}/attendance_service_suggestions","summary":"List Attendance Service Suggestions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/services/list_attendance_service_suggestions","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/en/b2b-v2/openapi/products","routeSlug":"/en/b2b-v2/openapi/products","items":[{"label":"List Product Units","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/list_product_units","routeSlug":"/en/b2b-v2/openapi/products/list_product_units","metadata":{"seo":{"title":"List Product Units","description":"Retrieve the measurement Units available to Products in a Location asJSON:API resource objects. The collection contains shared system Units andany Units configured specifically for the Location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_product_units","name":"List Product Units","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1units/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Product Units","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":"Retrieve the measurement Units available to Products in a Location as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON:API resource objects. The collection contains shared system Units and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any Units configured specifically for the Location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Unit IDs as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale_unit_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"consumable_unit_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Product data."},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1units/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1units/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/units","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/units","href":"products/list_product_units","openApiOperationId":"list_product_units","summary":"List Product Units"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Product Units retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_462","exampleIds":["paths/~1locations~1{location_id}~1units/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_462","exampleIds":["paths/~1locations~1{location_id}~1units/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Product Units for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1units/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_462","exampleIds":["paths/~1locations~1{location_id}~1units/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_462","exampleIds":["paths/~1locations~1{location_id}~1units/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/list_product_units"}],"panels":[]}]},"httpPath":"/locations/{location_id}/units"},{"label":"List Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/list_products","routeSlug":"/en/b2b-v2/openapi/products/list_products","metadata":{"seo":{"title":"List Products","description":"Retrieve Products for a Location as JSON:API resource objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_products","name":"List Products","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1products/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List 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":"Retrieve Products for a Location as JSON:API resource objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination uses "},"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":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response includes the effective"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", calculated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.pagination"},"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":"Related data can be requested by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual_cost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is returned only when requested and when the Business"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User has permission to view it."},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1products/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[ids][]","in":"query","schemaId":"schema_463","description":"Filter by Product IDs"},{"name":"filter[related_loyalty_entity_slug]","in":"query","schemaId":"schema_464","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by Product purpose. Wire values are literal API values:"},"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":" - regular Products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loyalty_abonement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - membership Products"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loyalty_certificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - certificate Products"},"children":[]}]}]}]}]},{"name":"page","in":"query","schemaId":"schema_447","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_448","description":"Maximum number of Products to return"},{"name":"include","in":"query","schemaId":"schema_465","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related resources or conditional attributes to include. Wire values are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"literal API keys. Use the Product detail operation for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage_amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1locations~1{location_id}~1products/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1products/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/products","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[ids][]","in":"query","required":false,"schemaId":"schema_463"},{"name":"filter[related_loyalty_entity_slug]","in":"query","required":false,"schemaId":"schema_464"},{"name":"page","in":"query","required":false,"schemaId":"schema_447"},{"name":"limit","in":"query","required":false,"schemaId":"schema_448"},{"name":"include","in":"query","required":false,"schemaId":"schema_465","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/products","href":"products/list_products","openApiOperationId":"list_products","summary":"List Products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Products retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466","exampleIds":["paths/~1locations~1{location_id}~1products/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_466","exampleIds":["paths/~1locations~1{location_id}~1products/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Products for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid filter, pagination, or include value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1products/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_466","exampleIds":["paths/~1locations~1{location_id}~1products/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466","exampleIds":["paths/~1locations~1{location_id}~1products/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/list_products"}],"panels":[]}]},"httpPath":"/locations/{location_id}/products"},{"label":"Autocomplete Products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/autocomplete_products","routeSlug":"/en/b2b-v2/openapi/products/autocomplete_products","metadata":{"seo":{"title":"Autocomplete Products","description":"Search Products by name, article number, or barcode."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"autocomplete_products","name":"Autocomplete Products","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1products~1autocomplete/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Autocomplete 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":"Search Products by name, article number, or barcode."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search term must contain at least two characters and cannot contain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"emoji. Pagination uses "},"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":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is returned in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.pagination"},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1products~1autocomplete/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[term]","in":"query","schemaId":"schema_467","description":"Product name, article number, or barcode search term","required":true},{"name":"page","in":"query","schemaId":"schema_447","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_448","description":"Maximum number of Products to return"},{"name":"include","in":"query","schemaId":"schema_468","description":"Related resources to include; wire values are literal API keys"}],"pointer":"/paths/~1locations~1{location_id}~1products~1autocomplete/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1products~1autocomplete/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/products/autocomplete","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[term]","in":"query","required":true,"schemaId":"schema_467"},{"name":"page","in":"query","required":false,"schemaId":"schema_447"},{"name":"limit","in":"query","required":false,"schemaId":"schema_448"},{"name":"include","in":"query","required":false,"schemaId":"schema_468","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422"],"pointer":"/locations/{location_id}/products/autocomplete","href":"products/autocomplete_products","openApiOperationId":"autocomplete_products","summary":"Autocomplete Products"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Products retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}},"schemaId":"schema_466"},{"code":"400","description":"Search term contains emoji","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to search Products for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid search term, pagination, or include value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1products~1autocomplete/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_466","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}}},{"code":"400","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/autocomplete_products"}],"panels":[]}]},"httpPath":"/locations/{location_id}/products/autocomplete"},{"label":"Get Product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/get_product","routeSlug":"/en/b2b-v2/openapi/products/get_product","metadata":{"seo":{"title":"Get Product","description":"Retrieve a Product for a Location as a JSON:API resource object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_product","name":"Get Product","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Product","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":"Retrieve a Product for a Location as a JSON:API resource object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related data can be requested by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual_cost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is returned only when requested and when the Business"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User has permission to view it."},"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_445","description":"Location ID","required":true},{"name":"product_id","in":"path","schemaId":"schema_445","description":"Product ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_469","description":"Related resources or conditional attributes to include"}],"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1products~1{product_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/products/{product_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_469","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/products/{product_id}","href":"products/get_product","openApiOperationId":"get_product","summary":"Get Product"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Product retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470","exampleIds":["paths/~1locations~1{location_id}~1products~1{product_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_470","exampleIds":["paths/~1locations~1{location_id}~1products~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/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read this Product","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Product or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_470","exampleIds":["paths/~1locations~1{location_id}~1products~1{product_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470","exampleIds":["paths/~1locations~1{location_id}~1products~1{product_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/get_product"}],"panels":[]}]},"httpPath":"/locations/{location_id}/products/{product_id}"},{"label":"List Product Storage Amounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/list_product_storage_amounts","routeSlug":"/en/b2b-v2/openapi/products/list_product_storage_amounts","metadata":{"seo":{"title":"List Product Storage Amounts","description":"Retrieve Product amounts across the Location's Storages as JSON:API resource objects. Amounts are returned in both Sale Units and Consumable Units."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_product_storage_amounts","name":"List Product Storage Amounts","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Product Storage Amounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve Product amounts across the Location's Storages as JSON:API\nresource objects. Amounts are returned in both Sale Units and Consumable\nUnits.\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_445","description":"Location ID","required":true},{"name":"product_id","in":"path","schemaId":"schema_445","description":"Product ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_471","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include Storage details; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire value"},"children":[]}]}]}]}],"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/products/{product_id}/storage_amounts","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_471","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/products/{product_id}/storage_amounts","href":"products/list_product_storage_amounts","openApiOperationId":"list_product_storage_amounts","summary":"List Product Storage Amounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Product Storage amounts retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472","exampleIds":["paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_472","exampleIds":["paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Product amounts for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Product or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_472","exampleIds":["paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472","exampleIds":["paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/list_product_storage_amounts"}],"panels":[]}]},"httpPath":"/locations/{location_id}/products/{product_id}/storage_amounts"},{"label":"List Product Categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/list_product_categories","routeSlug":"/en/b2b-v2/openapi/products/list_product_categories","metadata":{"seo":{"title":"List Product Categories","description":"Retrieve Product Categories for a Location as JSON:API resource objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_product_categories","name":"List Product Categories","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1product_categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Product 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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve Product Categories for a Location as JSON:API resource objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[parent_category_id]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return root Product"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categories. Set it to a Product Category ID to return direct children."},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1product_categories/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[parent_category_id]","in":"query","schemaId":"schema_473","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parent Product Category ID; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for root categories"},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_474","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related resources to include. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"child_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"literal wire values for Product Categories and Products."},"children":[]}]}]}]}],"pointer":"/paths/~1locations~1{location_id}~1product_categories/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1product_categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/product_categories","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[parent_category_id]","in":"query","required":false,"schemaId":"schema_473"},{"name":"include","in":"query","required":false,"schemaId":"schema_474","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/product_categories","href":"products/list_product_categories","openApiOperationId":"list_product_categories","summary":"List Product Categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Product Categories retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475","exampleIds":["paths/~1locations~1{location_id}~1product_categories/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_475","exampleIds":["paths/~1locations~1{location_id}~1product_categories/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Product Categories for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid parent Product Category filter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1product_categories/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_475","exampleIds":["paths/~1locations~1{location_id}~1product_categories/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475","exampleIds":["paths/~1locations~1{location_id}~1product_categories/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/list_product_categories"}],"panels":[]}]},"httpPath":"/locations/{location_id}/product_categories"},{"label":"Get Product Category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/get_product_category","routeSlug":"/en/b2b-v2/openapi/products/get_product_category","metadata":{"seo":{"title":"Get Product Category","description":"Retrieve a Product Category for a Location as a JSON:API resource object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_product_category","name":"Get Product Category","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Product Category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a Product Category for a Location as a JSON:API resource 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_445","description":"Location ID","required":true},{"name":"product_category_id","in":"path","schemaId":"schema_445","description":"Product Category ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_474","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related resources to include. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"child_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"literal wire values for Product Categories and Products."},"children":[]}]}]}]}],"pointer":"/paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/product_categories/{product_category_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"product_category_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_474","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/product_categories/{product_category_id}","href":"products/get_product_category","openApiOperationId":"get_product_category","summary":"Get Product Category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Product Category retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_476","exampleIds":["paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_476","exampleIds":["paths/~1locations~1{location_id}~1product_categories~1{product_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/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read this Product Category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Product Category or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_476","exampleIds":["paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_476","exampleIds":["paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/get_product_category"}],"panels":[]}]},"httpPath":"/locations/{location_id}/product_categories/{product_category_id}"},{"label":"Get Appointment Product Item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/products/get_attendance_product_item","routeSlug":"/en/b2b-v2/openapi/products/get_attendance_product_item","metadata":{"seo":{"title":"Get Appointment Product Item","description":"Retrieve a Product item associated with an Appointment as a JSON:API resource object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_attendance_product_item","name":"Get Appointment Product Item","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1attendance_product_items~1{attendance_product_item_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Appointment Product Item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a Product item associated with an Appointment as a JSON:API\nresource object.\n\nThe positive response shape is verified against the current PHP transformer\nbut has not been live-verified because the test Location has no safe fixture.\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_445","description":"Location ID","required":true},{"name":"attendance_product_item_id","in":"path","schemaId":"schema_445","description":"Appointment Product Item ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1attendance_product_items~1{attendance_product_item_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_477","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related resources to include. Wire values are literal API keys;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the Team Member and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents the Product."},"children":[]}]}]}]}],"pointer":"/paths/~1locations~1{location_id}~1attendance_product_items~1{attendance_product_item_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1attendance_product_items~1{attendance_product_item_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/attendance_product_items/{attendance_product_item_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"attendance_product_item_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"schema_477","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/attendance_product_items/{attendance_product_item_id}","href":"products/get_attendance_product_item","openApiOperationId":"get_attendance_product_item","summary":"Get Appointment Product Item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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 Product Item retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read this Appointment Product Item","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Appointment Product Item or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1attendance_product_items~1{attendance_product_item_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/get_attendance_product_item"}],"panels":[]}]},"httpPath":"/locations/{location_id}/attendance_product_items/{attendance_product_item_id}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Product inventory management.\n\nRetrieve Products, Product Categories, measurement Units, stock levels,\nand Appointment Product Items."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{location_id}/units","summary":"List Product Units","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/list_product_units","deprecated":false},{"title":"/locations/{location_id}/products","summary":"List Products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/list_products","deprecated":false},{"title":"/locations/{location_id}/products/autocomplete","summary":"Autocomplete Products","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/autocomplete_products","deprecated":false},{"title":"/locations/{location_id}/products/{product_id}","summary":"Get Product","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_product","deprecated":false},{"title":"/locations/{location_id}/products/{product_id}/storage_amounts","summary":"List Product Storage Amounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/list_product_storage_amounts","deprecated":false},{"title":"/locations/{location_id}/product_categories","summary":"List Product Categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/list_product_categories","deprecated":false},{"title":"/locations/{location_id}/product_categories/{product_category_id}","summary":"Get Product Category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_product_category","deprecated":false},{"title":"/locations/{location_id}/attendance_product_items/{attendance_product_item_id}","summary":"Get Appointment Product Item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/get_attendance_product_item","deprecated":false}]}]}]}]}},{"type":"group","label":"Team Members","link":"/en/b2b-v2/openapi/team-members","routeSlug":"/en/b2b-v2/openapi/team-members","items":[{"label":"List Team Members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/team-members/list_team_members","routeSlug":"/en/b2b-v2/openapi/team-members/list_team_members","metadata":{"seo":{"title":"List Team Members","description":"Retrieve Team Members for a Location as JSON:API resource objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_team_members","name":"List Team Members","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1team_members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List 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":"Retrieve Team Members for a Location as JSON:API resource objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the filters to select Team Members by name, Position, account link,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule, payment, dismissal, deletion, or assistant availability. Status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filters use "},"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":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disables that filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related data can be requested by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wire value returns an employment profile that can contain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensitive employment and identity data. Request and store it only when it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is necessary for the integration."},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1team_members/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[name]","in":"query","schemaId":"schema_479","description":"Filter by a partial Team Member name match"},{"name":"filter[position_id]","in":"query","schemaId":"schema_480","description":"Filter by Position ID"},{"name":"filter[position_title]","in":"query","schemaId":"schema_479","description":"Filter by a partial Position title match"},{"name":"filter[fired]","in":"query","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by dismissal status: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not dismissed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dismissed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all"},"children":[]}]}]}]},{"name":"filter[deleted]","in":"query","schemaId":"schema_482","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by deletion status: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" active, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deleted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all"},"children":[]}]}]}]},{"name":"filter[user_linked]","in":"query","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by Business User link: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" not linked, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" linked, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all"},"children":[]}]}]}]},{"name":"filter[is_paid]","in":"query","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by payment status: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unpaid, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" paid, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all"},"children":[]}]}]}]},{"name":"filter[has_schedule]","in":"query","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by schedule: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without a schedule, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a schedule, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all"},"children":[]}]}]}]},{"name":"filter[is_assistant]","in":"query","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by assistant availability: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unavailable, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" available, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" all"},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_483","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related resources to include. Wire values are literal API keys:"},"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":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Position"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"employee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - employment profile"},"children":[]}]}]}]}]}],"pointer":"/paths/~1locations~1{location_id}~1team_members/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1team_members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/team_members","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[name]","in":"query","required":false,"schemaId":"schema_479"},{"name":"filter[position_id]","in":"query","required":false,"schemaId":"schema_480"},{"name":"filter[position_title]","in":"query","required":false,"schemaId":"schema_479"},{"name":"filter[fired]","in":"query","required":false,"schemaId":"schema_481"},{"name":"filter[deleted]","in":"query","required":false,"schemaId":"schema_482"},{"name":"filter[user_linked]","in":"query","required":false,"schemaId":"schema_481"},{"name":"filter[is_paid]","in":"query","required":false,"schemaId":"schema_481"},{"name":"filter[has_schedule]","in":"query","required":false,"schemaId":"schema_481"},{"name":"filter[is_assistant]","in":"query","required":false,"schemaId":"schema_481"},{"name":"include","in":"query","required":false,"schemaId":"schema_483","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/team_members","href":"team-members/list_team_members","openApiOperationId":"list_team_members","summary":"List Team Members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Team Members retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484","exampleIds":["paths/~1locations~1{location_id}~1team_members/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_484","exampleIds":["paths/~1locations~1{location_id}~1team_members/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Team Members for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid filter value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1team_members/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_484","exampleIds":["paths/~1locations~1{location_id}~1team_members/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484","exampleIds":["paths/~1locations~1{location_id}~1team_members/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/list_team_members"}],"panels":[]}]},"httpPath":"/locations/{location_id}/team_members"},{"label":"List Positions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/team-members/list_positions","routeSlug":"/en/b2b-v2/openapi/team-members/list_positions","metadata":{"seo":{"title":"List Positions","description":"Retrieve all Positions available to Team Members at a Location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_positions","name":"List Positions","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Positions","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":"Retrieve all Positions available to Team Members at a Location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is a JSON:API collection and does not contain pagination"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"metadata. The literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wire path parameter identifies a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1positions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{company_id}/positions","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{company_id}/positions","href":"team-members/list_positions","openApiOperationId":"list_positions","summary":"List Positions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Positions retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_485","exampleIds":["paths/~1locations~1{company_id}~1positions/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_485","exampleIds":["paths/~1locations~1{company_id}~1positions/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Positions for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{company_id}~1positions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_485","exampleIds":["paths/~1locations~1{company_id}~1positions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_485","exampleIds":["paths/~1locations~1{company_id}~1positions/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/list_positions"}],"panels":[]}]},"httpPath":"/locations/{company_id}/positions"},{"label":"Create Position","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/team-members/create_position","routeSlug":"/en/b2b-v2/openapi/team-members/create_position","metadata":{"seo":{"title":"Create Position","description":"Create a Position for Team Members at the specified Location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_position","name":"Create Position","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1positions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Position for Team Members at 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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1positions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1positions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1locations~1{company_id}~1positions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{company_id}/positions","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","422"],"pointer":"/locations/{company_id}/positions","href":"team-members/create_position","openApiOperationId":"create_position","summary":"Create Position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions/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":"201","description":"Position created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Malformed request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to create Positions for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid or unexpected request field","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{company_id}~1positions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/create_position"}],"panels":[]}]},"httpPath":"/locations/{company_id}/positions"},{"label":"Get Position","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/team-members/get_position","routeSlug":"/en/b2b-v2/openapi/team-members/get_position","metadata":{"seo":{"title":"Get Position","description":"Retrieve a Position by ID as a JSON:API resource object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_position","name":"Get Position","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a Position by ID as a JSON:API resource 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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true},{"name":"position_id","in":"path","schemaId":"schema_454","description":"Position ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1positions~1{position_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{company_id}/positions/{position_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"position_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{company_id}/positions/{position_id}","href":"team-members/get_position","openApiOperationId":"get_position","summary":"Get Position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Position retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read the Position","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Position not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_488","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/get_position"}],"panels":[]}]},"httpPath":"/locations/{company_id}/positions/{position_id}"},{"label":"Update Position","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/team-members/update_position","routeSlug":"/en/b2b-v2/openapi/team-members/update_position","metadata":{"seo":{"title":"Update Position","description":"Update a Position. The request must contain title."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_position","name":"Update Position","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Position","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":"Update a Position. The request must contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"title"},"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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true},{"name":"position_id","in":"path","schemaId":"schema_454","description":"Position ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1positions~1{position_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/{company_id}/positions/{position_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"position_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","401","403","404","422"],"pointer":"/locations/{company_id}/positions/{position_id}","href":"team-members/update_position","openApiOperationId":"update_position","summary":"Update Position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_id}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_487","exampleIds":["paths/~1locations~1{company_id}~1positions~1{position_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":"204","description":"Position updated successfully; no response body"},{"code":"400","description":"Malformed request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to update the Position","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Position not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid or unexpected request field","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/update_position"}],"panels":[]}]},"httpPath":"/locations/{company_id}/positions/{position_id}"},{"label":"Delete Position","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/team-members/delete_position","routeSlug":"/en/b2b-v2/openapi/team-members/delete_position","metadata":{"seo":{"title":"Delete Position","description":"Delete a Position."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_position","name":"Delete Position","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Position."},{"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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true},{"name":"position_id","in":"path","schemaId":"schema_454","description":"Position ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1positions~1{position_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/{company_id}/positions/{position_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"position_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/locations/{company_id}/positions/{position_id}","href":"team-members/delete_position","openApiOperationId":"delete_position","summary":"Delete Position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Position deleted successfully; no response body"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to delete the Position","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Position not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{company_id}~1positions~1{position_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/team-members/delete_position"}],"panels":[]}]},"httpPath":"/locations/{company_id}/positions/{position_id}"}],"content":{"contentType":"group","meta":{"name":"Team Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Team Members","showPageActions":true},{"nodeType":"markdoc","content":"Team Member and position management.\n\nManage Team Member positions and retrieve Team Member information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{location_id}/team_members","summary":"List Team Members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-members/list_team_members","deprecated":false},{"title":"/locations/{company_id}/positions","summary":"List Positions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-members/list_positions","deprecated":false},{"title":"/locations/{company_id}/positions","summary":"Create Position","prefix":{"name":"post","color":"post"},"badges":[],"link":"/team-members/create_position","deprecated":false},{"title":"/locations/{company_id}/positions/{position_id}","summary":"Get Position","prefix":{"name":"get","color":"get"},"badges":[],"link":"/team-members/get_position","deprecated":false},{"title":"/locations/{company_id}/positions/{position_id}","summary":"Update Position","prefix":{"name":"put","color":"put"},"badges":[],"link":"/team-members/update_position","deprecated":false},{"title":"/locations/{company_id}/positions/{position_id}","summary":"Delete Position","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/team-members/delete_position","deprecated":false}]}]}]}]}},{"type":"group","label":"Appointments","link":"/en/b2b-v2/openapi/appointments","routeSlug":"/en/b2b-v2/openapi/appointments","items":[{"label":"List Attendance Appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/appointments/list_attendance_appointments","routeSlug":"/en/b2b-v2/openapi/appointments/list_attendance_appointments","metadata":{"seo":{"title":"List Attendance Appointments","description":"Retrieve Appointments grouped under one attendance identifier as JSON:APIresource objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_attendance_appointments","name":"List Attendance Appointments","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1attendances~1{attendance_id}~1appointments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Attendance 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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve Appointments grouped under one attendance identifier as JSON:API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"resource objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"record_{appointment_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve the group containing one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_{visit_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve all Appointments linked to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one visit. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attendance_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter and both prefixes are literal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wire values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related data can be requested by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Wire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values remain literal API keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies Booking User data,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies Team Member data, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies Products."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Field Value includes require the corresponding Business User"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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_445","description":"Location ID","required":true},{"name":"attendance_id","in":"path","schemaId":"schema_489","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attendance group identifier. Use the literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix with an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment ID or the literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix with a visit ID."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1locations~1{location_id}~1attendances~1{attendance_id}~1appointments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_490","description":"Related resources to include; values are literal API keys"}],"pointer":"/paths/~1locations~1{location_id}~1attendances~1{attendance_id}~1appointments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1attendances~1{attendance_id}~1appointments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/attendances/{attendance_id}/appointments","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"attendance_id","in":"path","required":true,"example":"record_12345","schemaId":"schema_489"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/attendances/{attendance_id}/appointments","href":"appointments/list_attendance_appointments","openApiOperationId":"list_attendance_appointments","summary":"List Attendance Appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Attendance Appointments retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_491"}},"schemaId":"schema_491"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Appointments for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Attendance group or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid attendance identifier","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1attendances~1{attendance_id}~1appointments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_491","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_491"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/list_attendance_appointments"}],"panels":[]}]},"httpPath":"/locations/{location_id}/attendances/{attendance_id}/appointments"},{"label":"List Appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/appointments/list_appointments","routeSlug":"/en/b2b-v2/openapi/appointments/list_appointments","metadata":{"seo":{"title":"List Appointments","description":"Retrieve Appointments for a Location as JSON:API resource objects."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_appointments","name":"List Appointments","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1appointments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List 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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve Appointments for a Location as JSON:API resource objects."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination uses "},"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":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response includes the effective"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", calculated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta.pagination"},"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":"Date range values use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DDTHH:MM:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without a timezone. Provide"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[date_intersect_from]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[date_intersect_to]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" together; the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"end must be later than the start."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related data can be requested by repeating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. Wire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values remain literal API keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies Booking User data,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies Team Member data, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies Products."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Field Value includes require the corresponding Business User"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1appointments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[client_id]","in":"query","schemaId":"schema_454","description":"Filter by Booking User profile ID"},{"name":"filter[activity_id]","in":"query","schemaId":"schema_454","description":"Filter by Event ID"},{"name":"filter[date_intersect_from]","in":"query","schemaId":"schema_492","description":"Start of the Appointment intersection range, without a timezone"},{"name":"filter[date_intersect_to]","in":"query","schemaId":"schema_493","description":"End of the Appointment intersection range, without a timezone"},{"name":"page","in":"query","schemaId":"schema_447","description":"Page number"},{"name":"limit","in":"query","schemaId":"schema_448","description":"Maximum number of Appointments to return"},{"name":"include","in":"query","schemaId":"schema_490","description":"Related resources to include; values are literal API keys"}],"pointer":"/paths/~1locations~1{location_id}~1appointments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1appointments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/appointments","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[client_id]","in":"query","required":false,"schemaId":"schema_454"},{"name":"filter[activity_id]","in":"query","required":false,"schemaId":"schema_454"},{"name":"filter[date_intersect_from]","in":"query","required":false,"example":"2026-01-01T00:00:00","schemaId":"schema_492"},{"name":"filter[date_intersect_to]","in":"query","required":false,"example":"2026-01-31T23:59:59","schemaId":"schema_493"},{"name":"page","in":"query","required":false,"schemaId":"schema_447"},{"name":"limit","in":"query","required":false,"schemaId":"schema_448"},{"name":"include","in":"query","required":false,"schemaId":"components/schemas/include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/appointments","href":"appointments/list_appointments","openApiOperationId":"list_appointments","summary":"List Appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Appointments retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_494","exampleIds":["paths/~1locations~1{location_id}~1appointments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_494","exampleIds":["paths/~1locations~1{location_id}~1appointments/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read Appointments for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid filter or pagination value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1appointments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_494","exampleIds":["paths/~1locations~1{location_id}~1appointments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_494","exampleIds":["paths/~1locations~1{location_id}~1appointments/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/list_appointments"}],"panels":[]}]},"httpPath":"/locations/{location_id}/appointments"},{"label":"Delete Appointment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/appointments/delete_appointment","routeSlug":"/en/b2b-v2/openapi/appointments/delete_appointment","metadata":{"seo":{"title":"Delete Appointment","description":"Delete an Appointment. The Business User must have permission to delete Appointments for the Location and permission to delete this Appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_appointment","name":"Delete Appointment","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1appointments~1{appointment_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":"markdoc","content":"Delete an Appointment. The Business User must have permission to delete\nAppointments for the Location and permission to delete this Appointment.\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_445","description":"Location ID","required":true},{"name":"appointment_id","in":"path","schemaId":"schema_454","description":"Appointment ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1appointments~1{appointment_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1appointments~1{appointment_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/{location_id}/appointments/{appointment_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"appointment_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/locations/{location_id}/appointments/{appointment_id}","href":"appointments/delete_appointment","openApiOperationId":"delete_appointment","summary":"Delete Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Appointment deleted successfully; no response body"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to delete the Appointment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Appointment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1appointments~1{appointment_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/delete_appointment"}],"panels":[]}]},"httpPath":"/locations/{location_id}/appointments/{appointment_id}"},{"label":"Delete Timetable Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/appointments/delete_timetable_appointment","routeSlug":"/en/b2b-v2/openapi/appointments/delete_timetable_appointment","metadata":{"seo":{"title":"Delete Timetable Appointment","description":"Delete one Appointment from the timetable by its appointmentId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_timetable_appointment","name":"Delete Timetable Appointment","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Timetable 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":"Delete one Appointment from the timetable by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointmentId"},"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":"If the deleted Appointment belongs to a linked visit, the response returns"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the remaining related Appointments as a JSON:API collection. Deleting an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment without related Appointments returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_490","description":"Related resources to include in returned Appointments"}],"pointer":"/paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1timetable~1appointments~1delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_495","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_495","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{location_id}/timetable/appointments/delete","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_495","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/timetable/appointments/delete","href":"appointments/delete_timetable_appointment","openApiOperationId":"delete_timetable_appointment","summary":"Delete Timetable Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_495","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_495","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/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":"Appointment deleted; remaining related Appointments returned","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_491","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_491","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to delete the Appointment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Appointment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid request body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_491","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_491","exampleIds":["paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/delete_timetable_appointment"}],"panels":[]}]},"httpPath":"/locations/{location_id}/timetable/appointments/delete"},{"label":"List Resource Occupations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/appointments/list_resource_occupations","routeSlug":"/en/b2b-v2/openapi/appointments/list_resource_occupations","metadata":{"seo":{"title":"List Resource Occupations","description":"Retrieve resource occupations that intersect a required time interval in a Location. Results can be narrowed to one or more Services."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_resource_occupations","name":"List Resource Occupations","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1resource_occupations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Resource Occupations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve resource occupations that intersect a required time interval in a\nLocation. Results can be narrowed to one or more Services.\n\nEach JSON:API resource identifies the occupied resource instance, its time\ninterval, and the source 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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1resource_occupations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[service_id]","in":"query","schemaId":"schema_454","description":"Filter by one Service ID"},{"name":"filter[service_ids][]","in":"query","schemaId":"schema_446","description":"Filter by multiple Service IDs"},{"name":"filter[date_intersect_from_strict]","in":"query","schemaId":"schema_496","description":"Interval start in the Location timezone, without an offset","required":true},{"name":"filter[date_intersect_to_strict]","in":"query","schemaId":"schema_496","description":"Interval end in the Location timezone, without an offset","required":true}],"pointer":"/paths/~1locations~1{location_id}~1resource_occupations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1resource_occupations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/resource_occupations","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[service_id]","in":"query","required":false,"schemaId":"schema_454"},{"name":"filter[service_ids][]","in":"query","required":false,"schemaId":"schema_446"},{"name":"filter[date_intersect_from_strict]","in":"query","required":true,"schemaId":"schema_496"},{"name":"filter[date_intersect_to_strict]","in":"query","required":true,"schemaId":"schema_496"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/resource_occupations","href":"appointments/list_resource_occupations","openApiOperationId":"list_resource_occupations","summary":"List Resource Occupations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Resource occupations retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_497","exampleIds":["paths/~1locations~1{location_id}~1resource_occupations/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_497","exampleIds":["paths/~1locations~1{location_id}~1resource_occupations/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No timetable access for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid filter value or date format","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1resource_occupations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_497","exampleIds":["paths/~1locations~1{location_id}~1resource_occupations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_497","exampleIds":["paths/~1locations~1{location_id}~1resource_occupations/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/list_resource_occupations"}],"panels":[]}]},"httpPath":"/locations/{location_id}/resource_occupations"}],"content":{"contentType":"group","meta":{"name":"Appointments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appointments","showPageActions":true},{"nodeType":"markdoc","content":"Appointment management.\n\nList and manage appointments for a location."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{location_id}/attendances/{attendance_id}/appointments","summary":"List Attendance Appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/list_attendance_appointments","deprecated":false},{"title":"/locations/{location_id}/appointments","summary":"List Appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/list_appointments","deprecated":false},{"title":"/locations/{location_id}/appointments/{appointment_id}","summary":"Delete Appointment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appointments/delete_appointment","deprecated":false},{"title":"/locations/{location_id}/timetable/appointments/delete","summary":"Delete Timetable Appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/delete_timetable_appointment","deprecated":false},{"title":"/locations/{location_id}/resource_occupations","summary":"List Resource Occupations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/list_resource_occupations","deprecated":false}]}]}]}]}},{"type":"group","label":"Events","link":"/en/b2b-v2/openapi/events","routeSlug":"/en/b2b-v2/openapi/events","items":[{"label":"List Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/list_events","routeSlug":"/en/b2b-v2/openapi/events/list_events","metadata":{"seo":{"title":"List Events","description":"Retrieve Events for a Location within a future date range. The response isa JSON:API collection with the literal resource type activity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_events","name":"List Events","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve Events for a Location within a future date range. The response is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a JSON:API collection with the literal resource type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity"},"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":"code","inline":true,"attributes":{"content":"filter[from]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must not be earlier than the current time, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[to]"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must be later than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[from]"},"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_454","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[from]","in":"query","schemaId":"schema_498","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Range start in the Location timezone as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS"},"children":[]}]}]}],"required":true},{"name":"filter[to]","in":"query","schemaId":"schema_499","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Range end in the Location timezone as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS"},"children":[]}]}]}],"required":true},{"name":"filter[master_ids][]","in":"query","schemaId":"schema_463","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member IDs; the literal wire query key is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[master_ids][]"},"children":[]}]}]}]},{"name":"filter[service_ids][]","in":"query","schemaId":"schema_463","description":"Service IDs"},{"name":"filter[capacity]","in":"query","schemaId":"schema_480","description":"Minimum number of unoccupied places"},{"name":"page","in":"query","schemaId":"schema_447","description":"Result page"},{"name":"limit","in":"query","schemaId":"schema_448","description":"Maximum number of Events to return"},{"name":"include","in":"query","schemaId":"schema_500","description":"Related resources to include; values are literal API keys"}],"pointer":"/paths/~1locations~1{location_id}~1events/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/events","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"filter[from]","in":"query","required":true,"example":"2026-08-01 09:00:00","schemaId":"schema_498"},{"name":"filter[to]","in":"query","required":true,"example":"2026-08-07 21:00:00","schemaId":"schema_499"},{"name":"filter[master_ids][]","in":"query","required":false,"schemaId":"schema_463","style":"form","explode":true},{"name":"filter[service_ids][]","in":"query","required":false,"schemaId":"schema_463","style":"form","explode":true},{"name":"filter[capacity]","in":"query","required":false,"schemaId":"schema_480"},{"name":"page","in":"query","required":false,"schemaId":"schema_447"},{"name":"limit","in":"query","required":false,"schemaId":"schema_448"},{"name":"include","in":"query","required":false,"schemaId":"components/schemas/event_include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","422"],"pointer":"/locations/{location_id}/events","href":"events/list_events","openApiOperationId":"list_events","summary":"List Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Events retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_collection_response"}},"schemaId":"components/schemas/event_collection_response"},{"code":"400","description":"Required date range is missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No timetable permission for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid date range, filter, or pagination value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_collection_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_collection_response"}}},{"code":"400","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/list_events"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events"},{"label":"Create Event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/create_event","routeSlug":"/en/b2b-v2/openapi/events/create_event","metadata":{"seo":{"title":"Create Event","description":"Create a group Event for a Location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_event","name":"Create Event","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a group Event for 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_454","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_500","description":"Related resources to include in the created Event"}],"pointer":"/paths/~1locations~1{location_id}~1events/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_create_request","exampleIds":["paths/~1locations~1{location_id}~1events/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/event_create_request","exampleIds":["paths/~1locations~1{location_id}~1events/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1locations~1{location_id}~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{location_id}/events","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/event_include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/event_create_request","exampleIds":["paths/~1locations~1{location_id}~1events/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","409","422"],"pointer":"/locations/{location_id}/events","href":"events/create_event","openApiOperationId":"create_event","summary":"Create Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"components/schemas/event_create_request","exampleIds":["paths/~1locations~1{location_id}~1events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_create_request","exampleIds":["paths/~1locations~1{location_id}~1events/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":"201","description":"Event created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_item_response"}},"schemaId":"components/schemas/event_item_response"},{"code":"400","description":"Invalid request body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to create Events","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location, Team Member, or Service not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"409","description":"Team Member or Resource Instance is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/event_item_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_item_response"}}},{"code":"400","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"409","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/create_event"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events"},{"label":"List event dates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/list_event_dates","routeSlug":"/en/b2b-v2/openapi/events/list_event_dates","metadata":{"seo":{"title":"List event dates","description":"List event dates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_dates","name":"List event dates","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1dates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List 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":"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_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1dates/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[from]","in":"query","schemaId":"schema_501","required":true},{"name":"filter[to]","in":"query","schemaId":"schema_502","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1dates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/events/dates","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[from]","in":"query","required":true,"example":"2026-07-16 00:00:00","schemaId":"schema_501"},{"name":"filter[to]","in":"query","required":true,"example":"2026-07-31 23:59:59","schemaId":"schema_502"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/events/dates","href":"events/list_event_dates","openApiOperationId":"list_event_dates","summary":"List event dates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Dates containing matching events","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}},"schemaId":"schema_503"},{"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/~1locations~1{location_id}~1events~1dates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_503","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_503"}}},{"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_dates"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/dates"},{"label":"Get matching event date range","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/get_event_date_range","routeSlug":"/en/b2b-v2/openapi/events/get_event_date_range","metadata":{"seo":{"title":"Get matching event date range","description":"Get matching event date range"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_event_date_range","name":"Get matching event date range","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1dates~1range/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get matching 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":"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_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1dates~1range/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[from]","in":"query","schemaId":"schema_501","required":true},{"name":"filter[to]","in":"query","schemaId":"schema_502","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1dates~1range/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/events/dates/range","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[from]","in":"query","required":true,"example":"2026-07-16 00:00:00","schemaId":"schema_501"},{"name":"filter[to]","in":"query","required":true,"example":"2026-07-31 23:59:59","schemaId":"schema_502"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/events/dates/range","href":"events/get_event_date_range","openApiOperationId":"get_event_date_range","summary":"Get matching event date range"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Earliest and latest matching event dates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_504"}},"schemaId":"schema_504"},{"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/~1locations~1{location_id}~1events~1dates~1range/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_504","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_504"}}},{"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":"/locations/{location_id}/events/dates/range"},{"label":"List available event filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/list_event_filters","routeSlug":"/en/b2b-v2/openapi/events/list_event_filters","metadata":{"seo":{"title":"List available event filters","description":"List available event filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_filters","name":"List available event filters","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available event 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":"location_id","in":"path","schemaId":"schema_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1filters/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[from]","in":"query","schemaId":"schema_501","required":true},{"name":"filter[to]","in":"query","schemaId":"schema_502","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1filters/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/events/filters","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[from]","in":"query","required":true,"example":"2026-07-16 00:00:00","schemaId":"schema_501"},{"name":"filter[to]","in":"query","required":true,"example":"2026-07-31 23:59:59","schemaId":"schema_502"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/events/filters","href":"events/list_event_filters","openApiOperationId":"list_event_filters","summary":"List available event filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"JSON:API collection of available filter values","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}},"schemaId":"schema_505"},{"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/~1locations~1{location_id}~1events~1filters/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_505","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_505"}}},{"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_filters"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/filters"},{"label":"List event duplication strategies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/list_event_duplication_strategies_v2","routeSlug":"/en/b2b-v2/openapi/events/list_event_duplication_strategies_v2","metadata":{"seo":{"title":"List event duplication strategies","description":"List event duplication strategies"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_event_duplication_strategies_v2","name":"List event duplication strategies","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies/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":"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_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/events/duplication_strategies","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/events/duplication_strategies","href":"events/list_event_duplication_strategies_v2","openApiOperationId":"list_event_duplication_strategies_v2","summary":"List event duplication strategies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"JSON:API collection of duplication strategies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_506"}},"schemaId":"schema_506"},{"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/~1locations~1{location_id}~1events~1duplication_strategies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_506","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_506"}}},{"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_v2"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/duplication_strategies"},{"label":"Create an event duplication strategy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/create_event_duplication_strategy_v2","routeSlug":"/en/b2b-v2/openapi/events/create_event_duplication_strategy_v2","metadata":{"seo":{"title":"Create an event duplication strategy","description":"Create an event duplication strategy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_event_duplication_strategy_v2","name":"Create an event duplication strategy","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an 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_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_507"}},"schemaId":"schema_507","pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{location_id}/events/duplication_strategies","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_507"}},"responseCodes":["201","401","403","404"],"pointer":"/locations/{location_id}/events/duplication_strategies","href":"events/create_event_duplication_strategy_v2","openApiOperationId":"create_event_duplication_strategy_v2","summary":"Create an event duplication strategy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_507","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_507"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Duplication strategy created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}},"schemaId":"schema_508"},{"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/~1locations~1{location_id}~1events~1duplication_strategies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_508","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}}},{"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_v2"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/duplication_strategies"},{"label":"Update an event duplication strategy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/update_event_duplication_strategy_v2","routeSlug":"/en/b2b-v2/openapi/events/update_event_duplication_strategy_v2","metadata":{"seo":{"title":"Update an event duplication strategy","description":"Update an event duplication strategy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_event_duplication_strategy_v2","name":"Update an event duplication strategy","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies~1{strategy_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an 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_445","required":true},{"name":"strategy_id","in":"path","schemaId":"schema_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies~1{strategy_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_509"}},"schemaId":"schema_509","pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies~1{strategy_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/{location_id}/events/duplication_strategies/{strategy_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"strategy_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_509"}},"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/events/duplication_strategies/{strategy_id}","href":"events/update_event_duplication_strategy_v2","openApiOperationId":"update_event_duplication_strategy_v2","summary":"Update an event duplication strategy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_509","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_509"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated strategy in JSON:API format","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}},"schemaId":"schema_508"},{"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/~1locations~1{location_id}~1events~1duplication_strategies~1{strategy_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_508","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}}},{"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_v2"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/duplication_strategies/{strategy_id}"},{"label":"Delete an event duplication strategy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/delete_event_duplication_strategy_v2","routeSlug":"/en/b2b-v2/openapi/events/delete_event_duplication_strategy_v2","metadata":{"seo":{"title":"Delete an event duplication strategy","description":"Delete an event duplication strategy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_event_duplication_strategy_v2","name":"Delete an event duplication strategy","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies~1{strategy_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an 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_445","required":true},{"name":"strategy_id","in":"path","schemaId":"schema_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1duplication_strategies~1{strategy_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/{location_id}/events/duplication_strategies/{strategy_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"strategy_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/locations/{location_id}/events/duplication_strategies/{strategy_id}","href":"events/delete_event_duplication_strategy_v2","openApiOperationId":"delete_event_duplication_strategy_v2","summary":"Delete an event duplication strategy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Strategy deleted"},{"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/~1locations~1{location_id}~1events~1duplication_strategies~1{strategy_id}/delete/responses"}],"panels":[{"children":[{"kind":"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":"/events/delete_event_duplication_strategy_v2"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/duplication_strategies/{strategy_id}"},{"label":"Get Event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/get_event","routeSlug":"/en/b2b-v2/openapi/events/get_event","metadata":{"seo":{"title":"Get Event","description":"Return one Event in JSON:API format. Event deletion is soft: a deleted Event is excluded from list results, while direct retrieval remains available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_event","name":"Get Event","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return one Event in JSON:API format. Event deletion is soft: a deleted Event\nis excluded from list results, while direct retrieval remains available.\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_454","description":"Location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_454","description":"Event ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_500","description":"Related resources to include; values are literal API keys"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events~1{event_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/events/{event_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/event_include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{location_id}/events/{event_id}","href":"events/get_event","openApiOperationId":"get_event","summary":"Get Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Event retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_item_response"}},"schemaId":"components/schemas/event_item_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No access to this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Event not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_item_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_item_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/get_event"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}"},{"label":"Update Event","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/update_event","routeSlug":"/en/b2b-v2/openapi/events/update_event","metadata":{"seo":{"title":"Update Event","description":"Replace the mutable properties of an Event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_event","name":"Update Event","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replace the mutable properties of an Event."},{"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_454","description":"Location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_454","description":"Event ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_500","description":"Related resources to include in the updated Event"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events~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_update_request"}},"schemaId":"components/schemas/event_update_request","pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/{location_id}/events/{event_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/event_include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/event_update_request"}},"responseCodes":["200","400","401","403","404","409","422"],"pointer":"/locations/{location_id}/events/{event_id}","href":"events/update_event","openApiOperationId":"update_event","summary":"Update Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"components/schemas/event_update_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_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":"Event updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_item_response"}},"schemaId":"components/schemas/event_item_response"},{"code":"400","description":"Invalid request body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to update the Event","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location, Event, Team Member, or Service not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"409","description":"Team Member or Resource Instance is unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_item_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_item_response"}}},{"code":"400","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"409","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/update_event"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}"},{"label":"Delete Event","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/delete_event","routeSlug":"/en/b2b-v2/openapi/events/delete_event","metadata":{"seo":{"title":"Delete Event","description":"Soft-delete an Event. The Event is removed from list results, and no response body is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_event","name":"Delete Event","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Soft-delete an Event. The Event is removed from list results, and no\nresponse body is returned.\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_454","description":"Location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_454","description":"Event ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events~1{event_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/{location_id}/events/{event_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/locations/{location_id}/events/{event_id}","href":"events/delete_event","openApiOperationId":"delete_event","summary":"Delete Event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Event deleted successfully; no response body"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to delete the Event","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Event not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/delete_event"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}"},{"label":"Duplicate an event to selected dates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/duplicate_event","routeSlug":"/en/b2b-v2/openapi/events/duplicate_event","metadata":{"seo":{"title":"Duplicate an event to selected dates","description":"Duplicate an event to selected dates"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"duplicate_event","name":"Duplicate an event to selected dates","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1duplicate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Duplicate an event to selected dates","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_445","required":true},{"name":"event_id","in":"path","schemaId":"schema_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1duplicate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_510"}},"schemaId":"schema_510","pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1duplicate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{location_id}/events/{event_id}/duplicate","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_510"}},"responseCodes":["201","400","401","403","404","409"],"pointer":"/locations/{location_id}/events/{event_id}/duplicate","href":"events/duplicate_event","openApiOperationId":"duplicate_event","summary":"Duplicate an event to selected dates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_510","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_510"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"JSON:API collection of created events"},{"code":"400","description":"Invalid duplication request"},{"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":"A team member or resource is busy"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1duplicate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201"},{"code":"400"},{"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"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/duplicate_event"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}/duplicate"},{"label":"Create Event Appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/create_event_appointment","routeSlug":"/en/b2b-v2/openapi/events/create_event_appointment","metadata":{"seo":{"title":"Create Event Appointment","description":"Create an Appointment in an Event. The literal client wire object isrequired for both an existing and a new Booking User."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_event_appointment","name":"Create Event Appointment","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Event 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":"Create an Appointment in an Event. The literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wire object is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"required for both an existing and a new Booking User."},"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_454","description":"Location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_454","description":"Event ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_490","description":"Related resources to include in the created Appointment"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_appointment_create_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/event_appointment_create_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{location_id}/events/{event_id}/appointments","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/event_appointment_create_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","401","403","404","422"],"pointer":"/locations/{location_id}/events/{event_id}/appointments","href":"events/create_event_appointment","openApiOperationId":"create_event_appointment","summary":"Create Event Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"components/schemas/event_appointment_create_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_appointment_create_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/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":"201","description":"Event Appointment created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_appointment_item_response"}},"schemaId":"components/schemas/event_appointment_item_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to create Appointments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location or Event not found, including a deleted Event","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/event_appointment_item_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_appointment_item_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/create_event_appointment"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}/appointments"},{"label":"Create multiple event appointments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/bulk_create_event_appointments","routeSlug":"/en/b2b-v2/openapi/events/bulk_create_event_appointments","metadata":{"seo":{"title":"Create multiple event appointments","description":"Create multiple event appointments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulk_create_event_appointments","name":"Create multiple event appointments","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create multiple event appointments","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_445","required":true},{"name":"event_id","in":"path","schemaId":"schema_445","required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_511"}},"schemaId":"schema_511","pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1bulk/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{location_id}/events/{event_id}/appointments/bulk","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_511"}},"responseCodes":["201","401","403","404"],"pointer":"/locations/{location_id}/events/{event_id}/appointments/bulk","href":"events/bulk_create_event_appointments","openApiOperationId":"bulk_create_event_appointments","summary":"Create multiple event appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_511","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_511"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Per-record creation results","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_512"}},"schemaId":"schema_512"},{"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/~1locations~1{location_id}~1events~1{event_id}~1appointments~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_512","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_512"}}},{"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/bulk_create_event_appointments"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}/appointments/bulk"},{"label":"Update Event Appointment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/update_event_appointment","routeSlug":"/en/b2b-v2/openapi/events/update_event_appointment","metadata":{"seo":{"title":"Update Event Appointment","description":"Update pricing, Product Items, Tags, color, comment, or capacity for an Event Appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_event_appointment","name":"Update Event Appointment","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Event Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update pricing, Product Items, Tags, color, comment, or capacity for an Event Appointment."},{"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_454","description":"Location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_454","description":"Event ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_454","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire path parameter"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_490","description":"Related resources to include in the updated Appointment"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events~1{event_id}~1appointments~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/event_appointment_update_request"}},"schemaId":"components/schemas/event_appointment_update_request","pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/{location_id}/events/{event_id}/appointments/{record_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/event_appointment_update_request"}},"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/events/{event_id}/appointments/{record_id}","href":"events/update_event_appointment","openApiOperationId":"update_event_appointment","summary":"Update Event Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"components/schemas/event_appointment_update_request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_appointment_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":"Event Appointment updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_appointment_item_response"}},"schemaId":"components/schemas/event_appointment_item_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to update the Appointment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location, Event, or Appointment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Request validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_appointment_item_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_appointment_item_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/update_event_appointment"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}/appointments/{record_id}"},{"label":"Reschedule Event Appointment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/events/reschedule_event_appointment","routeSlug":"/en/b2b-v2/openapi/events/reschedule_event_appointment","metadata":{"seo":{"title":"Reschedule Event Appointment","description":"Move an Appointment from this Event to another Event in the same Location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reschedule_event_appointment","name":"Reschedule Event Appointment","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reschedule Event Appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Move an Appointment from this Event to another Event in the same 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_454","description":"Location ID","required":true},{"name":"event_id","in":"path","schemaId":"schema_454","description":"Source Event ID","required":true},{"name":"record_id","in":"path","schemaId":"schema_454","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire path parameter"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_490","description":"Related resources to include in the rescheduled Appointment"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_486","description":"Request media type","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_appointment_reschedule_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/event_appointment_reschedule_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/locations/{location_id}/events/{event_id}/appointments/{record_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"record_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_486"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/event_appointment_reschedule_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/events/{event_id}/appointments/{record_id}","href":"events/reschedule_event_appointment","openApiOperationId":"reschedule_event_appointment","summary":"Reschedule Event Appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"components/schemas/event_appointment_reschedule_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/event_appointment_reschedule_request","exampleIds":["paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/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":"Event Appointment rescheduled successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_appointment_item_response"}},"schemaId":"components/schemas/event_appointment_item_response"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to move the Appointment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location, source Event, destination Event, or Appointment not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid destination Event or request body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/event_appointment_item_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/event_appointment_item_response"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/reschedule_event_appointment"}],"panels":[]}]},"httpPath":"/locations/{location_id}/events/{event_id}/appointments/{record_id}"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":"Group Event management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{location_id}/events","summary":"List Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/list_events","deprecated":false},{"title":"/locations/{location_id}/events","summary":"Create Event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/create_event","deprecated":false},{"title":"/locations/{location_id}/events/dates","summary":"List event dates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/list_event_dates","deprecated":false},{"title":"/locations/{location_id}/events/dates/range","summary":"Get matching event date range","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/get_event_date_range","deprecated":false},{"title":"/locations/{location_id}/events/filters","summary":"List available event filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/list_event_filters","deprecated":false},{"title":"/locations/{location_id}/events/duplication_strategies","summary":"List event duplication strategies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/list_event_duplication_strategies_v2","deprecated":false},{"title":"/locations/{location_id}/events/duplication_strategies","summary":"Create an event duplication strategy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/create_event_duplication_strategy_v2","deprecated":false},{"title":"/locations/{location_id}/events/duplication_strategies/{strategy_id}","summary":"Update an event duplication strategy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/events/update_event_duplication_strategy_v2","deprecated":false},{"title":"/locations/{location_id}/events/duplication_strategies/{strategy_id}","summary":"Delete an event duplication strategy","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/events/delete_event_duplication_strategy_v2","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}","summary":"Get Event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/get_event","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}","summary":"Update Event","prefix":{"name":"put","color":"put"},"badges":[],"link":"/events/update_event","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}","summary":"Delete Event","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/events/delete_event","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}/duplicate","summary":"Duplicate an event to selected dates","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/duplicate_event","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}/appointments","summary":"Create Event Appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/create_event_appointment","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}/appointments/bulk","summary":"Create multiple event appointments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/events/bulk_create_event_appointments","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}/appointments/{record_id}","summary":"Update Event Appointment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/events/update_event_appointment","deprecated":false},{"title":"/locations/{location_id}/events/{event_id}/appointments/{record_id}","summary":"Reschedule Event Appointment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/events/reschedule_event_appointment","deprecated":false}]}]}]}]}},{"type":"group","label":"Booking Users","link":"/en/b2b-v2/openapi/booking-users","routeSlug":"/en/b2b-v2/openapi/booking-users","items":[{"label":"Get Booking User for Attendance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/booking-users/get_attendance_booking_user","routeSlug":"/en/b2b-v2/openapi/booking-users/get_attendance_booking_user","metadata":{"seo":{"title":"Get Booking User for Attendance","description":"Retrieve one Booking User profile used by the attendance workflow as aJSON:API resource object."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_attendance_booking_user","name":"Get Booking User for Attendance","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1attendance~1clients~1{client_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Booking User for Attendance","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":"Retrieve one Booking User profile used by the attendance workflow as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON:API resource object."},"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":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource type are literal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"legacy wire names. Optional related data is returned only when requested"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and may require additional Business User permissions or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled Location features."},"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_445","description":"Location ID","required":true},{"name":"client_id","in":"path","schemaId":"schema_454","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User profile ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire name"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1locations~1{location_id}~1attendance~1clients~1{client_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_513","description":"Related resources to include; values are literal API keys"}],"pointer":"/paths/~1locations~1{location_id}~1attendance~1clients~1{client_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1attendance~1clients~1{client_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/attendance/clients/{client_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"client_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[{"name":"include","in":"query","required":false,"schemaId":"components/schemas/booking_user_include","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/attendance/clients/{client_id}","href":"booking-users/get_attendance_booking_user","openApiOperationId":"get_attendance_booking_user","summary":"Get Booking User for Attendance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Booking User retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}},"schemaId":"schema_514"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No permission to read this Booking User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Booking User or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid path parameter or unavailable include","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1attendance~1clients~1{client_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_514","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking-users/get_attendance_booking_user"}],"panels":[]}]},"httpPath":"/locations/{location_id}/attendance/clients/{client_id}"},{"label":"Get Booking User Location Attendance Statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/booking-users/get_booking_user_location_attendance_statistics","routeSlug":"/en/b2b-v2/openapi/booking-users/get_booking_user_location_attendance_statistics","metadata":{"seo":{"title":"Get Booking User Location Attendance Statistics","description":"Retrieve attendance counts, financial totals, last successful attendance,and deposits for one Booking User in a Location. Statistics remainavailable for a deleted Booking User profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_booking_user_location_attendance_statistics","name":"Get Booking User Location Attendance Statistics","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Booking User Location Attendance Statistics","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":"Retrieve attendance counts, financial totals, last successful attendance,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and deposits for one Booking User in a Location. Statistics remain"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available for a deleted Booking User profile."},"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":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_attendances_statistic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type are literal legacy wire names."},"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_445","description":"Location ID","required":true},{"name":"client_id","in":"path","schemaId":"schema_454","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User profile ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire name"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/clients/{client_id}/attendances_statistic","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"client_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/clients/{client_id}/attendances_statistic","href":"booking-users/get_booking_user_location_attendance_statistics","openApiOperationId":"get_booking_user_location_attendance_statistics","summary":"Get Booking User Location Attendance Statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Booking User Location attendance statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_515","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No Booking User access for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Booking User or Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid path parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_515","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking-users/get_booking_user_location_attendance_statistics"}],"panels":[]}]},"httpPath":"/locations/{location_id}/clients/{client_id}/attendances_statistic"},{"label":"Get Booking User Chain Attendance Statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/booking-users/get_booking_user_chain_attendance_statistics","routeSlug":"/en/b2b-v2/openapi/booking-users/get_booking_user_chain_attendance_statistics","metadata":{"seo":{"title":"Get Booking User Chain Attendance Statistics","description":"Retrieve attendance counts, financial totals, last successful attendance,and deposits for one Booking User across a Chain. The Business User musthave Appointment form access configured for the requested Chain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_booking_user_chain_attendance_statistics","name":"Get Booking User Chain Attendance Statistics","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Booking User Chain Attendance Statistics","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":"Retrieve attendance counts, financial totals, last successful attendance,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and deposits for one Booking User across a Chain. The Business User must"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"have Appointment form access configured for the requested Chain."},"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":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_chain_attendances_statistic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource type are literal legacy wire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"names."},"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_445","description":"Location ID used to authorize the request","required":true},{"name":"client_id","in":"path","schemaId":"schema_454","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User profile ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire name"},"children":[]}]}]}],"required":true},{"name":"chain_id","in":"path","schemaId":"schema_454","description":"Chain ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/clients/{client_id}/chain_attendances_statistic/{chain_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"client_id","in":"path","required":true,"schemaId":"schema_454"},{"name":"chain_id","in":"path","required":true,"schemaId":"schema_454"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/clients/{client_id}/chain_attendances_statistic/{chain_id}","href":"booking-users/get_booking_user_chain_attendance_statistics","openApiOperationId":"get_booking_user_chain_attendance_statistics","summary":"Get Booking User Chain Attendance Statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Booking User Chain attendance statistics retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_516","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_516","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~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/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No Appointment form access for this Chain","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Booking User, Location, or Chain not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid path parameter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_516","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_516","exampleIds":["paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking-users/get_booking_user_chain_attendance_statistics"}],"panels":[]}]},"httpPath":"/locations/{location_id}/clients/{client_id}/chain_attendances_statistic/{chain_id}"}],"content":{"contentType":"group","meta":{"name":"Booking Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking Users","showPageActions":true},{"nodeType":"markdoc","content":"Booking User attendance and financial statistics."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{location_id}/attendance/clients/{client_id}","summary":"Get Booking User for Attendance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/booking-users/get_attendance_booking_user","deprecated":false},{"title":"/locations/{location_id}/clients/{client_id}/attendances_statistic","summary":"Get Booking User Location Attendance Statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/booking-users/get_booking_user_location_attendance_statistics","deprecated":false},{"title":"/locations/{location_id}/clients/{client_id}/chain_attendances_statistic/{chain_id}","summary":"Get Booking User Chain Attendance Statistics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/booking-users/get_booking_user_chain_attendance_statistics","deprecated":false}]}]}]}]}},{"type":"separator","label":"Administrative","content":null},{"type":"group","label":"Custom Fields","link":"/en/b2b-v2/openapi/custom-fields","routeSlug":"/en/b2b-v2/openapi/custom-fields","items":[{"label":"List Custom Fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/custom-fields/list_custom_fields","routeSlug":"/en/b2b-v2/openapi/custom-fields/list_custom_fields","metadata":{"seo":{"title":"List Custom Fields","description":"Retrieve Custom Fields configured for Appointments and Booking Users in aLocation. Access depends on the Business User's Custom Field permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_custom_fields","name":"List Custom Fields","isWebhook":false,"pointer":"/paths/~1locations~1{location_id}~1custom_fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Custom Fields","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":"Retrieve Custom Fields configured for Appointments and Booking Users in a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location. Access depends on the Business User's Custom Field permissions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"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":" filter values mean Appointment and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User respectively. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[entity_slug]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a compatibility alias"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[parent_entity_type]"},"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_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{location_id}~1custom_fields/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter[parent_entity_type]","in":"query","schemaId":"schema_517","description":"Filter by Appointment or Booking User wire entity value"},{"name":"filter[entity_slug]","in":"query","schemaId":"schema_517","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compatibility alias for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[parent_entity_type]"},"children":[]}]}]}],"deprecated":true},{"name":"include","in":"query","schemaId":"schema_518","description":"Include Custom Field type or interface options"}],"pointer":"/paths/~1locations~1{location_id}~1custom_fields/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{location_id}~1custom_fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{location_id}/custom_fields","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"location_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"filter[parent_entity_type]","in":"query","required":false,"schemaId":"schema_517"},{"name":"filter[entity_slug]","in":"query","required":false,"schemaId":"schema_517"},{"name":"include","in":"query","required":false,"schemaId":"schema_518","style":"form","explode":true}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404","422"],"pointer":"/locations/{location_id}/custom_fields","href":"custom-fields/list_custom_fields","openApiOperationId":"list_custom_fields","summary":"List Custom Fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Custom Fields retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519","exampleIds":["paths/~1locations~1{location_id}~1custom_fields/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_519","exampleIds":["paths/~1locations~1{location_id}~1custom_fields/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"403","description":"Forbidden - No Custom Field access for this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"},{"code":"422","description":"Invalid filter or include value","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}},"schemaId":"components/schemas/error_response"}],"pointer":"/paths/~1locations~1{location_id}~1custom_fields/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_519","exampleIds":["paths/~1locations~1{location_id}~1custom_fields/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519","exampleIds":["paths/~1locations~1{location_id}~1custom_fields/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"403","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"404","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}},{"code":"422","schemaId":"components/schemas/error_response","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error_response"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/list_custom_fields"}],"panels":[]}]},"httpPath":"/locations/{location_id}/custom_fields"}],"content":{"contentType":"group","meta":{"name":"Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":"Location-specific Custom Fields for Appointments and Booking Users."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{location_id}/custom_fields","summary":"List Custom Fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/list_custom_fields","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/en/b2b-v2/openapi/tags","routeSlug":"/en/b2b-v2/openapi/tags","items":[{"label":"List Tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/tags/list_tags","routeSlug":"/en/b2b-v2/openapi/tags/list_tags","metadata":{"seo":{"title":"List Tags","description":"Returns all Tags for the specified Location, optionally filtered by entity type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list_tags","name":"List Tags","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Tags","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 Tags for the specified Location, optionally filtered by entity type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response uses "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonapi.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON:API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: \"tag\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the resource type name (not to be confused with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute)."},"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":"Entity 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":"code","inline":true,"attributes":{"content":"common"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (0) - General 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":" (1) - Booking User 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":" (2) - Appointment 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":" (3) - Event Tags"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to filter by type. Accepts both string aliases and numeric values."},"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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1tags/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"entity","in":"query","schemaId":"schema_520","description":"Filter by entity type (alias or numeric code)","example":"client"}],"pointer":"/paths/~1locations~1{company_id}~1tags/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{company_id}/tags","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[{"name":"entity","in":"query","required":false,"example":"client","schemaId":"schema_520"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{company_id}/tags","href":"tags/list_tags","openApiOperationId":"list_tags","summary":"List Tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Tags retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_521","exampleIds":["paths/~1locations~1{company_id}~1tags/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_521","exampleIds":["paths/~1locations~1{company_id}~1tags/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"},{"code":"403","description":"Forbidden - No permission to manage this Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523"}],"pointer":"/paths/~1locations~1{company_id}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_521","exampleIds":["paths/~1locations~1{company_id}~1tags/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_521","exampleIds":["paths/~1locations~1{company_id}~1tags/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"403","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"404","schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/list_tags"}],"panels":[]}]},"httpPath":"/locations/{company_id}/tags"},{"label":"Create Tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/tags/create_tag","routeSlug":"/en/b2b-v2/openapi/tags/create_tag","metadata":{"seo":{"title":"Create Tag","description":"Creates a new Tag for the specified Location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create_tag","name":"Create Tag","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a new Tag for the specified Location.\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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_524","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1tags/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_525"}},"schemaId":"schema_525","pointer":"/paths/~1locations~1{company_id}~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/locations/{company_id}/tags","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_524"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_525"}},"responseCodes":["201","400","401","403","404","422"],"pointer":"/locations/{company_id}/tags","href":"tags/create_tag","openApiOperationId":"create_tag","summary":"Create Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_525","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_525"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Tag created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526","exampleIds":["paths/~1locations~1{company_id}~1tags/post/responses/201/content/application~1json/example"]}},"schemaId":"schema_526","exampleIds":["paths/~1locations~1{company_id}~1tags/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid entity type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"404","description":"Location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"},{"code":"422","description":"Validation Error - Missing required fields","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"}],"pointer":"/paths/~1locations~1{company_id}~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_526","exampleIds":["paths/~1locations~1{company_id}~1tags/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526","exampleIds":["paths/~1locations~1{company_id}~1tags/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"401","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"403","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"404","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"422","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/create_tag"}],"panels":[]}]},"httpPath":"/locations/{company_id}/tags"},{"label":"Get Tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/tags/get_tag","routeSlug":"/en/b2b-v2/openapi/tags/get_tag","metadata":{"seo":{"title":"Get Tag","description":"Returns detailed information about a specific Tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get_tag","name":"Get Tag","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Tag","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 detailed information about a specific Tag."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response uses "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://jsonapi.org/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON:API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: \"tag\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the resource type name."},"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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true},{"name":"tag_id","in":"path","schemaId":"schema_445","description":"Tag ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1tags~1{tag_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/locations/{company_id}/tags/{tag_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"tag_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/locations/{company_id}/tags/{tag_id}","href":"tags/get_tag","openApiOperationId":"get_tag","summary":"Get Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Tag details retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529","exampleIds":["paths/~1locations~1{company_id}~1tags~1{tag_id}/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_529","exampleIds":["paths/~1locations~1{company_id}~1tags~1{tag_id}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530"}],"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_529","exampleIds":["paths/~1locations~1{company_id}~1tags~1{tag_id}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529","exampleIds":["paths/~1locations~1{company_id}~1tags~1{tag_id}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"403","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"404","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/get_tag"}],"panels":[]}]},"httpPath":"/locations/{company_id}/tags/{tag_id}"},{"label":"Update Tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/tags/update_tag","routeSlug":"/en/b2b-v2/openapi/tags/update_tag","metadata":{"seo":{"title":"Update Tag","description":"Updates an existing Tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"update_tag","name":"Update Tag","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an existing Tag.\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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true},{"name":"tag_id","in":"path","schemaId":"schema_445","description":"Tag ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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_524","required":true},{"name":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1tags~1{tag_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531","pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/locations/{company_id}/tags/{tag_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"tag_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_524"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_531"}},"responseCodes":["204","401","403","404","422"],"pointer":"/locations/{company_id}/tags/{tag_id}","href":"tags/update_tag","openApiOperationId":"update_tag","summary":"Update Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_531"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Tag updated successfully"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"403","description":"Forbidden - Tag is not editable or belongs to another Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530"},{"code":"422","description":"Validation Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522"}],"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"403","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"404","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"422","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/update_tag"}],"panels":[]}]},"httpPath":"/locations/{company_id}/tags/{tag_id}"},{"label":"Delete Tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/en/b2b-v2/openapi/tags/delete_tag","routeSlug":"/en/b2b-v2/openapi/tags/delete_tag","metadata":{"seo":{"title":"Delete Tag","description":"Deletes a Tag by marking it as deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete_tag","name":"Delete Tag","isWebhook":false,"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a Tag by marking it as deleted.\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":"company_id","in":"path","schemaId":"schema_445","description":"Location ID","required":true},{"name":"tag_id","in":"path","schemaId":"schema_445","description":"Tag ID","required":true}],"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_450","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":"Authorization","in":"header","schemaId":"schema_451","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/~1locations~1{company_id}~1tags~1{tag_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/locations/{company_id}/tags/{tag_id}","servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"parameters":{"path":[{"name":"company_id","in":"path","required":true,"schemaId":"schema_445"},{"name":"tag_id","in":"path","required":true,"schemaId":"schema_445"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/vnd.api.v2+json","schemaId":"schema_450"},{"name":"Authorization","in":"header","required":true,"schemaId":"schema_451"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/locations/{company_id}/tags/{tag_id}","href":"tags/delete_tag","openApiOperationId":"delete_tag","summary":"Delete Tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/en/b2b-v2/openapi","description":"Mock server","isMockServer":true},{"url":"https://api.alteg.io/api/v2","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":"Tag deleted successfully"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"403","description":"Forbidden - Tag is not editable or belongs to another Location","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527"},{"code":"404","description":"Tag not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530"}],"pointer":"/paths/~1locations~1{company_id}~1tags~1{tag_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"403","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"404","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/delete_tag"}],"panels":[]}]},"httpPath":"/locations/{company_id}/tags/{tag_id}"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Booking User tagging system."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/locations/{company_id}/tags","summary":"List Tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/list_tags","deprecated":false},{"title":"/locations/{company_id}/tags","summary":"Create Tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/create_tag","deprecated":false},{"title":"/locations/{company_id}/tags/{tag_id}","summary":"Get Tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/get_tag","deprecated":false},{"title":"/locations/{company_id}/tags/{tag_id}","summary":"Update Tag","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/update_tag","deprecated":false},{"title":"/locations/{company_id}/tags/{tag_id}","summary":"Delete Tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/delete_tag","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/resourceIdentifier":{"id":"components/schemas/resourceIdentifier","kind":"json-schema","title":"resourceIdentifier","data":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}}},"components/schemas/toManyRelationship":{"id":"components/schemas/toManyRelationship","kind":"json-schema","title":"toManyRelationship","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/resourceIdentifier"}}}}},"components/schemas/toOneRelationship":{"id":"components/schemas/toOneRelationship","kind":"json-schema","title":"toOneRelationship","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/resourceIdentifier"},{"type":"null"}]}}}},"components/schemas/service_resource":{"id":"components/schemas/service_resource","kind":"json-schema","title":"Service Resource","data":{"title":"Service Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"service","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Service ID"},"attributes":{"type":"object","additionalProperties":false,"required":["title","category_id"],"properties":{"title":{"type":"string","description":"Service name"},"category_id":{"type":"integer","description":"Service Category ID"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"resources":{"$ref":"#/components/schemas/toManyRelationship"},"service_composite":{"$ref":"#/components/schemas/toOneRelationship"},"resource_links":{"$ref":"#/components/schemas/toManyRelationship"},"company_links":{"$ref":"#/components/schemas/toManyRelationship"},"trial_settings":{"$ref":"#/components/schemas/toOneRelationship"}}}},"$defs":{"resourceIdentifier":{"type":"object","additionalProperties":false,"required":["type","id"],"properties":{"type":{"type":"string"},"id":{"type":"string"}}},"toManyRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/resourceIdentifier"}}}},"toOneRelationship":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/resourceIdentifier"},{"type":"null"}]}}},"includedResource":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object"},"relationships":{"type":"object"}}}}}},"components/schemas/includedResource":{"id":"components/schemas/includedResource","kind":"json-schema","title":"includedResource","data":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object"},"relationships":{"type":"object"}}}},"components/schemas/error_response":{"id":"components/schemas/error_response","kind":"json-schema","title":"B2B v2 Error Response","data":{"title":"B2B v2 Error Response","type":"object","additionalProperties":false,"required":["success","data","meta"],"properties":{"success":{"type":"boolean","const":false},"data":{"type":"null"},"meta":{"type":"object","required":["message"],"additionalProperties":true,"properties":{"message":{"type":"string"},"errors":{"type":"object","description":"Field-level validation errors, when applicable","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"components/schemas/service_category_resource":{"id":"components/schemas/service_category_resource","kind":"json-schema","title":"Service Category Resource","data":{"title":"Service Category Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"service_category","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Service Category ID"},"attributes":{"type":"object","additionalProperties":false,"required":["title","salon_service_id"],"properties":{"title":{"type":"string","description":"Service Category name"},"salon_service_id":{"type":"integer","description":"Location-specific Service Category link ID"}}}}}},"components/schemas/attendance_service_resource":{"id":"components/schemas/attendance_service_resource","kind":"json-schema","title":"Attendance Service Resource","data":{"title":"Attendance Service Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"attendance_service","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Compound Attendance Service identifier"},"attributes":{"type":"object","additionalProperties":false,"required":["company_id","service_id","category_id","is_composite","composite_service_id","salon_service_id","composite_position","staff_id","title","length","duration","price_min","price_max","technical_break_duration"],"properties":{"company_id":{"type":"integer","description":"Location ID"},"service_id":{"type":"integer","description":"Service ID"},"category_id":{"type":"integer","description":"Service Category ID"},"is_composite":{"type":"boolean","description":"Whether the Service is composite"},"composite_service_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parent composite Service ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]}]}]}]},"salon_service_id":{"type":["integer","null"],"description":"Location-specific Service link ID"},"composite_position":{"type":["integer","null"],"description":"Position within a composite Service"},"staff_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not Team Member-specific"},"children":[]}]}]}]},"title":{"type":"string","description":"Service name"},"length":{"type":"integer","minimum":0,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated duration in seconds; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]}]}]}]},"duration":{"type":"integer","minimum":0,"description":"Service duration in seconds"},"price_min":{"type":"number","description":"Minimum Service price"},"price_max":{"type":"number","description":"Maximum Service price"},"technical_break_duration":{"type":"integer","minimum":0,"description":"Technical break duration in seconds"}}}}}},"components/schemas/pagination":{"id":"components/schemas/pagination","kind":"json-schema","title":"pagination","data":{"type":"object","additionalProperties":false,"required":["page","offset","limit"],"properties":{"page":{"type":"integer","minimum":1},"offset":{"type":"integer","minimum":0},"limit":{"type":"integer","minimum":1,"maximum":250}}}},"components/schemas/attendance_service_suggestion_resource":{"id":"components/schemas/attendance_service_suggestion_resource","kind":"json-schema","title":"Attendance Service Suggestion Resource","data":{"title":"Attendance Service Suggestion Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"attendance_service_suggestion","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Suggested Service ID"},"attributes":{"type":"object","additionalProperties":false,"required":["service_id","suggestion_type","record_id"],"properties":{"service_id":{"type":"integer","description":"Suggested Service ID"},"suggestion_type":{"type":"string","enum":["last_client_visit_attendance_service","client_popular_service","master_popular_service"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suggestion reason. Enum values are literal wire values; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifies a Booking User and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"master"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies a Team Member."},"children":[]}]}]}]},"record_id":{"type":["integer","null"],"description":"Source Appointment ID when the suggestion is based on a prior visit"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"attendance_service":{"$ref":"#/components/schemas/toOneRelationship"},"record":{"$ref":"#/components/schemas/toOneRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment relationship. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]}}}}}},"components/schemas/unit_resource":{"id":"components/schemas/unit_resource","kind":"json-schema","title":"Product Unit Resource","data":{"title":"Product Unit Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"unit","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Product Unit ID"},"attributes":{"type":"object","additionalProperties":false,"required":["company_id","title","short_title"],"properties":{"company_id":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location ID for a custom Unit; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a shared system Unit"},"children":[]}]}]}]},"title":{"type":"string","description":"Full Unit name"},"short_title":{"type":"string","description":"Abbreviated Unit name"}}}}}},"components/schemas/product_resource":{"id":"components/schemas/product_resource","kind":"json-schema","title":"Product Resource","data":{"title":"Product Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"good","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Product ID"},"attributes":{"type":"object","additionalProperties":false,"required":["category_id","title","sale_unit_id","consumable_unit_id","sale_unit_to_consumable_unit_ratio","loyalty_abonement_type_id","loyalty_certificate_type_id","cost","actual_cost","is_chain"],"properties":{"category_id":{"type":"integer","description":"Product Category ID"},"title":{"type":"string","description":"Product name"},"sale_unit_id":{"type":"integer","description":"Sale Unit ID"},"consumable_unit_id":{"type":"integer","description":"Consumable Unit ID"},"sale_unit_to_consumable_unit_ratio":{"type":"number","description":"Number of Consumable Units in one Sale Unit"},"loyalty_abonement_type_id":{"type":["integer","null"],"description":"Membership type ID, when the Product represents a membership"},"loyalty_certificate_type_id":{"type":["integer","null"],"description":"Certificate type ID, when the Product represents a certificate"},"cost":{"type":"number","description":"Product sale price"},"actual_cost":{"type":["number","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current Product cost when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"actual_cost"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is requested and the Business"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User has permission to view it; otherwise "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"is_chain":{"type":"boolean","description":"Whether the Product belongs to the Chain catalog"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"loyalty_abonement_type":{"$ref":"#/components/schemas/toOneRelationship"},"loyalty_certificate_type":{"$ref":"#/components/schemas/toOneRelationship"},"mark_settings":{"$ref":"#/components/schemas/toOneRelationship"},"storage_amounts":{"$ref":"#/components/schemas/toManyRelationship"}}}}}},"components/schemas/storage_amount_resource":{"id":"components/schemas/storage_amount_resource","kind":"json-schema","title":"Product Storage Amount Resource","data":{"title":"Product Storage Amount Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"good_storage_amount","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Composite Product and Storage ID"},"attributes":{"type":"object","additionalProperties":false,"required":["good_id","storage_id","sale_amount","consumable_amount"],"properties":{"good_id":{"type":"integer","description":"Product ID"},"storage_id":{"type":"integer","description":"Storage ID"},"sale_amount":{"type":"number","description":"Available amount measured in Sale Units"},"consumable_amount":{"type":"number","description":"Available amount measured in Consumable Units"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"storage":{"$ref":"#/components/schemas/toOneRelationship"}}}}}},"components/schemas/product_category_resource":{"id":"components/schemas/product_category_resource","kind":"json-schema","title":"Product Category Resource","data":{"title":"Product Category Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"good_category","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Product Category ID"},"attributes":{"type":"object","additionalProperties":false,"required":["title","is_chain","parent_category_id"],"properties":{"title":{"type":"string","description":"Product Category name"},"is_chain":{"type":"boolean","description":"Whether the Product Category belongs to the Chain catalog"},"parent_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":"Parent Product Category ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a root category"},"children":[]}]}]}]}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"child_categories":{"$ref":"#/components/schemas/toManyRelationship"},"goods":{"$ref":"#/components/schemas/toManyRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product relationships. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]}}}}}},"components/schemas/attendance_product_item_resource":{"id":"components/schemas/attendance_product_item_resource","kind":"json-schema","title":"Appointment Product Item Resource","data":{"title":"Appointment Product Item Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"attendance_good_item","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Appointment Product Item ID"},"attributes":{"type":"object","additionalProperties":false,"required":["record_id","quantity","unit_id","sale_unit_id","consumable_unit_id","operation_unit_type","operation_type_slug","first_cost","manual_cost","cost_per_unit","discount_percent","cost","master_id","staff_id","good_id","storage_id"],"properties":{"record_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire field"},"children":[]}]}]}]},"quantity":{"type":"number","description":"Product quantity"},"unit_id":{"type":"integer","description":"Operation Unit ID"},"sale_unit_id":{"type":"integer","description":"Sale Unit ID"},"consumable_unit_id":{"type":"integer","description":"Consumable Unit ID"},"operation_unit_type":{"type":["string","null"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated wire field; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_type_slug"},"children":[]}]}]}]},"operation_type_slug":{"type":["string","null"],"description":"Unit operation type"},"first_cost":{"type":"number","description":"Product cost before Appointment item adjustments"},"manual_cost":{"type":"number","description":"Manually specified Product cost"},"cost_per_unit":{"type":"number","description":"Product cost per unit"},"discount_percent":{"type":"number","description":"Applied discount percentage"},"cost":{"type":"number","description":"Final Product cost"},"master_id":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated Team Member ID wire alias; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]}]}]}]},"staff_id":{"type":"integer","description":"Team Member ID"},"good_id":{"type":"integer","description":"Product ID"},"storage_id":{"type":"integer","description":"Storage ID"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"good":{"$ref":"#/components/schemas/toOneRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product relationship. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"good"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]},"staff":{"$ref":"#/components/schemas/toOneRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member relationship. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]},"storage_amount":{"$ref":"#/components/schemas/toOneRelationship"},"loyalty_abonement":{"$ref":"#/components/schemas/toOneRelationship"},"loyalty_certificate":{"$ref":"#/components/schemas/toOneRelationship"},"marks":{"$ref":"#/components/schemas/toManyRelationship"}}}}}},"components/schemas/team_member_resource":{"id":"components/schemas/team_member_resource","kind":"json-schema","title":"Team Member Resource","data":{"title":"Team Member Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"staff","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Team Member ID"},"attributes":{"type":"object","additionalProperties":false,"required":["name","tt_markup","specialization","image","position_id","is_available_as_assistant"],"properties":{"name":{"type":"string","description":"Team Member name"},"tt_markup":{"type":"integer","description":"Schedule grid interval value"},"specialization":{"type":"string","description":"Team Member specialization"},"image":{"type":"string","description":"Team Member image URL"},"position_id":{"type":"integer","description":"Position ID"},"is_available_as_assistant":{"type":"boolean","description":"Whether the Team Member is available as an assistant"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"position":{"$ref":"#/components/schemas/toOneRelationship"},"employee":{"$ref":"#/components/schemas/toOneRelationship"}}}}}},"components/schemas/position_resource":{"id":"components/schemas/position_resource","kind":"json-schema","title":"Position Resource","data":{"title":"Position Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"staff_position","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Position ID"},"attributes":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","description":"Position title"}}}}}},"components/schemas/employment_profile_resource":{"id":"components/schemas/employment_profile_resource","kind":"json-schema","title":"Employment Profile Resource","data":{"title":"Employment Profile Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"employee","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Employment profile ID"},"attributes":{"type":"object","additionalProperties":false,"required":["phone","name","firstname","surname","patronymic","date_admission","date_registration_end","citizenship","gender","passport_data","personal_tax_reference_number","number_insurance_certificates"],"properties":{"phone":{"type":"string","description":"Phone number"},"name":{"type":"string","description":"Display name"},"firstname":{"type":"string","description":"First name"},"surname":{"type":"string","description":"Last name"},"patronymic":{"type":"string","description":"Patronymic"},"date_admission":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","description":"Employment start date and time without a timezone"},"date_registration_end":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","description":"Registration end date and time without a timezone"},"citizenship":{"type":"string","description":"Citizenship"},"gender":{"type":"integer","enum":[0,1,2],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender wire value: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unspecified, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" male, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" female"},"children":[]}]}]}]},"passport_data":{"type":"string","description":"Passport data"},"personal_tax_reference_number":{"type":"string","description":"Personal tax reference number"},"number_insurance_certificates":{"type":"string","description":"Insurance certificate number"}}}}}},"components/schemas/team_member_position_resource":{"id":"components/schemas/team_member_position_resource","kind":"json-schema","title":"Position Resource","data":{"title":"Position Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"position","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Position ID"},"attributes":{"type":"object","additionalProperties":false,"required":["chain_id","title","description","services_binding_type","rules_required_fields","only_chain_appointment","salon_ids"],"properties":{"chain_id":{"type":"integer","description":"Chain ID"},"title":{"type":"string","description":"Position title"},"description":{"type":"string","description":"Position description"},"services_binding_type":{"type":"integer","enum":[0,1,2],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Service binding mode:"},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - disabled"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - soft"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - strict"},"children":[]}]}]}]}]},"rules_required_fields":{"type":"array","items":{"type":"string"},"description":"Required rule fields"},"only_chain_appointment":{"type":"boolean","description":"Whether the Position is available only for Chain Appointments"},"salon_ids":{"type":"array","items":{"type":"integer"},"description":"Location IDs linked to the Position"}}}}}},"components/schemas/include":{"id":"components/schemas/include","kind":"json-schema","title":"Appointment Includes","data":{"title":"Appointment Includes","type":"array","uniqueItems":true,"items":{"type":"string","enum":["client","client.custom_field_values","staff","services","goods","resource_instances","labels","attendance_service_items","attendance_good_items","attendance_document","transactions","fast_payment_settings","acceptance_free","custom_field_values","comer","client_notification_settings","client_schedule","duration_details"]}}},"components/schemas/appointment_resource":{"id":"components/schemas/appointment_resource","kind":"json-schema","title":"Appointment Resource","data":{"title":"Appointment Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"record","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Appointment ID"},"attributes":{"type":"object","additionalProperties":false,"required":["company_id","external_id","visit_id","booking_user_id","bookform_id","master_id","staff_id","client_id","comer_id","source","attendance","attendance_status","attendance_status_slug","client_fictive_name","client_fictive_phone","client_fictive_email","clients_count","activity_id","custom_color","custom_font_color","length","duration","paid_full","is_paid","is_overpaid","timestamp","date","created_datetime","from_url","is_mobile","comment","prepaid_status","record_from","payment_status","is_sale_bill_printed","is_client_notification_sent"],"properties":{"company_id":{"type":"integer","description":"Location ID"},"external_id":{"type":"string","description":"External Appointment ID"},"visit_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked visit ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not linked"},"children":[]}]}]}]},"booking_user_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User account ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]}]}]}]},"bookform_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking form ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]}]}]}]},"master_id":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated wire field for Team Member ID; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]}]}]}]},"staff_id":{"type":"integer","description":"Team Member ID"},"client_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User profile ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when absent"},"children":[]}]}]}]},"comer_id":{"type":["integer","null"],"description":"Walk-in visitor ID"},"source":{"type":"integer","description":"Appointment source wire value"},"attendance":{"type":"integer","enum":[-1,0,1,2],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated attendance wire value; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attendance_status_slug"},"children":[]}]}]}]},"attendance_status":{"type":"integer","enum":[-1,0,1,2],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated attendance status; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attendance_status_slug"},"children":[]}]}]}]},"attendance_status_slug":{"type":"string","enum":["absent","waiting","attended","confirmed"],"description":"Appointment attendance status"},"client_fictive_name":{"type":["string","null"],"description":"Fallback Booking User name stored on the Appointment"},"client_fictive_phone":{"type":["string","null"],"description":"Fallback Booking User phone stored on the Appointment"},"client_fictive_email":{"type":["string","null"],"description":"Fallback Booking User email stored on the Appointment"},"clients_count":{"type":"integer","minimum":1,"description":"Number of Booking Users in the Appointment"},"activity_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the Appointment is not part of an Event"},"children":[]}]}]}]},"custom_color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment background color without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or an empty string"},"children":[]}]}]}]},"custom_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":"Appointment text color without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or an empty string"},"children":[]}]}]}]},"length":{"type":"integer","minimum":0,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated duration in seconds; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration"},"children":[]}]}]}]},"duration":{"type":"integer","minimum":0,"description":"Appointment duration in seconds"},"paid_full":{"type":"integer","enum":[0,1,2],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated payment wire value; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_overpaid"},"children":[]}]}]}]},"is_paid":{"type":"boolean","description":"Whether the Appointment is fully paid"},"is_overpaid":{"type":"boolean","description":"Whether the Appointment is overpaid"},"timestamp":{"type":"integer","format":"int64","description":"Appointment start as a Unix timestamp"},"date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","description":"Appointment start in the Location timezone, without an offset"},"created_datetime":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","description":"Creation date and time in the Location timezone, without an offset"},"from_url":{"type":"string","description":"Source URL, or an empty string"},"is_mobile":{"type":"integer","description":"Mobile-origin wire status"},"comment":{"type":"string","description":"Appointment comment"},"prepaid_status":{"type":"integer","description":"Prepayment status wire value"},"record_from":{"type":"string","description":"Human-readable Appointment source, or an empty string"},"payment_status":{"type":["integer","null"],"description":"Membership auto-payment status, when available"},"is_sale_bill_printed":{"type":["boolean","null"],"description":"Whether the sale bill is printed, when available"},"is_client_notification_sent":{"type":"boolean","description":"Whether a Booking User notification was sent"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"client":{"$ref":"#/components/schemas/toOneRelationship"},"staff":{"$ref":"#/components/schemas/toOneRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member relationship. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]},"services":{"$ref":"#/components/schemas/toManyRelationship"},"goods":{"$ref":"#/components/schemas/toManyRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product relationships. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"goods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]},"resource_instances":{"$ref":"#/components/schemas/toManyRelationship"},"labels":{"$ref":"#/components/schemas/toManyRelationship"},"attendance_service_items":{"$ref":"#/components/schemas/toManyRelationship"},"attendance_good_items":{"$ref":"#/components/schemas/toManyRelationship"},"attendance_document":{"$ref":"#/components/schemas/toOneRelationship"},"transactions":{"$ref":"#/components/schemas/toManyRelationship"},"fast_payment_settings":{"$ref":"#/components/schemas/toOneRelationship"},"acceptance_free":{"$ref":"#/components/schemas/toOneRelationship"},"custom_field_values":{"$ref":"#/components/schemas/toManyRelationship"},"comer":{"$ref":"#/components/schemas/toOneRelationship"},"client_notification_settings":{"$ref":"#/components/schemas/toOneRelationship"},"client_schedule":{"$ref":"#/components/schemas/toOneRelationship"},"duration_details":{"$ref":"#/components/schemas/toOneRelationship"}}}}}},"components/schemas/resource_occupation_resource":{"id":"components/schemas/resource_occupation_resource","kind":"json-schema","title":"Resource Occupation Resource","data":{"title":"Resource Occupation Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"resource_occupation","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Resource occupation ID"},"attributes":{"type":"object","additionalProperties":false,"required":["source_type","source_type_slug","source_id","resource_id","resource_instance_id","from","to"],"properties":{"source_type":{"type":"string","enum":["record","activity"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated source type; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_type_slug"},"children":[]}]}]}]},"source_type_slug":{"type":"string","enum":["record","activity"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Occupation source. Literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"activity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wire values mean"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment and Event respectively."},"children":[]}]}]}]},"source_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment or Event ID, depending on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source_type_slug"},"children":[]}]}]}]},"resource_id":{"type":"integer","description":"Resource ID"},"resource_instance_id":{"type":"integer","description":"Resource instance ID"},"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Occupation start in the Location timezone"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Occupation end in the Location timezone"}}}}}},"components/schemas/event_include":{"id":"components/schemas/event_include","kind":"json-schema","title":"Event Includes","data":{"title":"Event Includes","type":"array","uniqueItems":true,"items":{"type":"string","enum":["staff","service","resource_instances","labels","duration_details","master"]}}},"components/schemas/event_resource":{"id":"components/schemas/event_resource","kind":"json-schema","title":"Event Resource","data":{"title":"Event Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"activity","description":"Literal JSON:API resource type returned for Events"},"id":{"type":"string","description":"Event ID"},"attributes":{"type":"object","additionalProperties":false,"required":["master_id","staff_id","service_id","timestamp","length","capacity","clients_count","color","instructions","stream_link","font_color","notified","comment","deleted","schedule_id","schedule_till","schedule_event_modified","date"],"properties":{"master_id":{"type":"integer","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated wire field for Team Member ID; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff_id"},"children":[]}]}]}]},"staff_id":{"type":"integer","description":"Team Member ID"},"service_id":{"type":"integer","description":"Service ID"},"timestamp":{"type":"integer","format":"int64","description":"Event start as a Unix timestamp"},"length":{"type":"integer","minimum":1,"maximum":86400,"description":"Event duration in seconds"},"capacity":{"type":"integer","minimum":1,"description":"Total number of available places"},"clients_count":{"type":"integer","minimum":0,"description":"Number of Booking Users currently booked"},"color":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event background color including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]}]}]}]},"instructions":{"type":"string","description":"Instructions for Booking Users"},"stream_link":{"type":"string","description":"Online Event stream link, or an empty string"},"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":"Event text color including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]}]}]}]},"notified":{"type":"boolean","description":"Whether an Event notification was sent"},"comment":{"type":["string","null"],"description":"Event comment"},"deleted":{"type":"boolean","description":"Whether the Event is deleted (a deleted Event stays readable by ID)"},"schedule_id":{"type":["integer","null"],"description":"Event Schedule ID"},"schedule_till":{"oneOf":[{"type":"object","additionalProperties":false,"required":["date","timezone_type","timezone"],"properties":{"date":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{6}$"},"timezone_type":{"type":"integer"},"timezone":{"type":"string"}}},{"type":"null"}],"description":"Event Schedule end represented by the production DateTime wire object"},"schedule_event_modified":{"type":["boolean","null"],"description":"Whether this scheduled Event differs from its Event Schedule"},"date":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+-][0-9]{4}$","description":"Event start in the Location timezone with a numeric offset"}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"staff":{"$ref":"#/components/schemas/toOneRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Team Member relationship. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"staff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]},"master":{"$ref":"#/components/schemas/toOneRelationship","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legacy Team Member relationship. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"master"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the literal wire relationship name."},"children":[]}]}]}]},"service":{"$ref":"#/components/schemas/toOneRelationship"},"resource_instances":{"$ref":"#/components/schemas/toManyRelationship"},"labels":{"$ref":"#/components/schemas/toManyRelationship"},"duration_details":{"$ref":"#/components/schemas/toOneRelationship"}}}}}},"components/schemas/event_collection_response":{"id":"components/schemas/event_collection_response","kind":"json-schema","title":"Event Collection Response","data":{"title":"Event Collection Response","type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/event_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}}}}},"components/schemas/event_create_request":{"id":"components/schemas/event_create_request","kind":"json-schema","title":"Create Event Request","data":{"title":"Create Event Request","type":"object","additionalProperties":false,"required":["team_member_id","service_id","resource_instance_ids","label_ids","date","length","capacity"],"properties":{"team_member_id":{"type":"integer","minimum":1,"description":"Team Member ID"},"service_id":{"type":"integer","minimum":1,"description":"Service ID"},"resource_instance_ids":{"type":"array","description":"Resource Instance IDs; an empty array is allowed","items":{"type":"integer","minimum":1}},"label_ids":{"type":"array","description":"Tag IDs; an empty array is allowed","items":{"type":"integer","minimum":1}},"date":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event start in the Location timezone as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS"},"children":[]}]}]}]},"length":{"type":"integer","minimum":1,"maximum":86400,"multipleOf":300,"description":"Total Event duration in seconds, including any technical break"},"technical_break_duration":{"type":["integer","null"],"minimum":0,"maximum":3600,"multipleOf":300,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break in seconds; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses the Location setting"},"children":[]}]}]}]},"capacity":{"type":"integer","minimum":1,"description":"Total number of available places"},"comment":{"type":"string","minLength":1,"maxLength":255,"description":"Event comment"},"color":{"type":"string","pattern":"^#[0-9a-f]{6}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event color including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]}]}]}]},"instructions":{"type":"string","minLength":1,"maxLength":500,"description":"Instructions for Booking Users"},"stream_link":{"type":"string","minLength":1,"description":"Online Event stream link"},"force":{"type":"boolean","default":false,"description":"Skip Team Member and Resource Instance availability conflicts"}}}},"components/schemas/event_item_response":{"id":"components/schemas/event_item_response","kind":"json-schema","title":"Event Item Response","data":{"title":"Event Item Response","type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/event_resource"},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"array","maxItems":0,"description":"Empty JSON array returned for an Event item"}}}},"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/event_update_request":{"id":"components/schemas/event_update_request","kind":"json-schema","title":"Update Event Request","data":{"title":"Update Event Request","type":"object","additionalProperties":false,"required":["team_member_id","service_id","resource_instance_ids","label_ids","date","length","capacity"],"properties":{"team_member_id":{"type":"integer","minimum":1,"description":"Team Member ID"},"service_id":{"type":"integer","minimum":1,"description":"Service ID"},"resource_instance_ids":{"type":"array","description":"Resource Instance IDs; an empty array is allowed","items":{"type":"integer","minimum":1}},"label_ids":{"type":"array","description":"Tag IDs; an empty array is allowed","items":{"type":"integer","minimum":1}},"date":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event start in the Location timezone as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD HH:MM:SS"},"children":[]}]}]}]},"length":{"type":"integer","minimum":1,"maximum":86400,"multipleOf":300,"description":"Total Event duration in seconds, including any technical break"},"technical_break_duration":{"type":["integer","null"],"minimum":0,"maximum":3600,"multipleOf":300,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical break in seconds; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keeps or derives the current value"},"children":[]}]}]}]},"capacity":{"type":"integer","minimum":1,"description":"Total number of available places"},"comment":{"type":["string","null"],"minLength":1,"maxLength":255,"description":"Event comment"},"color":{"type":["string","null"],"pattern":"^#[0-9a-f]{6}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event color including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]}]}]}]},"instructions":{"type":["string","null"],"minLength":1,"maxLength":500,"description":"Instructions for Booking Users"},"stream_link":{"type":["string","null"],"minLength":1,"description":"Online Event stream link"},"force":{"type":"boolean","default":false,"description":"Skip Team Member and Resource Instance availability conflicts"}}}},"components/schemas/event_appointment_create_request":{"id":"components/schemas/event_appointment_create_request","kind":"json-schema","title":"Create Event Appointment Request","data":{"title":"Create Event Appointment Request","type":"object","additionalProperties":false,"required":["client","clients_count"],"properties":{"client_id":{"type":["integer","null"],"minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated wire field for an existing Booking User ID; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client.id"},"children":[]}]}]}]},"comer_id":{"type":["integer","null"],"minimum":1,"description":"Walk-in visitor ID"},"client":{"type":"object","additionalProperties":false,"required":["id","name","phone","email","surname","patronymic","gender","birthday","custom_field_values","agreements"],"properties":{"id":{"type":["integer","null"],"minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing Booking User ID, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a new Booking User"},"children":[]}]}]}]},"name":{"type":"string","minLength":1,"description":"Booking User first name"},"phone":{"oneOf":[{"type":"string","const":""},{"type":"string","pattern":"^[0-9]{9,15}$"},{"type":"null"}],"description":"Booking User phone number as 9 to 15 digits; an empty string is also accepted"},"email":{"type":["string","null"],"format":"email","description":"Booking User email address"},"surname":{"type":["string","null"],"minLength":1,"description":"Booking User last name"},"patronymic":{"type":["string","null"],"minLength":1,"description":"Literal wire field for a Booking User middle name"},"gender":{"type":["integer","null"],"enum":[0,1,2,null],"description":"Booking User gender wire value"},"birthday":{"type":["string","null"],"format":"date","description":"Booking User birth date"},"custom_field_values":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":false,"required":["code","value"],"properties":{"code":{"type":"string","minLength":1},"value":{"type":"string","minLength":1,"maxLength":255}}}},{"type":"null"}],"description":"Booking User custom fields"},"agreements":{"oneOf":[{"type":"object","additionalProperties":false,"required":["is_newsletter_allowed","is_personal_data_processing_allowed"],"properties":{"is_newsletter_allowed":{"type":"boolean"},"is_personal_data_processing_allowed":{"type":"boolean"}}},{"type":"null"}],"description":"Booking User consent flags"},"comment":{"type":"string","minLength":1,"description":"Booking User comment"},"national_id":{"type":["string","null"],"minLength":1,"description":"Booking User national identifier - the client IIN for locations in Kazakhstan, where it must be 12 digits with a valid check digit. Accepted only for locations in Kazakhstan and ignored for other countries. When omitted or null, the IIN already saved for the client is left unchanged."}}},"comer":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Walk-in visitor name"}}},"clients_count":{"type":"integer","minimum":1,"description":"Number of places reserved by the Appointment"},"is_trial_service":{"type":"boolean","description":"Whether this is a trial Service Appointment"}}}},"components/schemas/event_appointment_item_response":{"id":"components/schemas/event_appointment_item_response","kind":"json-schema","title":"Event Appointment Item Response","data":{"title":"Event Appointment Item Response","type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/appointment_resource"},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"array","maxItems":0,"description":"Empty JSON array returned for an Event Appointment item"}}}},"components/schemas/event_appointment_update_request":{"id":"components/schemas/event_appointment_update_request","kind":"json-schema","title":"Update Event Appointment Request","data":{"title":"Update Event Appointment Request","type":"object","additionalProperties":false,"required":["attendance_service_item"],"properties":{"attendance_service_item":{"type":"object","additionalProperties":false,"required":["cost_per_unit","discount_percent","manual_cost"],"properties":{"cost_per_unit":{"type":"number","minimum":0,"maximum":1000000000},"discount_percent":{"type":"number","minimum":0,"maximum":100},"manual_cost":{"type":"number","minimum":0,"maximum":1000000000},"is_trial":{"type":"boolean","description":"Whether this is a trial Service Appointment"}}},"attendance_good_items":{"type":"array","description":"Literal wire field for Appointment Product Items","items":{"type":"object","additionalProperties":false,"required":["id","good_id","unit_id","storage_id","staff_id","operation_unit_type","number","quantity","cost_per_unit","manual_cost","discount_percent","marks","planned_activation_date"],"properties":{"id":{"type":["integer","null"],"minimum":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment Product Item ID; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" creates an item"},"children":[]}]}]}]},"good_id":{"type":"integer","minimum":1,"description":"Literal wire field for Product ID"},"unit_id":{"type":"integer","minimum":1,"description":"Unit ID"},"storage_id":{"type":"integer","minimum":1,"description":"Inventory Location ID"},"staff_id":{"type":"integer","minimum":1,"description":"Team Member ID"},"operation_unit_type":{"type":"string","enum":["sale","consumable"],"description":"Product operation type"},"number":{"type":["string","null"],"minLength":1,"maxLength":32},"quantity":{"type":"number","minimum":0.001,"maximum":1000000000},"cost_per_unit":{"type":"number","minimum":0,"maximum":1000000000},"manual_cost":{"type":"number","minimum":0,"maximum":1000000000},"discount_percent":{"type":"number","minimum":0,"maximum":100},"marks":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256}},"planned_activation_date":{"type":["string","null"],"format":"date"}}}},"comment":{"type":["string","null"],"maxLength":255,"description":"Appointment comment"},"label_ids":{"type":["array","null"],"description":"Tag IDs","items":{"type":"integer","minimum":1}},"color":{"type":["string","null"],"pattern":"^[0-9a-f]{6}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment color without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#"},"children":[]}]}]}]},"clients_count":{"type":["integer","null"],"minimum":1,"description":"Number of places reserved by the Appointment"}}}},"components/schemas/event_appointment_reschedule_request":{"id":"components/schemas/event_appointment_reschedule_request","kind":"json-schema","title":"Reschedule Event Appointment Request","data":{"title":"Reschedule Event Appointment Request","type":"object","additionalProperties":false,"required":["reschedule_activity_id"],"properties":{"reschedule_activity_id":{"type":"integer","minimum":1,"description":"Literal wire field for the destination Event ID"},"with_comer":{"type":"boolean","description":"Whether to retain the linked walk-in visitor"},"comment":{"type":["string","null"],"maxLength":255,"description":"Appointment comment"},"clients_count":{"type":["integer","null"],"minimum":1,"description":"Number of places reserved by the Appointment"}}}},"components/schemas/booking_user_include":{"id":"components/schemas/booking_user_include","kind":"json-schema","title":"Booking User Includes","data":{"title":"Booking User Includes","type":"array","uniqueItems":true,"items":{"type":"string","enum":["labels","first_successful_visit","loyalty_cards","loyalty_certificates","loyalty_abonements","custom_field_values","agreements"]}}},"components/schemas/booking_user_resource":{"id":"components/schemas/booking_user_resource","kind":"json-schema","title":"Booking User Resource","data":{"title":"Booking User Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"client","description":"Literal legacy JSON:API resource type for a Booking User"},"id":{"type":"string","description":"Booking User profile ID"},"attributes":{"type":"object","additionalProperties":false,"required":["name","surname","patronymic","phone","additional_phone","email","comment","client_tips","birthday","card_number","gender","discount","discount_percent","national_id"],"properties":{"name":{"type":"string","description":"Booking User first name"},"surname":{"type":"string","description":"Booking User surname, subject to Business User permissions"},"patronymic":{"type":"string","description":"Booking User patronymic, subject to Business User permissions"},"phone":{"type":"string","description":"Booking User phone number, subject to Business User permissions"},"additional_phone":{"type":"string","description":"Additional phone number, or an empty string"},"email":{"type":"string","description":"Email address, or an empty string"},"comment":{"type":"string","description":"Booking User card comment, subject to Business User permissions"},"client_tips":{"type":"boolean","description":"Whether the Booking User can leave tips"},"birthday":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Birthday without a timezone, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"card_number":{"type":"string","description":"Booking User card number, or an empty string"},"gender":{"type":"integer","description":"Literal gender wire value"},"discount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated discount percentage; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount_percent"},"children":[]}]}]}]},"discount_percent":{"type":"number","description":"Booking User discount percentage"},"national_id":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"National ID of the Booking User (CPF for Brazil, IIN for Kazakhstan), subject to Business User permissions; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not set or hidden"},"children":[]}]}]}]}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"labels":{"$ref":"#/components/schemas/toManyRelationship"},"first_successful_visit":{"$ref":"#/components/schemas/toOneRelationship"},"loyalty_cards":{"$ref":"#/components/schemas/toManyRelationship"},"loyalty_certificates":{"$ref":"#/components/schemas/toManyRelationship"},"loyalty_abonements":{"$ref":"#/components/schemas/toManyRelationship"},"custom_field_values":{"$ref":"#/components/schemas/toManyRelationship"},"agreements":{"$ref":"#/components/schemas/toOneRelationship"}}}}}},"components/schemas/statistics_attributes":{"id":"components/schemas/statistics_attributes","kind":"json-schema","title":"Booking User Attendance Statistics Attributes","data":{"title":"Booking User Attendance Statistics Attributes","type":"object","required":["successful_attendances_count","failed_attendances_count","balance_amount","spent_amount","paid_amount","last_successful_attendance_datetime"],"properties":{"company_id":{"type":"integer","description":"Location ID; present only in Location statistics"},"successful_attendances_count":{"type":"integer","minimum":0,"description":"Number of successful attendances"},"failed_attendances_count":{"type":"integer","minimum":0,"description":"Number of failed attendances"},"balance_amount":{"type":"number","description":"Current balance"},"spent_amount":{"type":"number","description":"Total spent amount"},"paid_amount":{"type":"number","description":"Total paid amount"},"last_successful_attendance_datetime":{"type":["string","null"],"pattern":"^\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}$","description":"Last successful attendance in the Location timezone"}}}},"components/schemas/statistics_relationships":{"id":"components/schemas/statistics_relationships","kind":"json-schema","title":"Booking User Attendance Statistics Relationships","data":{"title":"Booking User Attendance Statistics Relationships","type":"object","additionalProperties":false,"required":["deposits"],"properties":{"deposits":{"$ref":"#/components/schemas/toManyRelationship"}}}},"components/schemas/location_attendance_statistics_resource":{"id":"components/schemas/location_attendance_statistics_resource","kind":"json-schema","title":"Booking User Location Attendance Statistics Resource","data":{"title":"Booking User Location Attendance Statistics Resource","type":"object","additionalProperties":false,"required":["type","id","attributes","relationships"],"properties":{"type":{"type":"string","const":"client_attendances_statistic","description":"Literal legacy JSON:API resource type for Location statistics"},"id":{"type":"string","description":"Compound Booking User and Location identifier"},"attributes":{"allOf":[{"$ref":"#/components/schemas/statistics_attributes"},{"type":"object","required":["company_id"]}]},"relationships":{"$ref":"#/components/schemas/statistics_relationships"}}}},"components/schemas/deposit_resource":{"id":"components/schemas/deposit_resource","kind":"json-schema","title":"Booking User Deposit Resource","data":{"title":"Booking User Deposit Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"timetable_deposit"},"id":{"type":"string","description":"Deposit ID"},"attributes":{"type":"object","additionalProperties":false,"required":["title","balance","reserved_balance","available_balance"],"properties":{"title":{"type":"string","description":"Deposit name"},"balance":{"type":"number","description":"Total balance"},"reserved_balance":{"type":"number","description":"Reserved balance"},"available_balance":{"type":"number","description":"Available balance after reservations"}}}}}},"components/schemas/chain_attendance_statistics_resource":{"id":"components/schemas/chain_attendance_statistics_resource","kind":"json-schema","title":"Booking User Chain Attendance Statistics Resource","data":{"title":"Booking User Chain Attendance Statistics Resource","type":"object","additionalProperties":false,"required":["type","id","attributes","relationships"],"properties":{"type":{"type":"string","const":"client_chain_attendances_statistic","description":"Literal legacy JSON:API resource type for Chain statistics"},"id":{"type":"string","description":"Compound Booking User and Chain identifier"},"attributes":{"allOf":[{"$ref":"#/components/schemas/statistics_attributes"},{"type":"object","required":["chain_id"],"properties":{"chain_id":{"type":"integer","description":"Chain ID"}}}]},"relationships":{"$ref":"#/components/schemas/statistics_relationships"}}}},"components/schemas/custom_field_resource":{"id":"components/schemas/custom_field_resource","kind":"json-schema","title":"Custom Field Resource","data":{"title":"Custom Field Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"custom_field","description":"Literal JSON:API resource type"},"id":{"type":"string","description":"Location Custom Field ID"},"attributes":{"type":"object","additionalProperties":false,"required":["code","slug","parent_entity_type","entity_slug","relation_entity_type","show_in_ui","is_visible","title","user_can_edit","is_editable","is_required","weight","values"],"properties":{"code":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated Custom Field key; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slug"},"children":[]}]}]}]},"slug":{"type":"string","description":"Custom Field key used in API payloads"},"parent_entity_type":{"type":"string","enum":["record","client"],"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated entity wire value; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_slug"},"children":[]}]}]}]},"entity_slug":{"type":"string","enum":["record","client"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entity wire value. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means Appointment and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking User."},"children":[]}]}]}]},"relation_entity_type":{"type":"null","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reserved wire field; currently always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"show_in_ui":{"type":"boolean","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated visibility flag; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_visible"},"children":[]}]}]}]},"is_visible":{"type":"boolean","description":"Whether the Custom Field is visible in Altegio interfaces"},"title":{"type":"string","description":"Custom Field name"},"user_can_edit":{"type":"boolean","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated editability flag; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_editable"},"children":[]}]}]}]},"is_editable":{"type":"boolean","description":"Whether Business Users can edit the Custom Field value"},"is_required":{"type":"boolean","description":"Whether a value is required"},"weight":{"type":["integer","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display order; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no order is set"},"children":[]}]}]}]},"values":{"type":"array","description":"Configured values for list-like Custom Fields","items":{}}}},"relationships":{"type":"object","additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when related data is requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"properties":{"custom_field_type":{"$ref":"#/components/schemas/toOneRelationship"},"type":{"$ref":"#/components/schemas/toOneRelationship"},"ui_options":{"$ref":"#/components/schemas/toManyRelationship"}}}}}},"components/schemas/custom_field_type_resource":{"id":"components/schemas/custom_field_type_resource","kind":"json-schema","title":"Custom Field Type Resource","data":{"title":"Custom Field Type Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"custom_field_type"},"id":{"type":"string","description":"Custom Field Type ID"},"attributes":{"type":"object","additionalProperties":false,"required":["code","slug","title"],"properties":{"code":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated type key; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slug"},"children":[]}]}]}]},"slug":{"type":"string","description":"Custom Field Type key"},"title":{"type":"string","description":"Custom Field Type name"}}}}}},"components/schemas/custom_field_ui_option_resource":{"id":"components/schemas/custom_field_ui_option_resource","kind":"json-schema","title":"Custom Field UI Option Resource","data":{"title":"Custom Field UI Option Resource","type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"custom_field_ui_option"},"id":{"type":"string","description":"Custom Field UI Option ID"},"attributes":{"type":"object","additionalProperties":false,"required":["slug","value"],"properties":{"slug":{"type":"string","description":"UI Option key"},"value":{"type":"boolean","description":"Whether the UI Option is enabled"}}}}}},"components/schemas/tag_attributes":{"id":"components/schemas/tag_attributes","kind":"json-schema","title":"tag_attributes","data":{"type":"object","description":"Tag attributes (v2 API JSON:API format)","additionalProperties":false,"properties":{"company_id":{"type":"integer","description":"Location ID","example":68570},"title":{"type":"string","description":"Tag name","example":"VIP Booking User"},"color":{"type":"string","description":"Tag background color in","example":"#ff2828"},"font_color":{"type":"string","description":"Tag font color in","example":"#ffffff"},"icon":{"type":"string","description":"Icon name","example":"star"},"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":"Literal entity alias. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identifies Booking Users and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identifies Appointments."},"children":[]}]}]}],"enum":["common","client","record","activity"],"example":"client"},"is_deleted":{"type":"boolean","description":"Whether the Tag is deleted","example":false},"is_editable":{"type":"boolean","description":"Whether the Tag can be updated or deleted","example":true},"salon_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated wire field for Location ID; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_id"},"children":[]}]}]}],"deprecated":true,"example":68570},"entity":{"type":"integer","description":"Deprecated numeric entity type: 0 general, 1 Booking User, 2 Appointment, 3 Event","deprecated":true,"example":1},"entity_slug":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated literal entity alias; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_type"},"children":[]}]}]}],"deprecated":true,"example":"client"},"deleted":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated deletion wire value; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_deleted"},"children":[]}]}]}],"deprecated":true,"example":0},"not_editable":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated editability wire value; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_editable"},"children":[]}]}]}],"deprecated":true,"example":0}},"required":["company_id","title","color","entity_type","is_deleted","is_editable"]}},"schema_445":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","minimum":1}},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":250,"default":250},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["resources","service_composite","resource_links","company_links","trial_settings"]}},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"string","default":"application/vnd.api.v2+json"},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"type":"string"},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/service_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}}}},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/service_resource"},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"array","maxItems":0}}},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/service_category_resource"}}}},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"type":"string","minLength":3},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"type":"integer","enum":[0,1]},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/attendance_service_resource"}},"meta":{"type":"object","additionalProperties":false,"required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/pagination"}}}}},"id":"schema_458"},"schema_459":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/attendance_service_resource"}}}},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["attendance_service","record"]}},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/attendance_service_suggestion_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"oneOf":[{"$ref":"#/components/schemas/attendance_service_resource"},{"$ref":"#/components/schemas/includedResource"}]}}}},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/unit_resource"}}}},"id":"schema_462"},"schema_463":{"kind":"json-schema","data":{"type":"array","minItems":1,"items":{"type":"integer","minimum":1}},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"type":"string","enum":["common","loyalty_abonement","loyalty_certificate"],"default":"common"},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["loyalty_abonement_type","loyalty_certificate_type","mark_settings","actual_cost"]}},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/product_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"object","additionalProperties":false,"required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/pagination"}}}}},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"type":"string","minLength":2},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["loyalty_abonement_type","loyalty_certificate_type","mark_settings"]}},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["loyalty_abonement_type","loyalty_certificate_type","mark_settings","storage_amounts","actual_cost"]}},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/product_resource"},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"array","maxItems":0}}},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["storage"]}},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/storage_amount_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Storage resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}}}},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["child_categories","goods"]}},"id":"schema_474"},"schema_475":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/product_category_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}}}},"id":"schema_475"},"schema_476":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/product_category_resource"},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"array","maxItems":0}}},"id":"schema_476"},"schema_477":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["good","staff","storage_amount","loyalty_abonement","loyalty_certificate","marks"]}},"id":"schema_477"},"schema_478":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/attendance_product_item_resource"},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"array","maxItems":0}}},"id":"schema_478"},"schema_479":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_479"},"schema_480":{"kind":"json-schema","data":{"type":"integer","minimum":0},"id":"schema_480"},"schema_481":{"kind":"json-schema","data":{"type":"integer","enum":[0,1,2],"default":2},"id":"schema_481"},"schema_482":{"kind":"json-schema","data":{"type":"integer","enum":[0,1,2],"default":0},"id":"schema_482"},"schema_483":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["position","employee"]}},"id":"schema_483"},"schema_484":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/team_member_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"oneOf":[{"$ref":"#/components/schemas/position_resource"},{"$ref":"#/components/schemas/employment_profile_resource"}]}}}},"id":"schema_484"},"schema_485":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/team_member_position_resource"}}}},"id":"schema_485"},"schema_486":{"kind":"json-schema","data":{"type":"string","const":"application/json"},"id":"schema_486"},"schema_487":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","minLength":1,"maxLength":100,"description":"Position title"},"description":{"type":"string","maxLength":1000,"description":"Position description"}}},"id":"schema_487"},"schema_488":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/team_member_position_resource"},"meta":{"type":"array","items":{"type":"object"}}}},"id":"schema_488"},"schema_489":{"kind":"json-schema","data":{"type":"string","pattern":"^(record|visit)_[0-9]+$","example":"record_12345"},"id":"schema_489"},"schema_490":{"kind":"json-schema","data":{"$ref":"#/components/schemas/include"},"id":"schema_490"},"schema_491":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/appointment_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}}}},"id":"schema_491"},"schema_492":{"kind":"json-schema","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","example":"2026-01-01T00:00:00"},"id":"schema_492"},"schema_493":{"kind":"json-schema","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$","example":"2026-01-31T23:59:59"},"id":"schema_493"},"schema_494":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/appointment_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"object","additionalProperties":false,"required":["pagination"],"properties":{"pagination":{"$ref":"#/components/schemas/pagination"}}}}},"id":"schema_494"},"schema_495":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["appointmentId"],"properties":{"appointmentId":{"type":"integer","minimum":1,"description":"Appointment ID"}}},"id":"schema_495"},"schema_496":{"kind":"json-schema","data":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"},"id":"schema_496"},"schema_497":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/resource_occupation_resource"}}}},"id":"schema_497"},"schema_498":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$","example":"2026-08-01 09:00:00"},"id":"schema_498"},"schema_499":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$","example":"2026-08-07 21:00:00"},"id":"schema_499"},"schema_500":{"kind":"json-schema","data":{"$ref":"#/components/schemas/event_include"},"id":"schema_500"},"schema_501":{"kind":"json-schema","data":{"type":"string","example":"2026-07-16 00:00:00"},"id":"schema_501"},"schema_502":{"kind":"json-schema","data":{"type":"string","example":"2026-07-31 23:59:59"},"id":"schema_502"},"schema_503":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","description":"One JSON:API resource per date that has at least one matching event","items":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","example":"activity_date"},"id":{"type":"string","format":"date","example":"2026-07-18"},"attributes":{"type":"object","required":["date"],"properties":{"date":{"type":"string","format":"date","example":"2026-07-18"}}}}}}}},"id":"schema_503"},"schema_504":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","example":"activity_dates_range"},"id":{"type":"string","description":"Location ID","example":"123"},"attributes":{"type":"object","required":["min_date","max_date"],"properties":{"min_date":{"type":["string","null"],"format":"date","example":"2026-07-18"},"max_date":{"type":["string","null"],"format":"date","example":"2026-07-29"}}}}},"meta":{"type":"array","maxItems":0,"description":"Empty JSON array"}}},"id":"schema_504"},"schema_505":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"activity_filter"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":true},"relationships":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wire relationship named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" member is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in list responses"},"children":[]}]}]}],"example":{"data":{"data":null}}}}}}}},"id":"schema_505"},"schema_506":{"kind":"json-schema","data":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"activity_duplication_strategy"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":true}}}}}},"id":"schema_506"},"schema_507":{"kind":"json-schema","data":{"type":"object","required":["title","repeat_mode_id"],"properties":{"title":{"type":"string","maxLength":50},"repeat_mode_id":{"type":"integer","minimum":1,"maximum":7},"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"interval":{"type":"integer","minimum":0},"content_type":{"type":"integer","enum":[1,2]}}},"id":"schema_507"},"schema_508":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"activity_duplication_strategy"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":true}}},"meta":{"type":"array","maxItems":0,"description":"Empty JSON array"}}},"id":"schema_508"},"schema_509":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string","maxLength":50},"repeat_mode_id":{"type":"integer","minimum":1,"maximum":7},"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6}},"interval":{"type":"integer","minimum":0},"content_type":{"type":"integer","enum":[1,2]}}},"id":"schema_509"},"schema_510":{"kind":"json-schema","data":{"type":"object","required":["dates"],"properties":{"dates":{"type":"array","minItems":1,"maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every item must be ISO 8601 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-07-20T10:00:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-07-20T10:00:00+0300"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); one invalid date rejects the whole request with 422"},"children":[]}]}]}],"items":{"type":"string","format":"date-time","example":"2026-07-20T10:00:00"}},"content_type":{"type":"integer","enum":[1,2],"default":1},"force":{"type":"boolean","default":false}}},"id":"schema_510"},"schema_511":{"kind":"json-schema","data":{"type":"object","required":["records"],"properties":{"records":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","properties":{"client_id":{"type":"integer","minimum":0},"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string","format":"email"},"clients_count":{"type":"integer","minimum":0,"default":1},"send_sms_now":{"type":"integer"},"sms_hour":{"type":"integer"},"email_hour":{"type":"integer"}}}}}},"id":"schema_511"},"schema_512":{"kind":"json-schema","data":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created appointments as JSON:API "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources, same attributes as the single appointment creation"},"children":[]}]}]}],"items":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","example":"record"},"id":{"type":"string","example":"624798251"},"attributes":{"type":"object"}}}},"meta":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","description":"Records that were not created; the others are created regardless","items":{"type":"object","required":["index","phone","name","error"],"properties":{"index":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position of the record in the request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array"},"children":[]}]}]}],"example":1},"phone":{"type":["string","null"]},"name":{"type":["string","null"]},"error":{"type":"string","description":"Localized reason"}}}}}}}},"id":"schema_512"},"schema_513":{"kind":"json-schema","data":{"$ref":"#/components/schemas/booking_user_include"},"id":"schema_513"},"schema_514":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/booking_user_resource"},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/includedResource"}},"meta":{"type":"array","maxItems":0}}},"id":"schema_514"},"schema_515":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/location_attendance_statistics_resource"},"included":{"type":"array","items":{"$ref":"#/components/schemas/deposit_resource"}},"meta":{"type":"array","maxItems":0}}},"id":"schema_515"},"schema_516":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/chain_attendance_statistics_resource"},"included":{"type":"array","items":{"$ref":"#/components/schemas/deposit_resource"}},"meta":{"type":"array","maxItems":0}}},"id":"schema_516"},"schema_517":{"kind":"json-schema","data":{"type":"string","enum":["record","client"]},"id":"schema_517"},"schema_518":{"kind":"json-schema","data":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["custom_field_type","ui_options"]}},"id":"schema_518"},"schema_519":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/custom_field_resource"}},"included":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources requested through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when available"},"children":[]}]}]}],"items":{"oneOf":[{"$ref":"#/components/schemas/custom_field_type_resource"},{"$ref":"#/components/schemas/custom_field_ui_option_resource"}]}}}},"id":"schema_519"},"schema_520":{"kind":"json-schema","data":{"type":"string","enum":["common","client","record","activity","0","1","2","3"]},"id":"schema_520"},"schema_521":{"kind":"json-schema","data":{"type":"object","additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["type","id","attributes"],"properties":{"type":{"type":"string","const":"tag"},"id":{"type":"string","example":"241625"},"attributes":{"$ref":"#/components/schemas/tag_attributes"}}}}}},"id":"schema_521"},"schema_522":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string"}}}}},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","description":"Error metadata is open by design. Production may add diagnostic\nfields over time, and local development builds may include\nadditional exception details. API consumers should ignore unknown fields.\n","additionalProperties":true,"properties":{"message":{"type":"string","example":"Not found"}}}}},"id":"schema_523"},"schema_524":{"kind":"json-schema","data":{"type":"string","default":"application/json"},"id":"schema_524"},"schema_525":{"kind":"json-schema","data":{"required":["title","color"],"type":"object","properties":{"title":{"type":"string","description":"Tag name","example":"VIP Booking User"},"color":{"type":"string","description":"Tag color in","example":"#ff2828"},"entity":{"type":"integer","description":"Entity type (0 - general, 1 - Booking User, 2 - Appointment, 3 - Event)","enum":[0,1,2,3],"default":0},"icon":{"type":"string","description":"Icon name","example":"star"}}},"id":"schema_525"},"schema_526":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"tag"},"id":{"type":"string","example":"241627"},"attributes":{"$ref":"#/components/schemas/tag_attributes"}}},"meta":{"type":"array","items":{"type":"object"}}}},"id":"schema_526"},"schema_527":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object"}}},"id":"schema_527"},"schema_528":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Required parameter title was not passed. Enter a category name"}}}}},"id":"schema_528"},"schema_529":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","example":"tag"},"id":{"type":"string","example":"241625"},"attributes":{"$ref":"#/components/schemas/tag_attributes"}}},"meta":{"type":"array","items":{"type":"object"}}}},"id":"schema_529"},"schema_530":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Not found"}}}}},"id":"schema_530"},"schema_531":{"kind":"json-schema","data":{"type":"object","properties":{"title":{"type":"string","description":"Tag name","example":"VIP Booking User"},"color":{"type":"string","description":"Tag color in","example":"#ff2828"},"entity":{"type":"integer","description":"Entity type (0 - general, 1 - Booking User, 2 - Appointment, 3 - Event)","enum":[0,1,2,3]},"icon":{"type":"string","description":"Icon name","example":"star"}}},"id":"schema_531"},"schema_532":{"kind":"json-schema","data":{"type":"object","properties":{"success":{"type":"boolean","example":false},"data":{"type":"null"},"meta":{"type":"object","properties":{"message":{"type":"string","example":"Category cannot be changed"}}}}},"id":"schema_532"}},"exampleStore":{"paths/~1locations~1{location_id}~1services/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"service","id":"100","attributes":{"title":"Haircut","category_id":5}}]},"id":"paths/~1locations~1{location_id}~1services/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example":{"value":{"data":{"type":"service","id":"100","attributes":{"title":"Haircut","category_id":5}},"meta":[]},"id":"paths/~1locations~1{location_id}~1services~1{service_id}/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1service_categories/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"service_category","id":"5","attributes":{"title":"Hair Services","salon_service_id":353}}]},"id":"paths/~1locations~1{location_id}~1service_categories/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1attendance_services/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"attendance_service","id":"720441_13245586_0_0","attributes":{"company_id":720441,"service_id":13245586,"category_id":5,"is_composite":false,"composite_service_id":0,"salon_service_id":8842,"composite_position":null,"staff_id":0,"title":"Haircut","length":3600,"duration":3600,"price_min":50,"price_max":75,"technical_break_duration":0}}],"meta":{"pagination":{"page":1,"offset":0,"limit":250}}},"id":"paths/~1locations~1{location_id}~1attendance_services/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"attendance_service","id":"720441_13245587_2969872_13160812_1","attributes":{"company_id":720441,"service_id":13245587,"category_id":5,"is_composite":false,"composite_service_id":13160812,"salon_service_id":8843,"composite_position":1,"staff_id":2969872,"title":"Wash and Cut","length":3600,"duration":3600,"price_min":50,"price_max":50,"technical_break_duration":0}}]},"id":"paths/~1locations~1{location_id}~1composite_services~1{service_id}~1attendance_services/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1attendance_service_suggestions/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"attendance_service_suggestion","id":"13245586","attributes":{"service_id":13245586,"suggestion_type":"master_popular_service","record_id":null}}]},"id":"paths/~1locations~1{location_id}~1attendance_service_suggestions/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1units/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"unit","id":"1","attributes":{"company_id":0,"title":"Piece","short_title":"pc"}}]},"id":"paths/~1locations~1{location_id}~1units/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1products/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"good","id":"100","attributes":{"category_id":5,"title":"Professional Shampoo","sale_unit_id":1,"consumable_unit_id":1,"sale_unit_to_consumable_unit_ratio":1,"loyalty_abonement_type_id":null,"loyalty_certificate_type_id":null,"cost":25.99,"actual_cost":null,"is_chain":false}}],"meta":{"pagination":{"page":1,"offset":0,"limit":250}}},"id":"paths/~1locations~1{location_id}~1products/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1products~1{product_id}/get/responses/200/content/application~1json/example":{"value":{"data":{"type":"good","id":"100","attributes":{"category_id":5,"title":"Professional Shampoo","sale_unit_id":1,"consumable_unit_id":1,"sale_unit_to_consumable_unit_ratio":1,"loyalty_abonement_type_id":null,"loyalty_certificate_type_id":null,"cost":25.99,"actual_cost":null,"is_chain":false}},"meta":[]},"id":"paths/~1locations~1{location_id}~1products~1{product_id}/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"good_storage_amount","id":"100_10","attributes":{"good_id":100,"storage_id":10,"sale_amount":50,"consumable_amount":50}}]},"id":"paths/~1locations~1{location_id}~1products~1{product_id}~1storage_amounts/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1product_categories/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"good_category","id":"5","attributes":{"title":"Hair Care","is_chain":false,"parent_category_id":null}}]},"id":"paths/~1locations~1{location_id}~1product_categories/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/responses/200/content/application~1json/example":{"value":{"data":{"type":"good_category","id":"5","attributes":{"title":"Hair Care","is_chain":false,"parent_category_id":null}},"meta":[]},"id":"paths/~1locations~1{location_id}~1product_categories~1{product_category_id}/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1team_members/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"staff","id":"42","attributes":{"name":"John Smith","tt_markup":15,"specialization":"Senior Stylist","image":"https://cdn.altegio.com/team-members/42.jpg","position_id":5,"is_available_as_assistant":false}}]},"id":"paths/~1locations~1{location_id}~1team_members/get/responses/200/content/application~1json/example"},"paths/~1locations~1{company_id}~1positions/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"position","id":"42","attributes":{"chain_id":5,"title":"Senior Stylist","description":"Senior hair stylist with color specialization","services_binding_type":0,"rules_required_fields":[],"only_chain_appointment":false,"salon_ids":[1,2,3]}}]},"id":"paths/~1locations~1{company_id}~1positions/get/responses/200/content/application~1json/example"},"paths/~1locations~1{company_id}~1positions/post/requestBody/content/application~1json/example":{"value":{"title":"Senior Stylist","description":"Senior hair stylist with color specialization"},"id":"paths/~1locations~1{company_id}~1positions/post/requestBody/content/application~1json/example"},"paths/~1locations~1{company_id}~1positions/post/responses/201/content/application~1json/example":{"value":{"data":{"type":"position","id":"42","attributes":{"chain_id":5,"title":"Senior Stylist","description":"Senior hair stylist with color specialization","services_binding_type":0,"rules_required_fields":[],"only_chain_appointment":false,"salon_ids":[1]}},"meta":[]},"id":"paths/~1locations~1{company_id}~1positions/post/responses/201/content/application~1json/example"},"paths/~1locations~1{company_id}~1positions~1{position_id}/get/responses/200/content/application~1json/example":{"value":{"data":{"type":"position","id":"42","attributes":{"chain_id":5,"title":"Senior Stylist","description":"Senior hair stylist with color specialization","services_binding_type":0,"rules_required_fields":[],"only_chain_appointment":false,"salon_ids":[1,2,3]}},"meta":[]},"id":"paths/~1locations~1{company_id}~1positions~1{position_id}/get/responses/200/content/application~1json/example"},"paths/~1locations~1{company_id}~1positions~1{position_id}/put/requestBody/content/application~1json/example":{"value":{"title":"Senior Stylist Updated","description":"Updated description"},"id":"paths/~1locations~1{company_id}~1positions~1{position_id}/put/requestBody/content/application~1json/example"},"paths/~1locations~1{location_id}~1appointments/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"record","id":"12345","attributes":{"company_id":1,"external_id":"","visit_id":0,"booking_user_id":100,"bookform_id":3,"master_id":42,"staff_id":42,"client_id":500,"comer_id":null,"source":12,"attendance":0,"attendance_status":0,"attendance_status_slug":"waiting","client_fictive_name":null,"client_fictive_phone":null,"client_fictive_email":null,"clients_count":1,"activity_id":0,"custom_color":"","custom_font_color":"","length":3600,"duration":3600,"paid_full":0,"is_paid":false,"is_overpaid":false,"timestamp":1768467600,"date":"2026-01-15T10:00:00","created_datetime":"2026-01-10T15:30:00","from_url":"","is_mobile":0,"comment":"","prepaid_status":0,"record_from":"API","payment_status":null,"is_sale_bill_printed":null,"is_client_notification_sent":false}}],"meta":{"pagination":{"page":1,"offset":0,"limit":250}}},"id":"paths/~1locations~1{location_id}~1appointments/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/requestBody/content/application~1json/example":{"value":{"appointmentId":12345},"id":"paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/requestBody/content/application~1json/example"},"paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/responses/200/content/application~1json/example":{"value":{"data":[]},"id":"paths/~1locations~1{location_id}~1timetable~1appointments~1delete/post/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1resource_occupations/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"resource_occupation","id":"501","attributes":{"source_type":"record","source_type_slug":"record","source_id":7001,"resource_id":90,"resource_instance_id":901,"from":"2026-07-16 13:00:00","to":"2026-07-16 13:30:00"}}]},"id":"paths/~1locations~1{location_id}~1resource_occupations/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1events/post/requestBody/content/application~1json/example":{"value":{"team_member_id":42,"service_id":500,"resource_instance_ids":[],"label_ids":[],"date":"2026-08-01 14:00:00","length":3600,"technical_break_duration":300,"capacity":8,"comment":"Beginner group session","color":"#9c27b0","instructions":"Arrive ten minutes early","stream_link":"https://example.com/event-stream","force":false},"id":"paths/~1locations~1{location_id}~1events/post/requestBody/content/application~1json/example"},"paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/requestBody/content/application~1json/example":{"value":{"client_id":123456,"client":{"id":123456,"name":"John","phone":"13155550175","email":"john@example.com","surname":"Smith","patronymic":null,"gender":1,"birthday":"1990-01-01","custom_field_values":null,"agreements":null},"comer_id":null,"clients_count":1},"id":"paths/~1locations~1{location_id}~1events~1{event_id}~1appointments/post/requestBody/content/application~1json/example"},"paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/requestBody/content/application~1json/example":{"value":{"reschedule_activity_id":12346,"with_comer":true,"clients_count":1},"id":"paths/~1locations~1{location_id}~1events~1{event_id}~1appointments~1{record_id}/patch/requestBody/content/application~1json/example"},"paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/responses/200/content/application~1json/example":{"value":{"data":{"type":"client_attendances_statistic","id":"146915197_720441","attributes":{"company_id":720441,"successful_attendances_count":12,"failed_attendances_count":1,"balance_amount":40,"spent_amount":520,"paid_amount":560,"last_successful_attendance_datetime":"2026-07-15 16:30:00"},"relationships":{"deposits":{"data":[]}}},"meta":[]},"id":"paths/~1locations~1{location_id}~1clients~1{client_id}~1attendances_statistic/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/responses/200/content/application~1json/example":{"value":{"data":{"type":"client_chain_attendances_statistic","id":"146915197_706028","attributes":{"chain_id":706028,"successful_attendances_count":20,"failed_attendances_count":2,"balance_amount":40,"spent_amount":880,"paid_amount":920,"last_successful_attendance_datetime":"2026-07-15 16:30:00"},"relationships":{"deposits":{"data":[]}}},"meta":[]},"id":"paths/~1locations~1{location_id}~1clients~1{client_id}~1chain_attendances_statistic~1{chain_id}/get/responses/200/content/application~1json/example"},"paths/~1locations~1{location_id}~1custom_fields/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"custom_field","id":"81","attributes":{"code":"preferred_color","slug":"preferred_color","parent_entity_type":"client","entity_slug":"client","relation_entity_type":null,"show_in_ui":true,"is_visible":true,"title":"Preferred color","user_can_edit":true,"is_editable":true,"is_required":false,"weight":10,"values":[]}}]},"id":"paths/~1locations~1{location_id}~1custom_fields/get/responses/200/content/application~1json/example"},"paths/~1locations~1{company_id}~1tags/get/responses/200/content/application~1json/example":{"value":{"data":[{"type":"tag","id":"241625","attributes":{"company_id":68570,"title":"VIP Booking User","color":"#ff2828","font_color":"#ffffff","icon":"star","entity_type":"client","is_deleted":false,"is_editable":true}},{"type":"tag","id":"241626","attributes":{"company_id":68570,"title":"Regular Booking User","color":"#009800","font_color":"#ffffff","icon":"user","entity_type":"client","is_deleted":false,"is_editable":true}}]},"id":"paths/~1locations~1{company_id}~1tags/get/responses/200/content/application~1json/example"},"paths/~1locations~1{company_id}~1tags/post/responses/201/content/application~1json/example":{"value":{"data":{"type":"tag","id":"241627","attributes":{"company_id":68570,"title":"VIP Booking User","color":"#ff2828","font_color":"#ffffff","icon":"star","entity_type":"client","is_deleted":false,"is_editable":true}},"meta":[]},"id":"paths/~1locations~1{company_id}~1tags/post/responses/201/content/application~1json/example"},"paths/~1locations~1{company_id}~1tags~1{tag_id}/get/responses/200/content/application~1json/example":{"value":{"data":{"type":"tag","id":"241625","attributes":{"company_id":68570,"title":"VIP Booking User","color":"#ff2828","font_color":"#ffffff","icon":"star","entity_type":"client","is_deleted":false,"is_editable":true}},"meta":[]},"id":"paths/~1locations~1{company_id}~1tags~1{tag_id}/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"BearerPartnerUser":{"id":"BearerPartnerUser","type":"http","scheme":"bearer","bearerFormat":"Bearer {PartnerToken}, User {UserToken}"}},"servers":[{"url":"/_mock/en/b2b-v2/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://api.alteg.io/api/v2","description":"Production"}],"specType":"openapi"},"options":{"sortRequiredPropsFirst":true,"mockServer":{"url":"/_mock/en/b2b-v2/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/en/b2b-v2/openapi.json?download"},{"url":"/_bundle/en/b2b-v2/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":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 [v1 user authorization\n     endpoint](../b2b-v1/openapi.yaml#tag/Authentication-B2B/operation/auth) with\n     your Altegio login and password. Use `data.user_token` from the response.\n     No application installation is needed, but that Business User must already\n     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\nNext-generation B2B API with improved design and consistency.\n\n**Base URL:** `https://api.alteg.io/api/v2`\n\n## Status\n\nThis API is in active development. New features and improvements are released here first.\nWe recommend using this API for all new integrations.\n\n## Required Media Type\n\nEvery request must include:\n```\nAccept: application/vnd.api.v2+json\n```\n\nRequests without the v2 media type return `400`. A charset parameter is accepted.\n\n## URL Patterns\n\nLocation-scoped resources use `/locations/{location_id}/...`.\n\nPositions and Tags preserve the literal `company_id` path parameter name for\nSDK compatibility, but its value is the Location identifier. The legacy\n`/companies/{company_id}/positions` and `/companies/{company_id}/tags` paths\nremain accepted as compatibility aliases.\n\nLegacy path segments are accepted as compatibility aliases of the canonical ones:\n`companies` (`locations`), `staff` (`team_members`), `records` (`appointments`),\n`activities` (`events`), `goods` (`products`), `good_categories` (`product_categories`),\n`attendance_good_items` (`attendance_product_items`), and `salon_groups` (`chains`).\nA request through a legacy segment reaches the same handler and additionally returns\n`Deprecation: @1782864000` (2026-07-01T00:00:00Z), `Sunset: Mon, 01 Mar 2027 00:00:00 GMT`,\nand `Link: <https://developer.alteg.io/en/b2b-v3/openapi>; rel=\"deprecation\"`\n([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745),\n[RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)). Canonical URLs do not return these headers.\n\n## Parameter aliases\n\nUse canonical names such as `location_id`, `chain_id`, `team_member_id`,\n`appointment_id`, and `product_id` for top-level query-string and request-body\nparameters. V2 accepts the corresponding legacy names in both directions for\ncompatibility, but canonical names are recommended for new integrations.\n\nAlias expansion is not recursive: nested request fields must use the literal names shown\nby each endpoint. Responses are not transformed and retain their literal wire fields and\nJSON:API resource type values; response schemas and examples show those exact names.\n"}},"baseSlug":"/en/b2b-v2/openapi","routesMapping":{}}