{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"SunLync API Documentation","link":"/","routeSlug":"/","relativePathFromDirectory":"index.md"},{"type":"link","label":"SunLync API (V2) API Definition","link":"/openapi","routeSlug":"/openapi"},{"type":"group","label":"Client","link":"/openapi/client","routeSlug":"/openapi/client","items":[{"label":"Get client details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclientdetails","routeSlug":"/openapi/client/getclientdetails","metadata":{"seo":{"title":"Get client details","description":"Returns basic demographic information for a given client number"}},"httpPath":"/slapi/clients/clientdetails"},{"label":"Get ledger balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclientledgerbalances","routeSlug":"/openapi/client/getclientledgerbalances","metadata":{"seo":{"title":"Get ledger balances","description":"Returns ledger balances for a given client number"}},"httpPath":"/slapi/clients/ledgerbalance"},{"label":"Get communication preferences","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclientcommprefs","routeSlug":"/openapi/client/getclientcommprefs","metadata":{"seo":{"title":"Get communication preferences","description":"Returns communication preferences for a given client number"}},"httpPath":"/slapi/clients/commprefs"},{"label":"Get client memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclientmemberships","routeSlug":"/openapi/client/getclientmemberships","metadata":{"seo":{"title":"Get client memberships","description":"Returns a list of EFT and non-eft memberships for a given client number"}},"httpPath":"/slapi/clients/clientmemberships"},{"label":"Get client packages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclientpackages","routeSlug":"/openapi/client/getclientpackages","metadata":{"seo":{"title":"Get client packages","description":"Returns a list of packages for a given client number"}},"httpPath":"/slapi/clients/clientpackages"},{"label":"Get points balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclientpointsbalance","routeSlug":"/openapi/client/getclientpointsbalance","metadata":{"seo":{"title":"Get points balance","description":"Returns points ledger balances for a given client number"}},"httpPath":"/slapi/clients/pointsbalance"},{"label":"Get client points transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getpointstransactions","routeSlug":"/openapi/client/getpointstransactions","metadata":{"seo":{"title":"Get client points transactions","description":"Returns a list of points transactions for a given client number and date range"}},"httpPath":"/slapi/clients/getpointstransactions"},{"label":"Get billing info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getbillinginfo","routeSlug":"/openapi/client/getbillinginfo","metadata":{"seo":{"title":"Get billing info","description":"Returns a list of client billing accounts for a given client number"}},"httpPath":"/slapi/clients/billinginfo"},{"label":"Get eft billing amounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/geteftamounts","routeSlug":"/openapi/client/geteftamounts","metadata":{"seo":{"title":"Get eft billing amounts","description":"Returns membership billing amounts"}},"httpPath":"/slapi/clients/geteftamounts"},{"label":"Get eft unfreeze amounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getunfreezeamounts","routeSlug":"/openapi/client/getunfreezeamounts","metadata":{"seo":{"title":"Get eft unfreeze amounts","description":"Returns membership unfreeze amounts"}},"httpPath":"/slapi/clients/getunfreezeamounts"},{"label":"Get eft freeze amounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getfreezeamounts","routeSlug":"/openapi/client/getfreezeamounts","metadata":{"seo":{"title":"Get eft freeze amounts","description":"Returns membership freeze amounts"}},"httpPath":"/slapi/clients/getfreezeamounts"},{"label":"Search clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclientsearch","routeSlug":"/openapi/client/getclientsearch","metadata":{"seo":{"title":"Search clients","description":"Returns a list of clients"}},"httpPath":"/slapi/clients/search"},{"label":"Search for client accross all markets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getmarketsearch","routeSlug":"/openapi/client/getmarketsearch","metadata":{"seo":{"title":"Search for client accross all markets","description":"Returns a list clients from all markets"}},"httpPath":"/slapi/clients/marketsearch"},{"label":"Get client transaction history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getclienttranhistory","routeSlug":"/openapi/client/getclienttranhistory","metadata":{"seo":{"title":"Get client transaction history","description":"Returns a list trasnsactions for a given client number"}},"httpPath":"/slapi/clients/transactionhistory"},{"label":"Get affilicated package clients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getaffiliatedpackageclients","routeSlug":"/openapi/client/getaffiliatedpackageclients","metadata":{"seo":{"title":"Get affilicated package clients","description":"Returns a list of clients sharing an affiliated package by given membership id"}},"httpPath":"/slapi/setup/affiliatedpackageclients"},{"label":"Get shared packages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/getsharedpackages","routeSlug":"/openapi/client/getsharedpackages","metadata":{"seo":{"title":"Get shared packages","description":"Returns a list of packages shared with a client by a given client number"}},"httpPath":"/slapi/clients/getsharedpackages"},{"label":"Insert client","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postinsertclient","routeSlug":"/openapi/client/postinsertclient","metadata":{"seo":{"title":"Insert client","description":"Inserts a client and returns client number"}},"httpPath":"/slapi/clients/insert"},{"label":"Update client demographics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postupdatedemographics","routeSlug":"/openapi/client/postupdatedemographics","metadata":{"seo":{"title":"Update client demographics","description":"Field is only updated if a value is passed"}},"httpPath":"/slapi/clients/updatedemographics"},{"label":"Update billing info","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postupdatebillinginfo","routeSlug":"/openapi/client/postupdatebillinginfo","metadata":{"seo":{"title":"Update billing info","description":"Update billing info for a client"}},"httpPath":"/slapi/clients/updatebillinginfo"},{"label":"Insert client comment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postinsertcomment","routeSlug":"/openapi/client/postinsertcomment","metadata":{"seo":{"title":"Insert client comment","description":"Inserts a client comment"}},"httpPath":"/slapi/clients/insertcomment"},{"label":"Insert client membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postinsertmembership","routeSlug":"/openapi/client/postinsertmembership","metadata":{"seo":{"title":"Insert client membership","description":"Inserts a client membership"}},"httpPath":"/slapi/clients/insertMembership"},{"label":"Insert client package","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postinsertpackage","routeSlug":"/openapi/client/postinsertpackage","metadata":{"seo":{"title":"Insert client package","description":"Inserts a client package"}},"httpPath":"/slapi/clients/insertpackage"},{"label":"Insert gift certificate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postinsertgiftcert","routeSlug":"/openapi/client/postinsertgiftcert","metadata":{"seo":{"title":"Insert gift certificate","description":"Insert Gift Certificate"}},"httpPath":"/slapi/clients/insertgiftcert"},{"label":"Freeze membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/freezemembership","routeSlug":"/openapi/client/freezemembership","metadata":{"seo":{"title":"Freeze membership","description":"Freezes an active eft membership"}},"httpPath":"/slapi/clients/freezemembership"},{"label":"Unfreeze membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/unfreezemembership","routeSlug":"/openapi/client/unfreezemembership","metadata":{"seo":{"title":"Unfreeze membership","description":"Unfreezes a frozen eft membership"}},"httpPath":"/slapi/clients/unfreezemembership"},{"label":"Activate membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/activatemembership","routeSlug":"/openapi/client/activatemembership","metadata":{"seo":{"title":"Activate membership","description":"Activate a membership that is on hold"}},"httpPath":"/slapi/clients/activatemembership"},{"label":"Upgrade membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/upgrademembership","routeSlug":"/openapi/client/upgrademembership","metadata":{"seo":{"title":"Upgrade membership","description":"Upgrades an active eft membership"}},"httpPath":"/slapi/clients/upgrademembership"},{"label":"Downgrade membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/downgrademembership","routeSlug":"/openapi/client/downgrademembership","metadata":{"seo":{"title":"Downgrade membership","description":"Downgrades an active eft membership"}},"httpPath":"/slapi/clients/downgrademembership"},{"label":"Post account ledger payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/postaccountledgerpayment","routeSlug":"/openapi/client/postaccountledgerpayment","metadata":{"seo":{"title":"Post account ledger payment","description":"Post account ledger payment"}},"httpPath":"/slapi/clients/postaccountledgerpayment"},{"label":"Insert points","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/insertpoints","routeSlug":"/openapi/client/insertpoints","metadata":{"seo":{"title":"Insert points","description":"Insert points"}},"httpPath":"/slapi/clients/insertpoints"},{"label":"Update client communication preferences","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/updateclientcommpref","routeSlug":"/openapi/client/updateclientcommpref","metadata":{"seo":{"title":"Update client communication preferences","description":"Update client communication preferences"}},"httpPath":"/slapi/clients/updateclientcommpref"},{"label":"Insert payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/insertpayment","routeSlug":"/openapi/client/insertpayment","metadata":{"seo":{"title":"Insert payment","description":"Inserts a payment"}},"httpPath":"/slapi/clients/insertpayment"},{"label":"Insert transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/inserttransaction","routeSlug":"/openapi/client/inserttransaction","metadata":{"seo":{"title":"Insert transaction","description":"Inserts a transaction"}},"httpPath":"/slapi/clients/inserttransaction"},{"label":"Shares an affiliated package","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/shareaffiliatedpackage","routeSlug":"/openapi/client/shareaffiliatedpackage","metadata":{"seo":{"title":"Shares an affiliated package","description":"Shares an affiliated package"}},"httpPath":"/slapi/clients/shareaffiliatedpackage"},{"label":"Unshares an affiliated package","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/unshareaffiliatedpackage","routeSlug":"/openapi/client/unshareaffiliatedpackage","metadata":{"seo":{"title":"Unshares an affiliated package","description":"Unshares an affiliated package"}},"httpPath":"/slapi/clients/unshareaffiliatedpackage"},{"label":"Cancel membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/cancelmembership","routeSlug":"/openapi/client/cancelmembership","metadata":{"seo":{"title":"Cancel membership","description":"Cancels an active eft membership"}},"httpPath":"/slapi/clients/cancelmembership"},{"label":"Insert spa profile answers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/insertprofileanswers","routeSlug":"/openapi/client/insertprofileanswers","metadata":{"seo":{"title":"Insert spa profile answers","description":"Inserts spa profile answers"}},"httpPath":"/slapi/clients/insertprofileanswers"},{"label":"Add a referral","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/addreferral","routeSlug":"/openapi/client/addreferral","metadata":{"seo":{"title":"Add a referral","description":"Add a referral"}},"httpPath":"/slapi/clients/addreferral"},{"label":"Generate webdoc URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/client/generatewebdocument","routeSlug":"/openapi/client/generatewebdocument","metadata":{"seo":{"title":"Generate webdoc URL","description":"Generates a webdoc URL"}},"httpPath":"/slapi/clients/generatewebdocument"}]},{"type":"group","label":"Configuration","link":"/openapi/configuration","routeSlug":"/openapi/configuration","items":[{"label":"Get packages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/getpackagelist","routeSlug":"/openapi/configuration/getpackagelist","metadata":{"seo":{"title":"Get packages","description":"Returns a list of sellable packages"}},"httpPath":"/slapi/packages/packagelist"},{"label":"Get store list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/getstorelist","routeSlug":"/openapi/configuration/getstorelist","metadata":{"seo":{"title":"Get store list","description":"Returns a list stores"}},"httpPath":"/slapi/stores/storelist"},{"label":"Get eft memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/geteftmembershipslist","routeSlug":"/openapi/configuration/geteftmembershipslist","metadata":{"seo":{"title":"Get eft memberships","description":"Returns a list of sellable EFT memberships"}},"httpPath":"/slapi/memberships/eft"},{"label":"Get non-eft memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/getnoneftmembershipslist","routeSlug":"/openapi/configuration/getnoneftmembershipslist","metadata":{"seo":{"title":"Get non-eft memberships","description":"Returns a list of sellable NON-EFT memberships"}},"httpPath":"/slapi/memberships/noneft"},{"label":"Get eft deduct types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/geteftdeducttypes","routeSlug":"/openapi/configuration/geteftdeducttypes","metadata":{"seo":{"title":"Get eft deduct types","description":"Returns a list EFT deduction types"}},"httpPath":"/slapi/memberships/eftdeducttypes"},{"label":"Get eft draw days","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/geteftdrawdays","routeSlug":"/openapi/configuration/geteftdrawdays","metadata":{"seo":{"title":"Get eft draw days","description":"Returns a list of EFT draw days"}},"httpPath":"/slapi/memberships/eftdrawdays"},{"label":"Get skin types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/skintypes","routeSlug":"/openapi/configuration/skintypes","metadata":{"seo":{"title":"Get skin types","description":"Returns a list of configured skin types"}},"httpPath":"/slapi/setup/skintypes"},{"label":"Get wait list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/getstorewaitlist","routeSlug":"/openapi/configuration/getstorewaitlist","metadata":{"seo":{"title":"Get wait list","description":"Returns a list clients in wait list"}},"httpPath":"/slapi/setup/getstorewaitlist"},{"label":"Get web documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/webdocs","routeSlug":"/openapi/configuration/webdocs","metadata":{"seo":{"title":"Get web documents","description":"Returns a list web documents"}},"httpPath":"/slapi/setup/webdocs"},{"label":"Get payment types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/getpaymenttypes","routeSlug":"/openapi/configuration/getpaymenttypes","metadata":{"seo":{"title":"Get payment types","description":"Returns a list of payment types by given storecode"}},"httpPath":"/slapi/setup/paymenttypes"},{"label":"Get employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/getemployees","routeSlug":"/openapi/configuration/getemployees","metadata":{"seo":{"title":"Get employees","description":"Returns a list of active employees by given storecode"}},"httpPath":"/slapi/setup/employees"},{"label":"Get products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/getproducts","routeSlug":"/openapi/configuration/getproducts","metadata":{"seo":{"title":"Get products","description":"Returns a list of products by given storecode"}},"httpPath":"/slapi/setup/getproducts"},{"label":"Get spa profile questions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/profilequestions","routeSlug":"/openapi/configuration/profilequestions","metadata":{"seo":{"title":"Get spa profile questions","description":"Returns a list of profile questions"}},"httpPath":"/slapi/setup/profilequestions"},{"label":"Update inventory on-hand quantity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/configuration/adjustinventoryaftersale","routeSlug":"/openapi/configuration/adjustinventoryaftersale","metadata":{"seo":{"title":"Update inventory on-hand quantity","description":"Reduces a product's on-hand quantity following a sale"}},"httpPath":"/slapi/setup/adjustinventoryaftersale"}]},{"type":"group","label":"User","link":"/openapi/user","routeSlug":"/openapi/user","items":[{"label":"Register user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/postregisteruser","routeSlug":"/openapi/user/postregisteruser","metadata":{"seo":{"title":"Register user","description":"Registers a user and insert a client, returns client number and user"}},"httpPath":"/slapi/users/register"},{"label":"Reset password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/postresetpassword","routeSlug":"/openapi/user/postresetpassword","metadata":{"seo":{"title":"Reset password","description":"Resets a user password"}},"httpPath":"/slapi/users/resetpassword"},{"label":"Login","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/postlogin","routeSlug":"/openapi/user/postlogin","metadata":{"seo":{"title":"Login","description":"Validates a login and logs that the user has logged in"}},"httpPath":"/slapi/users/login"}]}]}