API Explorer
Explore the Inklura platform API surface. Grouped by router, each operation shows its method, path, request body, and response. Enter your credentials below to copy a ready-to-run cURL or send the request live.
Note
Each operation is a live tRPC procedure called at /api/trpc/<router>.<procedure>: mutations via POST (body {"json": <input>}), queries via GET (?input=<json>). The body shown is that json payload; responses are superjson-wrapped. All requests authenticate with a Bearer JWT. See the tRPC guide.
Server: https://manage.inklura.fr · 307 operations · Download the full OpenAPI specification
Credentials & contextStored only in your browser (localStorage) — never sent to the docs site.
auth 12
POST/api/trpc/auth.bridgeOidcBridge Oidc
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsubstringrequiredemailstring · emailrequiredfirstNameanyoptionallastNameanyoptionalnameanyoptionalResponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
userIdstringrequiredemailstringrequiredfirstNamestringrequiredlastNamestringrequirednamestringrequiredroleenumrequiredproStatusenumoptionaltenantIdstringrequiredsiteIdstringrequiredInput (JSON)
GET/api/trpc/auth.canAccessManageCan Access Manage
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
allowedbooleanrequiredGET/api/trpc/auth.getProfileGet Profile
Authentication: Bearer JWT required
Request body
jsonanyrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/auth.getSecretMessageGet Secret Message
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
string
GET/api/trpc/auth.getSessionGet Session
Authentication: Bearer JWT required
Request body
jsonanyrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/auth.getUserInfoGet User Info
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
inputstringrequiredokbooleanrequireduseranyrequiredInput (JSON)
POST/api/trpc/auth.loginLogin
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredpasswordstringrequiredsitestringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/auth.registerRegister
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredpasswordstringrequiredconfirmPasswordstringrequiredfirstNamestringrequiredlastNamestringrequiredisArchitectbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/auth.requestPasswordResetRequest Password Reset
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredResponses
200 Successful response — the `json` result (superjson-wrapped as { result: { data: { json: … } } }).
successbooleanrequiredmessagestringrequiredInput (JSON)
POST/api/trpc/auth.resendVerificationEmailResend Verification Email
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/auth.signupSignup
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredpasswordstringrequiredfirstNamestringrequiredlastNamestringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/auth.verifyEmailVerify Email
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtokenstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
campaigns 14
POST/api/trpc/campaigns.createCampaignCreate Campaign
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredtypestringrequiredsubjectstringoptionalcontentstringoptionalscheduledbooleanrequiredscheduledDateanyoptionaltestModebooleanrequiredtestEmailstring · emailoptionaltemplateIdstringoptionalsegmentIdstringoptionalmarketingCampaignIdstringoptionalchannelTypestringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.createCampaignTagCreate Campaign Tag
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.createCampaignWizardCreate Campaign Wizard
Authentication: Bearer JWT required
Request body
jsonobjectrequiredchannelTypeobjectrequiredchannelTypestringrequiredcampaignobjectoptionalmarketingCampaignIdstringoptionaldetailsobjectrequirednamestringrequiredtypeIdstringoptionalstatusenumrequiredstartDateanyrequiredendDateanyoptionaldescriptionstringoptionaltemplateobjectrequiredtemplateIdstringoptionalsubjectstringrequiredcontentstringrequiredmjmlstringrequiredpreviewTextstringoptionaldataSchemaobjectoptionalaudienceobjectrequiredsegmentsstring[]requiredfiltersobjectoptionalexcludedSegmentsstring[]optionalscheduleobjectrequiredsendTimeenumrequiredscheduledDateanyoptionaltimezonestringrequiredthrottlingobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.deleteCampaignDelete Campaign
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.duplicateCampaignDuplicate Campaign
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/campaigns.getCampaignActivityGet Campaign Activity
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredpagenumberrequiredper_pagenumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/campaigns.getCampaignByIdGet Campaign By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/campaigns.getCampaignsGet Campaigns
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsearchstringrequiredstatusstringoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataany[]optionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionaltotalPagesintegeroptionalInput (JSON)
GET/api/trpc/campaigns.getCampaignTagsGet Campaign Tags
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionaldescriptionanyoptionaltenantIdstringoptionalsiteIdstringoptionalPOST/api/trpc/campaigns.pauseCampaignPause Campaign
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.resumeCampaignResume Campaign
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.sendCampaignSend Campaign
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.simulateActivitySimulate Activity
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/campaigns.updateCampaignUpdate Campaign
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredtypestringrequiredsubjectstringoptionalcontentstringoptionalscheduledbooleanrequiredscheduledDateanyoptionaltestModebooleanrequiredtestEmailstring · emailoptionaltemplateIdstringoptionalsegmentIdstringoptionalmarketingCampaignIdstringoptionalchannelTypestringoptionalidstringrequiredstatusenumoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
clients 18
POST/api/trpc/clients.approveProApprove Pro
Authentication: Bearer JWT required
Request body
jsonobjectrequiredclientIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.createCreate
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredemailstring · emailoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretstringoptionalcodeNafstringoptionaltypeIdstringoptionalarchivedbooleanrequiredisMainRecordbooleanrequiredisProfessionalbooleanrequiredexternalIdstringoptionalmainRecordIdstringoptionaltiersIdanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.deleteAllClientsDelete All Clients
Authentication: Bearer JWT required
Request body
jsonobjectrequiredconfirmationIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.deleteClientDelete Client
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.deleteClientsDelete Clients
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/clients.getClientByIdGet Client By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailstringoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionallastNamestringoptionalfirstNamestringoptionallastUpdatedstringoptionalprestashop_idstringoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionaltypeanyoptionalTiersanyoptionalsentInvoicesany[]optionalreceivedInvoicesany[]optionalreceivedOrdersobject[]optionalidstringoptionalinvoiceNumberstringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcreatedAtstringoptionalinvoiceDatestringoptionaldeliveryDatestringoptionalInput (JSON)
GET/api/trpc/clients.getClientContactsGet Client Contacts
Authentication: Bearer JWT required
Request body
jsonobjectrequiredclientIdstringrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/clients.getClientsByTiersGet Clients By Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstringrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/clients.getClientsGet Clients
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsortstringoptionalsearchanyoptionalcursoranyoptionalfiltersobjectoptionaladvancedFiltersany[]optionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalnamestringoptionalemailstringoptionalphoneanyoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalsiretanyoptionalcodeNafanyoptionalarchivedbooleanoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalisProfessionalbooleanoptionalexternalIdanyoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalcustomInputsobjectoptionaltypeanyoptionalTiersanyoptionalsentInvoicesany[]optionalreceivedInvoicesany[]optionalreceivedOrdersobject[]optionaltotalintegeroptionalpageCountintegeroptionalcolumnsobjectoptionalnameobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaltypeobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalrelationTablestringoptionalrelationLabelFieldstringoptionalrelationColorFieldstringoptionalrelationIconFieldstringoptionalemailobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalphoneobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaladdressobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalzipCodeobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcityobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcountryobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalsiretobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalcodeNafobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalarchivedobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionalisProfessionalobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionalisMainRecordobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionaloptionsobject[]optionalcreatedAtobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalupdatedAtobjectoptionaltypestringoptionallabelstringoptionalrequiredbooleanoptionalsortablebooleanoptionalfilterablebooleanoptionalnextCursorintegeroptionalInput (JSON)
POST/api/trpc/clients.linkContactLink Contact
Authentication: Bearer JWT required
Request body
jsonobjectrequiredclientIdstringrequiredcontactIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/clients.listPendingProList Pending Pro
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredperPagenumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.refuseProRefuse Pro
Authentication: Bearer JWT required
Request body
jsonobjectrequiredclientIdstring · uuidrequiredreasonstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.requestProSignupRequest Pro Signup
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcompanyNamestringrequiredsiretstringrequiredcodeNafanyoptionaladdressstringrequiredzipCodestringrequiredcitystringrequiredfirstNamestringrequiredlastNamestringrequiredroleanyoptionalphonestringrequiredemailstring · emailrequiredpasswordstringrequiredfilierestringrequiredvolumeEstimateanyoptionalmessageanyoptionalnewsletterbooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/clients.searchContactsToLinkSearch Contacts To Link
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsearchstringoptionalpagenumberrequiredper_pagenumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.syncClientsSync Clients
Authentication: Bearer JWT required
Request body
jsonobjectrequiredoffsetnumberrequiredlimitnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.unlinkContactUnlink Contact
Authentication: Bearer JWT required
Request body
jsonobjectrequiredclientIdstringrequiredcontactIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.unlinkTiersUnlink Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/clients.updateClientUpdate Client
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequirednamestringoptionalemailstring · emailoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretstringoptionalcodeNafstringoptionaltypeIdstringoptionalarchivedbooleanoptionalisMainRecordbooleanoptionalisProfessionalbooleanoptionalexternalIdstringoptionalmainRecordIdstringoptionaltiersIdanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
coupons 6
POST/api/trpc/coupons.createCreate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcodestringrequiredtypeenumrequiredvalueintegerrequiredappliesToPlanIdsstring[]requiredappliesToCountryanyoptionalappliesToDurationYearsanyoptionalvalidFromanyoptionalvalidToanyoptionalmaxRedemptionsanyoptionaldescriptionanyoptionalactivebooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/coupons.deleteDelete
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/coupons.getGet
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/coupons.listList
Authentication: Bearer JWT required
Request body
jsonobjectrequiredactiveOnlybooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/coupons.updateUpdate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcodestringoptionaltypeenumoptionalvalueintegeroptionalappliesToPlanIdsstring[]optionalappliesToCountryanyoptionalappliesToDurationYearsanyoptionalvalidFromanyoptionalvalidToanyoptionalmaxRedemptionsanyoptionaldescriptionanyoptionalactivebooleanoptionalidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/coupons.validateValidate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcodestringrequiredcountryenumrequireditemsobject[]requiredplanIdstringrequiredkindenumrequireddurationYearsintegeroptionallineTotalnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
helpdeskKb 10
POST/api/trpc/helpdeskKb.createArticleCreate Article
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtitlestringrequiredslugstringoptionalexcerptstringoptionalbodystringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdanyoptionaltagsstring[]optionalseoTitlestringoptionalseoDescriptionstringoptionalordernumberoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/helpdeskKb.createCategoryCreate Category
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredslugstringoptionaldescriptionstringoptionaliconstringoptionalparentIdanyoptionalordernumberoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/helpdeskKb.deleteArticleDelete Article
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/helpdeskKb.deleteCategoryDelete Category
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/helpdeskKb.getArticleByIdGet Article By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/helpdeskKb.getArticlesGet Articles
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsearchstringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdstringoptionalincludeArchivedbooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/helpdeskKb.getCategoriesGet Categories
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/helpdeskKb.getCategoryByIdGet Category By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/helpdeskKb.updateArticleUpdate Article
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtitlestringoptionalslugstringoptionalexcerptstringoptionalbodystringoptionalstatusstringoptionalvisibilitystringoptionalcategoryIdanyoptionaltagsstring[]optionalseoTitlestringoptionalseoDescriptionstringoptionalordernumberoptionalidstringrequiredarchivedbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/helpdeskKb.updateCategoryUpdate Category
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringoptionalslugstringoptionaldescriptionstringoptionaliconstringoptionalparentIdanyoptionalordernumberoptionalidstringrequiredarchivedbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
invoices 26
POST/api/trpc/invoices.convertQuoteConvert Quote
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.createCreditNoteCreate Credit Note
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.createDraftCreate Draft
Authentication: Bearer JWT required
Request body
jsonobjectrequiredreceiverIdstringrequiredinvoiceTypeenumoptionalinvoiceDatestringoptionaldueDatestringoptionalnotesstringoptionalcurrencystringoptionaltemplateIdintegeroptionalitemsobject[]requirednamestringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequiredproductIdstringoptionalproductSkustringoptionaldiscountobjectoptionaltypeenumrequiredvaluenumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.createInvoiceCreate Invoice
Authentication: Bearer JWT required
Request body
jsonobjectrequirednumberstringrequiredclientIdstringrequiredtotalnumberrequireditemsobject[]requireddescriptionstringrequiredquantitynumberrequiredunitPricenumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.createStripeConnectAccountCreate Stripe Connect Account
Authentication: Bearer JWT required
Request body
jsonobjectrequiredrefreshUrlstring · urirequiredreturnUrlstring · urirequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.createStripeConnectLinkCreate Stripe Connect Link
Authentication: Bearer JWT required
Request body
jsonobjectrequiredrefreshUrlstring · urirequiredreturnUrlstring · urirequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.deleteAllInvoicesDelete All Invoices
Authentication: Bearer JWT required
Request body
jsonobjectrequiredconfirmationIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.deleteInvoiceDelete Invoice
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.deleteIssuerProfileDelete Issuer Profile
Authentication: Bearer JWT required
Request body
jsonobjectrequiredscopeobjectrequiredlevelenumrequireddomainIdstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.disconnectStripeDisconnect Stripe
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getClientsForSelectGet Clients For Select
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionalemailstringoptionalGET/api/trpc/invoices.getCrossTenantOverviewGet Cross Tenant Overview
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getCrossTenantPaymentStatusGet Cross Tenant Payment Status
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getDashboardMetricsGet Dashboard Metrics
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
monthlyobject[]optionallabelstringoptionalfactureintegeroptionalencaisseintegeroptionalbyStatusany[]optionalGET/api/trpc/invoices.getEffectiveIssuerProfileGet Effective Issuer Profile
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getInvoiceGet Invoice
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalsenderIdstringoptionalreceiverIdstringoptionalinvoiceLogoanyoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceTypeanyoptionalinvoiceStatusstringoptionaldueDateanyoptionalpurchaseOrderNumberanyoptionalcurrencystringoptionallanguagestringoptionalpaymentInformationobjectoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalshippingDetailsobjectoptionalsubTotalanyoptionaltotalAmountintegeroptionaltotalAmountInWordsstringoptionaladditionalNotesanyoptionalpaymentTermsstringoptionalpaymentMethodanyoptionalsignatureobjectoptionalstartedAtanyoptionalendedAtanyoptionallocationanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalpdfTemplateintegeroptionalpdfFormatanyoptionalcustomInputsanyoptionalfooteranyoptionalsourceanyoptionalemplacementIdanyoptionaltenantIdstringoptionaluserIdanyoptionalsiteIdstringoptionalrecurringInvoiceIdanyoptionaldomainIdanyoptionalissuerProfileIdanyoptionalsequenceKeyanyoptionalissuedAtanyoptionallockedbooleanoptionalitemsany[]optionalreceiverobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalsenderobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalpdfUrlanyoptionalInput (JSON)
GET/api/trpc/invoices.getInvoicesGet Invoices
Authentication: Bearer JWT required
Request body
jsonobjectrequiredlimitnumberrequiredoffsetnumberrequiredstatusstringoptionaltypeenumoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalsenderIdstringoptionalreceiverIdstringoptionalinvoiceLogoanyoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceTypeanyoptionalinvoiceStatusstringoptionaldueDateanyoptionalpurchaseOrderNumberanyoptionalcurrencystringoptionallanguagestringoptionalpaymentInformationobjectoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalshippingDetailsobjectoptionalsubTotalanyoptionaltotalAmountintegeroptionaltotalAmountInWordsstringoptionaladditionalNotesanyoptionalpaymentTermsstringoptionalpaymentMethodanyoptionalsignatureobjectoptionalstartedAtanyoptionalendedAtanyoptionallocationanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalpdfTemplateintegeroptionalpdfFormatanyoptionalcustomInputsanyoptionalfooteranyoptionalsourceanyoptionalemplacementIdanyoptionaltenantIdstringoptionaluserIdanyoptionalsiteIdstringoptionalrecurringInvoiceIdanyoptionaldomainIdanyoptionalissuerProfileIdanyoptionalsequenceKeyanyoptionalissuedAtanyoptionallockedbooleanoptionalreceiverobjectoptionalidstringoptionalnamestringoptionaladdressanyoptionalzipCodeanyoptionalcityanyoptionalcountryanyoptionalemailanyoptionalphoneanyoptionalsiretanyoptionalcodeNafanyoptionalcustomInputsobjectoptionalexternalIdanyoptionalarchivedbooleanoptionalisProfessionalbooleanoptionaltenantIdstringoptionalsiteIdstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalisMainRecordbooleanoptionalmainRecordIdanyoptionaltypeIdanyoptionaltiersIdanyoptionalterritoryIdanyoptionaldataanyoptionalpdfUrlanyoptionalInput (JSON)
GET/api/trpc/invoices.getIssuerProfileGet Issuer Profile
Authentication: Bearer JWT required
Request body
jsonobjectrequiredscopeobjectoptionallevelenumrequireddomainIdstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/invoices.getPaymentSettingsGet Payment Settings
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/invoices.getPublicInvoiceGet Public Invoice
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtokenstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/invoices.listIssuerScopesList Issuer Scopes
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/invoices.saveIssuerProfileSave Issuer Profile
Authentication: Bearer JWT required
Request body
jsonobjectrequiredscopeobjectoptionallevelenumrequireddomainIdstringoptionallegalNamestringrequiredemailstringoptionalphonestringoptionalsiretstringoptionalsirenstringoptionalvatNumberstringoptionalibanstringoptionalbicstringoptionallogoUrlstringoptionalcurrencystringoptionaleditorLayoutenumoptionalpdfTemplateintegeroptionalinvoicePrefixstringoptionalquotePrefixstringoptionalcreditNotePrefixstringoptionallegalMentionsstringoptionaladdressobjectoptionalstreetstringoptionalcitystringoptionalpostalCodestringoptionalcountrystringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.savePaymentKeysSave Payment Keys
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsecretKeystringoptionalpublishableKeystringoptionalenabledbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/invoices.searchProductsSearch Products
Authentication: Bearer JWT required
Request body
jsonobjectrequiredqstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.updateDraftUpdate Draft
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredreceiverIdstringoptionalinvoiceTypeenumoptionalinvoiceDatestringoptionaldueDatestringoptionalnotesstringoptionalcurrencystringoptionaltemplateIdintegeroptionalitemsobject[]requirednamestringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequiredproductIdstringoptionalproductSkustringoptionaldiscountobjectoptionaltypeenumrequiredvaluenumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/invoices.updateInvoiceStatusUpdate Invoice Status
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredstatusstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
newsletter 18
POST/api/trpc/newsletter.addSubscriberAdd Subscriber
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstringrequiredfirstNamestringoptionallastNamestringoptionaltagsstring[]optionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.bulkDeleteBulk Delete
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.bulkUpdateStatusBulk Update Status
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredstatusenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/newsletter.exportSubscribersExport Subscribers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredformatenumrequiredsubscribedOnlybooleanrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
datastringoptionalformatstringoptionalInput (JSON)
GET/api/trpc/newsletter.getAvailableTemplatesGet Available Templates
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtypeenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/newsletter.getGrowthDataGet Growth Data
Authentication: Bearer JWT required
Request body
jsonobjectrequireddaysnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/newsletter.getSettingsGet Settings
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
doubleOptInbooleanoptionalconfirmationEmailTemplateIdanyoptionalconfirmationTokenExpiryintegeroptionalwelcomeEmailEnabledbooleanoptionalwelcomeEmailTemplateIdanyoptionalwelcomeEmailDelayintegeroptionalunsubscribeConfirmationEnabledbooleanoptionalunsubscribeConfirmationTemplateIdanyoptionaladminNotificationEnabledbooleanoptionaladminNotificationEmailstringoptionaladminDigestEnabledbooleanoptionaladminDigestFrequencystringoptionaldefaultFromNamestringoptionaldefaultFromEmailstringoptionaldefaultReplyTostringoptionalautoArchiveEnabledbooleanoptionalarchiveVisibilitystringoptionalbrandColorstringoptionalheaderLogoUrlstringoptionalfooterTextstringoptionalGET/api/trpc/newsletter.getStatsGet Stats
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
totalintegeroptionalsubscribedintegeroptionalunsubscribedintegeroptionalthisMonthintegeroptionallastMonthintegeroptionalgrowthPercentintegeroptionalGET/api/trpc/newsletter.getSubscriberGet Subscriber
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalfirstNameanyoptionallastNameanyoptionalnamestringoptionalemailstringoptionalphoneanyoptionalmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalsegmentanyoptionalsourceanyoptionalcreatedAtstringoptionallastActivityanyoptionalInput (JSON)
GET/api/trpc/newsletter.getSubscriptionStatusGet Subscription Status
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.importSubscribersImport Subscribers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsubscribersobject[]requiredemailstring · emailrequiredfirstNamestringoptionallastNamestringoptionalphonestringoptionalduplicateHandlingenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/newsletter.listSubscribersList Subscribers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionalsubscribedbooleanoptionalsortByenumrequiredsortOrderenumrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsobject[]optionalidstringoptionalfirstNameanyoptionallastNameanyoptionalnamestringoptionalemailstringoptionalmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalsegmentanyoptionalsourceanyoptionalsubscribedAtstringoptionallastActivityanyoptionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalpagesintegeroptionalInput (JSON)
POST/api/trpc/newsletter.subscribeSubscribe
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstringrequiredfirstNamestringoptionallastNamestringoptionaltenantIdstringoptionalsiteIdstringoptionalhoneypotstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.testConfirmationEmailTest Confirmation Email
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.testWelcomeEmailTest Welcome Email
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.unsubscribeUnsubscribe
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstringrequiredtokenstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.updateSettingsUpdate Settings
Authentication: Bearer JWT required
Request body
jsonobjectrequireddoubleOptInbooleanoptionalconfirmationEmailTemplateIdanyoptionalconfirmationTokenExpirynumberoptionalwelcomeEmailEnabledbooleanoptionalwelcomeEmailTemplateIdanyoptionalwelcomeEmailDelaynumberoptionalunsubscribeConfirmationEnabledbooleanoptionalunsubscribeConfirmationTemplateIdanyoptionaladminNotificationEnabledbooleanoptionaladminNotificationEmailanyoptionaladminDigestEnabledbooleanoptionaladminDigestFrequencyenumoptionaldefaultFromNamestringoptionaldefaultFromEmailanyoptionaldefaultReplyToanyoptionalautoArchiveEnabledbooleanoptionalarchiveVisibilityenumoptionalbrandColorstringoptionalheaderLogoUrlanyoptionalfooterTextstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/newsletter.updateSubscriberUpdate Subscriber
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredmarketingOptInbooleanoptionalemailOptInbooleanoptionalsmsOptInbooleanoptionalfirstNamestringoptionallastNamestringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
orders 48
POST/api/trpc/orders.createOrderItemCreate Order Item
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequirednamestringrequireddescriptionanyoptionalquantityintegerrequiredunitPricenumberrequiredproductIdanyoptionalvendorIdanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.createOrderCreate Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredinvoiceNumberanyrequiredinvoiceDateanyrequireddeliveryDateanyoptionalinvoiceStatusenumrequiredreceiverIdstringoptionalsenderIdstringoptionalclientIdstringoptionalcurrencystringrequiredtotalAmountnumberrequiredadditionalNotesstringoptionalitemsobject[]requiredproductIdstringoptionalnamestringrequireddescriptionanyoptionalquantityintegerrequiredunitPricenumberrequiredrecalculateVendorsbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.deleteOrderItemDelete Order Item
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.deleteOrderDelete Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.deleteOrdersDelete Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.exportOrdersExport Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredformatenumrequiredfiltersobjectoptionalsearchstringoptionalsortstringoptionaladvancedFiltersany[]optionaladvancedSortsobject[]optionalcolumnsstring[]optionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.fetchOrdersFetch Orders
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/orders.fulfillment.cancelFulfillment.cancel
Authentication: Bearer JWT required
Request body
jsonobjectrequiredfulfillmentIdstring · uuidrequiredreasonstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.fulfillment.createFulfillment.create
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredmethodenumrequireditemsobject[]requiredorderItemIdstring · uuidrequiredquantityintegerrequiredcarrierstringoptionaltrackingNumberstringoptionaltrackingUrlstring · urioptionalestimatedDeliveryanyoptionalshippingAddressobjectoptionalfirstNamestringrequiredlastNamestringrequiredcompanystringoptionaladdressstringrequiredcitystringrequiredpostalCodestringrequiredcountrystringrequiredphonestringoptionalemailstring · emailoptionalinstructionsstringoptionalshipmentIdstring · uuidoptionalnotesstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.fulfillment.listByOrderFulfillment.list By Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.fulfillment.trackFulfillment.track
Authentication: Bearer JWT required
Request body
jsonobjectrequiredfulfillmentIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.fulfillment.updateStatusFulfillment.update Status
Authentication: Bearer JWT required
Request body
jsonobjectrequiredfulfillmentIdstring · uuidrequiredstatusenumrequiredtrackingNumberstringoptionaltrackingUrlstring · urioptionalactualDeliveryanyoptionalnotesstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getCheckoutEventsGet Checkout Events
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getInvoicesGet Invoices
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpageanyrequiredper_pageanyrequiredsearchstringoptionalsortstringoptionalfiltersobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getLiveOrdersGet Live Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredstatusesstring[]optionallimitnumberrequiredsortByenumrequiredsortOrderenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getMyOrdersGet My Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredlimitnumberrequiredcursorstringoptionalstatusstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getOrderByIdGet Order By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalinvoiceNumberstringoptionalreferenceanyoptionalinvoiceDatestringoptionaldeliveryDatestringoptionalorderTypestringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcurrencystringoptionalsourceanyoptionalpaymentIntentIdanyoptionalstripeSessionIdanyoptionalstripeInvoiceIdanyoptionalplenigoOrderIdanyoptionalexpiresAtanyoptionalpaymentMethodanyoptionalsenderIdstringoptionalreceiverIdstringoptionalclientIdstringoptionalcustomInputsobjectoptionalnotestringoptionalvalidstringoptionalstatusstringoptionalcustomerobjectoptionalemailstringoptionallastNamestringoptionalfirstNamestringoptionalreferencestringoptionalpickup_slotanyoptionaldelivery_datestringoptionaldelivery_slotobjectoptionaldaystringoptionalhourstringoptionalcauseanyoptionalmanualbooleanoptionalhour_endstringoptionalremindedbooleanoptionalmanual_commentanyoptionalstore_informedbooleanoptionalprestashop_idstringoptionalinvoice_numberstringoptionalpayment_methodstringoptionalinvoice_addressobjectoptionalcitystringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionallastNamestringoptionalpostcodestringoptionalfirstNamestringoptionaldelivery_addressobjectoptionalcitystringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionallastNamestringoptionalpostcodestringoptionalfirstNamestringoptionaldeliveryDataHistoryobjectoptionalentriesobject[]optionalcreatedAtstringoptionallastUpdatedstringoptionaltenantIdstringoptionalsiteIdstringoptionalappliedVoucherIdanyoptionalsubscriptionIdanyoptionalisRenewalOrderbooleanoptionalrequiresValidationbooleanoptionalvalidatedAtanyoptionalvalidatedByanyoptionalprocessedAtanyoptionalprocessedByanyoptionalitemsobject[]optionalidstringoptionalcreatedAtstringoptionalupdatedAtstringoptionalnamestringoptionaldescriptionstringoptionalquantityintegeroptionalunitPricenumberoptionaldataobjectoptionalexternalOrderIdstringoptionalexternalProductIdstringoptionalexternalVendorIdanyoptionalexternalItemIdstringoptionalorderIdstringoptionalproductIdstringoptionalproductVariationIdanyoptionalvendorIdstringoptionalvoucherDiscountAmountanyoptionalsiteIdstringoptionalproductobjectoptionalvendorobjectoptionalclientobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalphonestringoptionaladdressstringoptionalzipCodestringoptionalcitystringoptionalcountrystringoptionalsiretanyoptionalisProfessionalbooleanoptionalsenderobjectoptionalidstringoptionalnameanyoptionalemailstringoptionalreceiverobjectoptionalidstringoptionalnamestringoptionalemailstringoptionalvendorsany[]optionalInput (JSON)
GET/api/trpc/orders.getOrderItemsGet Order Items
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getOrdersByIdsForProductsGet Orders By Ids For Products
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredproductIdsstring[]optionalincludeItemsbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getOrdersByIdsGet Orders By Ids
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredproductIdstring · uuidoptionalincludeItemsbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getOrdersByProductGet Orders By Product
Authentication: Bearer JWT required
Request body
jsonobjectrequiredproductIdstring · uuidrequiredpageanyrequiredper_pageanyrequiredsearchanyoptionalstatusanyoptionalsortanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getOrdersByVendorGet Orders By Vendor
Authentication: Bearer JWT required
Request body
jsonobjectrequiredvendorIdstring · uuidrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalstatusenumoptionalstatusesstring[]optionaldeliveryDateFromstringoptionaldeliveryDateTostringoptionalsortstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getOrdersGet Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpageanyrequiredper_pageanyrequiredsearchanyoptionalsortanyoptionalfiltersobjectrequiredadvancedFiltersany[]requiredadvancedSortsobject[]requiredfieldstringrequireddirectionenumrequiredfieldsanyoptionalpaymentLinkFilterenumoptionalofflinePaymentFilterenumoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalinvoiceNumberstringoptionalinvoiceDatestringoptionalinvoiceStatusstringoptionaltotalAmountnumberoptionalcurrencystringoptionalcreatedAtstringoptionalupdatedAtstringoptionalpaymentMethodanyoptionalexpiresAtanyoptionaldeliveryDatestringoptionalcustomInputsobjectoptionalsourceanyoptionalreceiverobjectoptionalsenderobjectoptionalclientobjectoptionalvendorsany[]optionalitemsobject[]optionaltotalintegeroptionalpageintegeroptionalpageSizeintegeroptionalpageCountintegeroptionalhasNextPagebooleanoptionalhasPrevPagebooleanoptionalInput (JSON)
GET/api/trpc/orders.getOrderSubscriptionContextGet Order Subscription Context
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getOrderTimersGet Order Timers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdsstring[]optionalactiveOnlybooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getProductsByOrderGet Products By Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredpageanyrequiredper_pageanyrequiredsearchanyoptionalsortanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getRelatedSupplierOrdersGet Related Supplier Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.getUnfulfilledOrdersGet Unfulfilled Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsearchstringoptionallimitnumberoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
ordersobject[]optionalidstringoptionalnumberstringoptionalstatusstringoptionalcustomerNamestringoptionalcustomerobjectoptionalcreatedAtstringoptionalitemsobject[]optionaltotalintegeroptionalInput (JSON)
POST/api/trpc/orders.lifecycle.cancelOrderLifecycle.cancel Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredreleaseStockbooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.lifecycle.confirmOrderPaymentLifecycle.confirm Order Payment
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredpaymentIntentIdstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.lifecycle.expireDraftOrdersLifecycle.expire Draft Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtenantIdstring · uuidoptionalsiteIdstring · uuidoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.lifecycle.getDashboardDataLifecycle.get Dashboard Data
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtimeRangeenumrequiredalertsLimitintegerrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.lifecycle.getLifecycleAlertsLifecycle.get Lifecycle Alerts
Authentication: Bearer JWT required
Request body
jsonobjectrequiredlimitintegerrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.lifecycle.getLifecycleStatsLifecycle.get Lifecycle Stats
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtimeRangeenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.lifecycle.getOrdersExpiringSoonLifecycle.get Orders Expiring Soon
Authentication: Bearer JWT required
Request body
jsonobjectrequiredminutesUntilExpiryintegerrequiredtenantIdstring · uuidoptionalsiteIdstring · uuidoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.markPaidMark Paid
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredpaymentIntentIdstringrequiredpaymentMethodstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.markProcessedMark Processed
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredprocessedbooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.refund.calculateRefund.calculate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequireditemsobject[]optionalorderItemIdstring · uuidrequiredquantityintegerrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.refund.createRefund.create
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequireditemsobject[]optionalorderItemIdstring · uuidrequiredquantityintegerrequiredamountnumberoptionalreasonenumrequiredreasonDescriptionstringoptionalnotesstringoptionalautoApprovebooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.refund.executeRefund.execute
Authentication: Bearer JWT required
Request body
jsonobjectrequiredrefundIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/orders.refund.listByOrderRefund.list By Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.refund.processRefund.process
Authentication: Bearer JWT required
Request body
jsonobjectrequiredrefundIdstring · uuidrequiredapprovebooleanrequirednotesstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.syncOrderSync Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.updateKitchenStatusUpdate Kitchen Status
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredkitchenStatusenumrequirednotesstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.updateOrderItemUpdate Order Item
Authentication: Bearer JWT required
Request body
jsonobjectrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.updateOrderUpdate Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredinvoiceNumberanyrequiredinvoiceDateanyoptionaldeliveryDateanyoptionalinvoiceStatusenumoptionalreceiverIdanyoptionalsenderIdanyoptionalclientIdanyoptionalvendorIdsstring[]optionalcurrencystringoptionaltotalAmountnumberoptionaladditionalNotesstringoptionalitemsobject[]optionalidstringoptionalproductIdstringoptionalnamestringrequireddescriptionanyoptionalquantityintegerrequiredunitPricenumberrequiredrecalculateVendorsbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.updateStatusUpdate Status
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredstatusenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/orders.validateOrderValidate Order
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
payments 24
POST/api/trpc/payments.applyMyUpdatedCardApply My Updated Card
Authentication: Bearer JWT required
Request body
jsonobjectrequiredprintSubscriptionIdstring · uuidrequiredpaymentMethodIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/payments.checkStripeConfigurationCheck Stripe Configuration
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
isConfiguredbooleanoptionalPOST/api/trpc/payments.createEditionCheckoutSessionCreate Edition Checkout Session
Authentication: Bearer JWT required
Request body
jsonobjectrequirededitionIdstring · uuidrequiredorderIdstring · uuidoptionalsuccessUrlstringoptionalcancelUrlstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createMagazineCheckoutSessionCreate Magazine Checkout Session
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsubscriptionPlanIdstring · uuidrequiredsuccessUrlstringoptionalcancelUrlstringoptionalpreviousSubIdstring · uuidoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createMagazinePurchaseCheckoutSessionCreate Magazine Purchase Checkout Session
Authentication: Bearer JWT required
Request body
jsonobjectrequireditemsobject[]requiredidstring · uuidrequiredtitlestringrequiredpricenumberoptionalquantityintegerrequiredformatenumoptionalkindenumoptionaldurationYearsanyoptionalisMonthlybooleanoptionalisGiftbooleanoptionalgiftRecipientobjectoptionalcountryenumrequiredcustomerInfoobjectoptionalcivilitystringoptionalfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredphonestringrequiredcompanystringoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequirednotesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequireddeliveryOptionstringoptionalpaymentMethodstringoptionaltotalsobjectoptionalsubtotalnumberrequireddeliverynumberrequiredtotalnumberrequiredsuccessUrlstringoptionalcancelUrlstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createMyUpdateCardSetupIntentCreate My Update Card Setup Intent
Authentication: Bearer JWT required
Request body
jsonobjectrequiredprintSubscriptionIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createOfflineMagazineCheckoutCreate Offline Magazine Checkout
Authentication: Bearer JWT required
Request body
jsonobjectrequireditemsobject[]requiredidstringrequiredtitlestringoptionalpricenumberoptionalquantityintegerrequiredformatenumoptionalkindenumoptionaldurationYearsanyoptionalisMonthlybooleanoptionalisGiftbooleanoptionalcountryenumrequiredpaymentMethodenumrequiredcustomerInfoobjectrequiredcivilitystringoptionalfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredphonestringrequiredcompanystringoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequirednotesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredtotalsobjectoptionalsubtotalnumberoptionaldeliverynumberoptionaltotalnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createOfflineMagazineSubscriptionCheckoutCreate Offline Magazine Subscription Checkout
Authentication: Bearer JWT required
Request body
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredisMonthlybooleanrequiredcountryenumrequiredpaymentMethodenumrequiredcustomerInfoobjectrequiredcivilitystringoptionalfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredphonestringrequiredcompanystringoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequirednotesstringoptionalbillingInfoobjectoptionaladdressstringrequiredaddress2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createOperatorCardSubscriptionCreate Operator Card Subscription
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtargetContactIdstring · uuidrequiredmagazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequiredmodeenumrequiredstripeCustomerIdstringrequiredpaymentMethodIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createOperatorSetupIntentCreate Operator Setup Intent
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtargetContactIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createPaymentIntentCreate Payment Intent
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createPerIssueCardSetupCheckoutCreate Per Issue Card Setup Checkout
Authentication: Bearer JWT required
Request body
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequiredcustomerEmailstring · emailrequiredcustomerFirstNamestringrequiredcustomerLastNamestringrequiredsuccessUrlstring · urirequiredcancelUrlstring · urirequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createRecurringMagazineSubscriptionCheckoutCreate Recurring Magazine Subscription Checkout
Authentication: Bearer JWT required
Request body
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredcountryenumrequiredintervalstringrequiredintervalCountanyrequiredsuccessUrlstring · urirequiredcancelUrlstring · urirequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createRecurringMagazineSubscriptionLinkForCustomerCreate Recurring Magazine Subscription Link For Customer
Authentication: Bearer JWT required
Request body
jsonobjectrequiredmagazineSubscriptionPlanIdstring · uuidrequiredtargetContactIdstring · uuidrequiredcountryenumrequiredintervalstringrequiredintervalCountanyrequiredsuccessUrlstring · urirequiredcancelUrlstring · urirequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.createVisitCheckoutSessionCreate Visit Checkout Session
Authentication: Bearer JWT required
Request body
jsonobjectrequiredreservationIdstring · uuidrequiredsuccessUrlstringoptionalcancelUrlstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/payments.getCheckoutFunnelGet Checkout Funnel
Authentication: Bearer JWT required
Request body
jsonobjectrequiredfromstringoptionaltostringoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
windowobjectoptionalfromstringoptionaltostringoptionalfunnelobjectoptionalreachedCheckoutintegeroptionalpayClickedintegeroptionalsessionCreatedintegeroptionalcompletedintegeroptionalprocessingintegeroptionalmintedEventsintegeroptionalexpiredintegeroptionalabandonedFrontendintegeroptionalerrorsintegeroptionalrevenueobjectoptionalpaidCountintegeroptionalpaidAmountintegeroptionalcurrencystringoptionalpendingobjectoptionalinflightintegeroptionalabandonedintegeroptionaleventsByKindany[]optionalInput (JSON)
GET/api/trpc/payments.getMagazineCartPricingGet Magazine Cart Pricing
Authentication: Bearer JWT required
Request body
jsonobjectrequireditemsobject[]requiredidstring · uuidrequiredformatenumoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/payments.getPaymentMethodsGet Payment Methods
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionaltypestringoptionalisActivebooleanoptionalGET/api/trpc/payments.getPaymentStatsGet Payment Stats
Authentication: Bearer JWT required
Request body
jsonobjectrequireddateFromanyoptionaldateToanyoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
totalTransactionsintegeroptionaltotalAmountnumberoptionalcompletedTransactionsintegeroptionalfailedTransactionsintegeroptionalpendingTransactionsintegeroptionalprocessingTransactionsintegeroptionalcancelledTransactionsintegeroptionaltotalProcessingFeesnumberoptionalaverageTransactionAmountnumberoptionalInput (JSON)
GET/api/trpc/payments.getStripeConfigurationGet Stripe Configuration
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
secretKeyanyoptionalpublishableKeyanyoptionalisConfiguredbooleanoptionalGET/api/trpc/payments.getTransactionByIdGet Transaction By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/payments.getTransactionsGet Transactions
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpageintegerrequiredper_pageintegerrequireddateFromanyoptionaldateToanyoptionalstatusenumoptionalpaymentMethodstringoptionalorderIdstring · uuidoptionalcustomerIdstring · uuidoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
transactionsany[]optionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionaltotalPagesintegeroptionalInput (JSON)
GET/api/trpc/payments.listAbandonedCheckoutsList Abandoned Checkouts
Authentication: Bearer JWT required
Request body
jsonobjectrequiredstateenumrequiredlimitnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/payments.updateStripeConfigurationUpdate Stripe Configuration
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsecretKeystringrequiredpublishableKeystringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
products 27
POST/api/trpc/products.assignSubCategoryToProductAssign Sub Category To Product
Authentication: Bearer JWT required
Request body
jsonobjectrequiredproductIdstring · uuidrequiredsubCategoryIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.bulkUpdateBulk Update
Authentication: Bearer JWT required
Request body
jsonobjectrequiredupdatesobject[]requiredidstring · uuidrequirednamestringoptionaldescriptionstringoptionalreferencestringoptionalmanufacturerstringoptionalactivebooleanoptionalpricenumberoptionalproPriceanyoptionaltaxRatenumberoptionalisBuyablebooleanoptionalpackagingQuantitynumberoptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionalstockintegeroptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionaldataPatchobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/products.byPackagingTypeBy Packaging Type
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpackagingTypeIdstringrequiredpagenumberrequiredlimitnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.clearProductsCacheClear Products Cache
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/products.createCreate
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequireddescriptionstringoptionalpricenumberrequiredproPriceanyoptionalreferencestringoptionalmanufacturerstringoptionaltaxRatenumberrequireddefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantitynumberoptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdstringoptionalisBuyablebooleanrequiredactivebooleanrequiredmainImageIdanyoptionalimagesstring[]requiredproductTypeenumoptionalmanageStockbooleanoptionalstockintegeroptionallowStockThresholdintegeroptionalsoldIndividuallybooleanoptionalweightUnitstringoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysintegeroptionaldeliveryDaysintegeroptionalspecificOveragePercentintegeroptionalweightnumberoptionallengthnumberoptionalwidthnumberoptionalheightnumberoptionalpurchaseNotestringoptionalmenuOrderintegeroptionalisGenericbooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.createWithAllNeedsCreate With All Needs
Authentication: Bearer JWT required
Request body
jsonanyrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.deleteAllProductsDelete All Products
Authentication: Bearer JWT required
Request body
jsonobjectrequiredconfirmationIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.deleteGenericLinkDelete Generic Link
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.deleteProductDelete Product
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/products.getByIdGet By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceanyoptionalproPriceanyoptionalpurchasePricenumberoptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdanyoptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionallastSyncstringoptionalprestashop_idstringoptionalprestashop_dataobjectoptionalmpnstringoptionalupcstringoptionalisbnstringoptionalnamestringoptionalratenumberoptionaldepthintegeroptionalean13stringoptionalpricenumberoptionalunitystringoptionalwidthintegeroptionalactivestringoptionalheightintegeroptionalweightintegeroptionaldate_addstringoptionaldate_updstringoptionalquantityintegeroptionalprice_ttcnumberoptionalreferencestringoptionalid_productstringoptionaldescriptionstringoptionalid_supplierstringoptionallink_rewritestringoptionalsupplier_namestringoptionalid_manufacturerstringoptionalwholesale_pricenumberoptionalbundle_componentsany[]optionaldescription_shortstringoptionallinked_categoriesobject[]optionalmanufacturer_namestringoptionalid_tax_rules_groupintegeroptionalavailable_for_orderstringoptionalid_category_defaultstringoptionalmanufacturerstringoptionaltaxRatenumberoptionalactivebooleanoptionaldefaultVendorIdstringoptionalpackagingTypeIdanyoptionalpackagingQuantityanyoptionalpackagingUnitanyoptionalsaleDetailanyoptionalsaleQuantityanyoptionalsaleUnitanyoptionalsaleTypeanyoptionaldefaultTemplateIdanyoptionalapprovisionnementintegeroptionalweightUnitanyoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysanyoptionaldeliveryDaysanyoptionalspecificOveragePercentanyoptionalcreatedByIdstringoptionalwarehouseIdanyoptionalexternalIdstringoptionalsyncedAtanyoptionallastSyncedAtanyoptionalsourcestringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaltagsIdanyoptionalisMaterialbooleanoptionalisFinishedProductbooleanoptionalmanufacturingLeadTimeanyoptionalsafetyStockanyoptionalreorderPointanyoptionalmoqanyoptionalmanufacturingCostanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalimagesany[]optionalmainImageanyoptionaldefaultVendorobjectoptionalidstringoptionalnamestringoptionalemailstringoptionaladdressstringoptionaldescriptionstringoptionaldefaultTemplateIdanyoptionalexternalIdstringoptionalcontactstringoptionalsendEmailstring[]optionalsendSchedulesobject[]optionaldaystringoptionaltimestringoptionalsendTypestringoptionalsendChannelstringoptionalsendAuthorizedbooleanoptionalgroupedOrderbooleanoptionalautoSendbooleanoptionalorderSettingsanyoptionalapprovisionnementintegeroptionaluseStockLedgerbooleanoptionaldefaultOveragePercentintegeroptionalspecificOveragePercentanyoptionaldeliveryDaysintegeroptionaldefaultPackagingTypeIdanyoptionaldataobjectoptionalcitystringoptionalnamestringoptionalphonestringoptionalactivebooleanoptionalcountrystringoptionaladdress1stringoptionaladdress2stringoptionaldate_addstringoptionaldate_updstringoptionallogo_urlstringoptionalpostcodestringoptionalmeta_titlestringoptionalvat_numberstringoptionaldescriptionstringoptionalhas_addressbooleanoptionalhas_contactbooleanoptionalid_supplierstringoptionalvendor_typestringoptionalcontact_namestringoptionalhas_productsbooleanoptionalphone_mobilestringoptionalmeta_keywordsstringoptionalproduct_countintegeroptionaladdress_companystringoptionalcontact_lastnamestringoptionalmeta_descriptionstringoptionalcontact_firstnamestringoptionalsupplier_referencesstringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaluserIdanyoptionaltenantIdstringoptionalsiteIdstringoptionalparentVendorIdanyoptionalcsvConfiganyoptionaldefaultTemplateanyoptionalpackagingTypeanyoptionalassignedSubCategoriesobject[]optionalidstringoptionalproductIdstringoptionalsubCategoryIdstringoptionalassignedAtstringoptionalassignedBystringoptionaltenantIdstringoptionalsiteIdstringoptionalsubCategoryobjectoptionaltagsany[]optionalassignedAttributesany[]optionalassignedOptionListsany[]optionalvariationsany[]optionalvariantsany[]optionalupsellsany[]optionalcrossSellsany[]optionalbundleComponentsany[]optionalgenericLinksany[]optionalparentGenericLinksany[]optionaleffectivePricenumberoptionalpriceLabelstringoptionalprestashopActivebooleanoptionalisbnanyoptionalean13anyoptionalupcanyoptionalmpnanyoptionalppomanyoptionalppomNormalizedanyoptionalInput (JSON)
GET/api/trpc/products.getBySlugGet By Slug
Authentication: Bearer JWT required
Request body
jsonobjectrequiredslugstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/products.getCacheStatusGet Cache Status
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/products.getOrdersByProductIdGet Orders By Product Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredproductIdstringrequiredpagenumberrequiredlimitnumberrequiredsortanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/products.getProductsByIdsGet Products By Ids
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/products.getProductsGet Products
Authentication: Bearer JWT required
Request body
jsonobjectrequireddefaultVendorIdstringoptionalpagenumberrequiredper_pagenumberrequiredsearchstringoptionalstockFilterstringoptionalcategoryFilterstringoptionalactiveFilterstringoptionalbuyableFilterstringoptionalpriceRangeFilterstringoptionalgenericFilterstringoptionalbundleFilterstringoptionalproductTypeFilterenumoptionalsubscriptionFilterenumoptionalpublicationIdstringoptionalbundleIdstringoptionalsortOrderstringrequiredsortMultipleobject[]optionalfieldstringrequireddirectionenumrequiredexcludeIdsstring[]optionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsobject[]optionalidstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceanyoptionalproPriceanyoptionalpurchasePricenumberoptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdintegeroptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionalmanufacturerstringoptionaltaxRatenumberoptionalactivebooleanoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantityintegeroptionalpackagingUnitstringoptionalsaleDetailanyoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdanyoptionalapprovisionnementintegeroptionalweightUnitanyoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysanyoptionaldeliveryDaysanyoptionalspecificOveragePercentanyoptionalcreatedByIdstringoptionalwarehouseIdanyoptionalexternalIdstringoptionalsyncedAtanyoptionallastSyncedAtanyoptionalsourcestringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaltagsIdanyoptionalisMaterialbooleanoptionalisFinishedProductbooleanoptionalmanufacturingLeadTimeanyoptionalsafetyStockanyoptionalreorderPointanyoptionalmoqanyoptionalmanufacturingCostanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalmainImageanyoptionalpackagingTypeobjectoptionaldefaultVendorobjectoptionalstockAvailabilityany[]optionalmagazineEditionanyoptionalassignedSubCategoriesobject[]optional_countobjectoptionalprestashopActivebooleanoptionaltotalintegeroptionalpageintegeroptionalper_pageintegeroptionalpagesintegeroptionalInput (JSON)
GET/api/trpc/products.getVendorOrdersByProductIdGet Vendor Orders By Product Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredproductIdstringrequiredpagenumberrequiredlimitnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/products.listGenericLinksList Generic Links
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/products.listList
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionalactivebooleanoptionalisBuyablebooleanoptionalcategoryIdstringoptionalvendorIdstringoptionalpackagingTypeIdstringoptionalsortBystringrequiredsortOrderenumrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsobject[]optionalidstringoptionalreferencestringoptionalplenigoOfferIdanyoptionalplenigoAccessRightUniqueIdanyoptionalnamestringoptionaldescriptionstringoptionalpricenumberoptionalsalePriceintegeroptionalproPriceanyoptionalpurchasePriceintegeroptionalstockintegeroptionalstockLedgerintegeroptionalisBuyablebooleanoptionalskustringoptionalisGenericbooleanoptionalmagazineEditionIdanyoptionalsiteIdstringoptionalproductTypestringoptionalmanageStockbooleanoptionallowStockThresholdanyoptionalsoldIndividuallybooleanoptionalweightanyoptionallengthanyoptionalwidthanyoptionalheightanyoptionalpurchaseNoteanyoptionalmenuOrderanyoptionaldataobjectoptionalmanufacturerstringoptionaltaxRatenumberoptionalactivebooleanoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantityintegeroptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantityintegeroptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdanyoptionalapprovisionnementintegeroptionalweightUnitanyoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysanyoptionaldeliveryDaysanyoptionalspecificOveragePercentanyoptionalcreatedByIdstringoptionalwarehouseIdanyoptionalexternalIdstringoptionalsyncedAtstringoptionallastSyncedAtanyoptionalsourcestringoptionalmainImageIdanyoptionalcreatedAtstringoptionalupdatedAtstringoptionaltenantIdstringoptionaltagsIdanyoptionalisMaterialbooleanoptionalisFinishedProductbooleanoptionalmanufacturingLeadTimeanyoptionalsafetyStockanyoptionalreorderPointanyoptionalmoqanyoptionalmanufacturingCostanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalmainImageanyoptionalpackagingTypeobjectoptionaldefaultVendorobjectoptionalassignedSubCategoriesany[]optionalvariantsany[]optionaleffectivePricenumberoptionalpriceLabelstringoptionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalpagesintegeroptionalInput (JSON)
POST/api/trpc/products.removeSubCategoryFromProductRemove Sub Category From Product
Authentication: Bearer JWT required
Request body
jsonobjectrequiredproductIdstring · uuidrequiredsubCategoryIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.syncIndividualProductSync Individual Product
Authentication: Bearer JWT required
Request body
jsonobjectrequiredproductIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.syncProductsSync Products
Authentication: Bearer JWT required
Request body
jsonobjectrequiredoffsetnumberrequiredlimitnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.syncProductsStockSync Products Stock
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
POST/api/trpc/products.syncSingleProductStockSync Single Product Stock
Authentication: Bearer JWT required
Request body
jsonobjectrequiredproductIdstringrequiredexternalIdstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.updateUpdate
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringoptionaldescriptionstringoptionalpricenumberoptionalproPriceanyoptionalreferencestringoptionalmanufacturerstringoptionaltaxRatenumberoptionaldefaultVendorIdstringoptionalpackagingTypeIdstringoptionalpackagingQuantitynumberoptionalpackagingUnitstringoptionalsaleDetailstringoptionalsaleQuantitynumberoptionalsaleUnitstringoptionalsaleTypestringoptionaldefaultTemplateIdstringoptionalisBuyablebooleanoptionalactivebooleanoptionalmainImageIdanyoptionalproductTypeenumoptionalmanageStockbooleanoptionalstockintegeroptionallowStockThresholdintegeroptionalsoldIndividuallybooleanoptionalweightUnitstringoptionalrequiresLotNumberbooleanoptionalshowOrderDetailsbooleanoptionalisPerishablebooleanoptionalperishabilityDaysintegeroptionaldeliveryDaysintegeroptionalspecificOveragePercentintegeroptionalweightnumberoptionallengthnumberoptionalwidthnumberoptionalheightnumberoptionalpurchaseNotestringoptionalmenuOrderintegeroptionalisGenericbooleanoptionalidstring · uuidrequiredskipIndexingbooleanrequiredimagesstring[]optionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.updateStripeLinkUpdate Stripe Link
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredstripeProductIdanyoptionalstripePriceIdanyoptionalstripeRecurringPriceIdanyoptionalsubscriptionEnabledbooleanoptionalsubscriptionDurationDaysanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.updateWithAllNeedsUpdate With All Needs
Authentication: Bearer JWT required
Request body
jsonanyrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/products.upsertGenericLinkUpsert Generic Link
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidoptionalgenericProductIdstring · uuidrequiredexternalProductIdstringrequiredconversionFactornumberrequiredconversionUnitstringoptionalnotesstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
recurringInvoices 10
POST/api/trpc/recurringInvoices.cancelCancel
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/recurringInvoices.createCreate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredclientIdstring · uuidrequiredfrequencyenumrequiredstartDateanyrequiredendDateanyoptionalitemsobject[]requirednamestringrequireddescriptionstringoptionalquantitynumberrequiredunitPricenumberrequiredtaxRatenumberoptionalcurrencystringrequiredlanguagestringrequirednotesstringoptionalfooterstringoptionalpaymentTermsstringoptionalpaymentMethodstringoptionalautoSendbooleanrequiredautoReminderbooleanrequiredpdfTemplatenumberrequiredpdfFormatstringoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/recurringInvoices.deleteDelete
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/recurringInvoices.getGet
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/recurringInvoices.getStatsGet Stats
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
totalintegeroptionalactiveintegeroptionalpausedintegeroptionalcancelledintegeroptionalGET/api/trpc/recurringInvoices.getUpcomingGet Upcoming
Authentication: Bearer JWT required
Request body
jsonobjectrequireddaysAheadnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/recurringInvoices.listList
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredstatusenumoptionalclientIdstring · uuidoptionalsearchstringoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
itemsany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionaltotalPagesintegeroptionalhasMorebooleanoptionalInput (JSON)
POST/api/trpc/recurringInvoices.pausePause
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/recurringInvoices.resumeResume
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/recurringInvoices.updateUpdate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredclientIdstring · uuidoptionalfrequencyenumoptionalstartDateanyoptionalendDateanyoptionalitemsobject[]optionalnamestringrequireddescriptionstringoptionalquantitynumberrequiredunitPricenumberrequiredtaxRatenumberoptionalcurrencystringoptionallanguagestringoptionalnotesstringoptionalfooterstringoptionalpaymentTermsstringoptionalpaymentMethodstringoptionalautoSendbooleanoptionalautoReminderbooleanoptionalpdfTemplatenumberoptionalpdfFormatstringoptionaltaxDetailsobjectoptionaldiscountDetailsobjectoptionalstatusenumoptionalisActivebooleanoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
shipping 43
GET/api/trpc/shipping.calculateEUVATCalculate EUVAT
Authentication: Bearer JWT required
Request body
jsonobjectrequiredamountnumberrequiredfromCountrystringrequiredtoCountrystringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.calculateShippingRatesCalculate Shipping Rates
Authentication: Bearer JWT required
Request body
jsonobjectrequiredoriginobjectrequiredpostalCodestringrequiredcountrystringrequireddestinationobjectrequiredpostalCodestringrequiredcountrystringrequiredpackagesobject[]requiredweightnumberrequiredlengthnumberoptionalwidthnumberoptionalheightnumberoptionalcurrencystringrequiredcarrierIdsstring[]optionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.colissimoCreateLabelColissimo Create Label
Authentication: Bearer JWT required
Request body
jsonobjectrequiredshipmentIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.colissimoGetRatesColissimo Get Rates
Authentication: Bearer JWT required
Request body
jsonobjectrequiredoriginobjectrequiredpostalCodestringrequiredcountrystringrequireddestinationobjectrequiredpostalCodestringrequiredcountrystringrequiredweightnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.colissimoSearchPickupPointsColissimo Search Pickup Points
Authentication: Bearer JWT required
Request body
jsonobjectrequiredaddressstringrequiredpostalCodestringrequiredcitystringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.colissimoTrackShipmentColissimo Track Shipment
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtrackingNumberstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.createRateCreate Rate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredzoneIdstring · uuidrequirednamestringoptionaltypeenumrequiredweightMinnumberrequiredweightMaxnumberrequiredbaseRatenumberrequiredperKgRatenumberoptionalvolumeMinnumberoptionalvolumeMaxnumberoptionalperVolumeRatenumberoptionalhandlingFeenumberoptionalfuelSurchargenumberoptionalinsuranceFeenumberoptionalcorsicaSurchargenumberoptionaldomTomSurchargenumberoptionalruralSurchargenumberoptionalpickupPointDiscountnumberoptionalvatRatenumberrequiredvatIncludedbooleanrequiredisActivebooleanrequiredvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptionalmaxOrderValuenumberoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.createServiceCreate Service
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidrequirednamestringrequiredcodestringrequiredtypeenumrequireddescriptionstringoptionalestimatedDaysMinintegerrequiredestimatedDaysMaxintegerrequiredtrackingIncludedbooleanrequiredinsuranceIncludedbooleanrequiredsignatureRequiredbooleanrequiredisActivebooleanrequiredavailableZonesstring[]requiredpickupPointServicebooleanrequiredappointmentRequiredbooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.createShipmentCreate Shipment
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdstring · uuidrequiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredpickupPointIdstring · uuidoptionalpackagesobject[]requiredweightnumberrequiredlengthnumberoptionalwidthnumberoptionalheightnumberoptionalsenderAddressobjectrequiredrecipientAddressobjectrequiredcurrencystringrequiredinstructionsstringoptionalrequiresSignaturebooleanrequiredinsuranceValuenumberoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.createShippingCarrierCreate Shipping Carrier
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredcodestringrequireddescriptionstringoptionallogoUrlstring · urioptionalwebsiteUrlstring · urioptionalstatusenumrequiredpriorityintegerrequiredapiEndpointstring · urioptionalapiKeystringoptionalapiSecretstringoptionaltestModebooleanrequiredcountryCodestringrequiredeuCoveragebooleanrequiredinternationalCoveragebooleanrequiredpickupPointsSupportedbooleanrequiredtrackingSupportedbooleanrequiredlabelGenerationSupportedbooleanrequiredcorsicaSupportedbooleanrequireddomTomSupportedbooleanrequiredappointmentDeliverybooleanrequiredmaxWeightnumberoptionalmaxLengthnumberoptionalmaxWidthnumberoptionalmaxHeightnumberoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.createZoneCreate Zone
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredcodestringrequiredtypeenumrequireddescriptionstringoptionalcountriesstring[]requiredregionsstring[]requiredpostalCodeRangesobjectoptionalincludesCorsicabooleanrequiredincludesDomTombooleanrequiredruralDeliveryHandlingbooleanrequiredisActivebooleanrequiredpriorityintegerrequiredfreeShippingThresholdnumberoptionalmaxWeightnumberoptionalmaxDimensionsobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.deleteRateDelete Rate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredrateIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.deleteServiceDelete Service
Authentication: Bearer JWT required
Request body
jsonobjectrequiredserviceIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.deleteShippingCarrierDelete Shipping Carrier
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.deleteZoneDelete Zone
Authentication: Bearer JWT required
Request body
jsonobjectrequiredzoneIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.generateBulkLabelsGenerate Bulk Labels
Authentication: Bearer JWT required
Request body
jsonobjectrequiredshipmentIdsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.generateLabelGenerate Label
Authentication: Bearer JWT required
Request body
jsonobjectrequiredshipmentIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getCarrierGet Carrier
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalcarrierIdstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalestimatedDaysMinintegeroptionalestimatedDaysMaxintegeroptionaltrackingIncludedbooleanoptionalinsuranceIncludedbooleanoptionalsignatureRequiredbooleanoptionalisActivebooleanoptionalavailableZonesstring[]optionalpickupPointServicebooleanoptionalappointmentRequiredbooleanoptionalcreatedAtstringoptionalupdatedAtstringoptionalcarrierobjectoptionalidstringoptionalnamestringoptionalcodestringoptionalratesobject[]optionalidstringoptionaltenantIdstringoptionalsiteIdstringoptionalcarrierIdstringoptionalserviceIdstringoptionalzoneIdstringoptionalnamestringoptionaltypestringoptionalweightMinstringoptionalweightMaxstringoptionalbaseRatestringoptionalperKgRatestringoptionalvolumeMinanyoptionalvolumeMaxanyoptionalperVolumeRateanyoptionalhandlingFeestringoptionalfuelSurchargestringoptionalinsuranceFeestringoptionalcorsicaSurchargestringoptionaldomTomSurchargestringoptionalruralSurchargestringoptionalpickupPointDiscountstringoptionalvatRatestringoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromstringoptionalvalidToanyoptionalminOrderValuestringoptionalmaxOrderValueanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalzoneobjectoptionalGET/api/trpc/shipping.getCostAnalysisGet Cost Analysis
Authentication: Bearer JWT required
Request body
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getDeliveryPerformanceGet Delivery Performance
Authentication: Bearer JWT required
Request body
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getPerformanceDashboardGet Performance Dashboard
Authentication: Bearer JWT required
Request body
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getPickupPointsGet Pickup Points
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidrequiredaddressstringrequiredpostalCodestringrequiredcitystringrequiredcountrystringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getPrintJobsGet Print Jobs
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpageintegerrequiredlimitintegerrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
successbooleanoptionalprintJobsany[]optionaltotalintegeroptionalhasMorebooleanoptionalInput (JSON)
GET/api/trpc/shipping.getQuickEstimateGet Quick Estimate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredweightnumberrequiredcarrierIdstring · uuidoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getRatesGet Rates
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalcarrierIdstringoptionalserviceIdstringoptionalzoneIdstringoptionalnamestringoptionaltypestringoptionalweightMinstringoptionalweightMaxstringoptionalbaseRatestringoptionalperKgRatestringoptionalvolumeMinanyoptionalvolumeMaxanyoptionalperVolumeRateanyoptionalhandlingFeestringoptionalfuelSurchargestringoptionalinsuranceFeestringoptionalcorsicaSurchargestringoptionaldomTomSurchargestringoptionalruralSurchargestringoptionalpickupPointDiscountstringoptionalvatRatestringoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromstringoptionalvalidToanyoptionalminOrderValuestringoptionalmaxOrderValueanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalzoneobjectoptionalidstringoptionalnamestringoptionalcountriesstring[]optionalserviceobjectoptionalidstringoptionalnamestringoptionaltypestringoptionalcarrierobjectoptionalGET/api/trpc/shipping.getShipmentGet Shipment
Authentication: Bearer JWT required
Request body
jsonobjectrequiredshipmentIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getShipmentsGet Shipments
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpageintegerrequiredlimitintegerrequiredstatusstringoptionalcarrierIdstring · uuidoptionaldateFromanyoptionaldateToanyoptionalsearchstringoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
shipmentsany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalInput (JSON)
GET/api/trpc/shipping.getShippingAnalyticsGet Shipping Analytics
Authentication: Bearer JWT required
Request body
jsonobjectrequiredstartDateanyrequiredendDateanyrequiredcarrierIdstring · uuidoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.getShippingCarriersGet Shipping Carriers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredincludeInactivebooleanrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlanyoptionalwebsiteUrlanyoptionalstatusstringoptionalpriorityintegeroptionalapiEndpointanyoptionalapiKeyanyoptionalapiSecretanyoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightstringoptionalmaxLengthanyoptionalmaxWidthanyoptionalmaxHeightanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalservicesobject[]optionalidstringoptionalnamestringoptionaltypestringoptionalInput (JSON)
GET/api/trpc/shipping.getShippingConfigurationGet Shipping Configuration
Authentication: Bearer JWT required
Request body
jsonobjectrequiredincludeInactivebooleanrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlanyoptionalwebsiteUrlanyoptionalstatusstringoptionalpriorityintegeroptionalapiEndpointanyoptionalapiKeyanyoptionalapiSecretanyoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightstringoptionalmaxLengthanyoptionalmaxWidthanyoptionalmaxHeightanyoptionalcreatedAtstringoptionalupdatedAtstringoptionalservicesobject[]optionalidstringoptionalnamestringoptionaltypestringoptionalInput (JSON)
GET/api/trpc/shipping.getShippingZonesGet Shipping Zones
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalcountriesstring[]optionalregionsany[]optionalpostalCodeRangesanyoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdstringoptionalmaxWeightstringoptionalmaxDimensionsanyoptionalcreatedAtstringoptionalupdatedAtstringoptional_countobjectoptionalratesintegeroptionalGET/api/trpc/shipping.getZonesGet Zones
Authentication: Bearer JWT required
Responses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionaltenantIdstringoptionalsiteIdstringoptionalnamestringoptionalcodestringoptionaltypestringoptionaldescriptionstringoptionalcountriesstring[]optionalregionsany[]optionalpostalCodeRangesanyoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdstringoptionalmaxWeightstringoptionalmaxDimensionsanyoptionalcreatedAtstringoptionalupdatedAtstringoptional_countobjectoptionalratesintegeroptionalGET/api/trpc/shipping.performComplianceCheckPerform Compliance Check
Authentication: Bearer JWT required
Request body
jsonobjectrequiredshipmentIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.processBulkOrdersProcess Bulk Orders
Authentication: Bearer JWT required
Request body
jsonobjectrequiredorderIdsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.searchPickupPointsSearch Pickup Points
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsiteSlugstringrequiredaddressstringrequiredmaxResultsintegerrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.sendShippingNotificationSend Shipping Notification
Authentication: Bearer JWT required
Request body
jsonobjectrequiredshipmentIdstring · uuidrequiredtypeenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.updateCarrierRatesUpdate Carrier Rates
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidrequiredratesobject[]requiredcarrierIdstring · uuidrequiredserviceIdstring · uuidrequiredzoneIdstring · uuidrequirednamestringoptionaltypeenumrequiredweightMinnumberrequiredweightMaxnumberrequiredbaseRatenumberrequiredperKgRatenumberoptionalvolumeMinnumberoptionalvolumeMaxnumberoptionalperVolumeRatenumberoptionalhandlingFeenumberoptionalfuelSurchargenumberoptionalinsuranceFeenumberoptionalcorsicaSurchargenumberoptionaldomTomSurchargenumberoptionalruralSurchargenumberoptionalpickupPointDiscountnumberoptionalvatRatenumberrequiredvatIncludedbooleanrequiredisActivebooleanrequiredvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptionalmaxOrderValuenumberoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.updateRateUpdate Rate
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidoptionalserviceIdstring · uuidoptionalzoneIdstring · uuidoptionalnamestringoptionaltypeenumoptionalweightMinnumberoptionalweightMaxnumberoptionalbaseRatenumberoptionalperKgRatenumberoptionalvolumeMinnumberoptionalvolumeMaxnumberoptionalperVolumeRatenumberoptionalhandlingFeenumberoptionalfuelSurchargenumberoptionalinsuranceFeenumberoptionalcorsicaSurchargenumberoptionaldomTomSurchargenumberoptionalruralSurchargenumberoptionalpickupPointDiscountnumberoptionalvatRatenumberoptionalvatIncludedbooleanoptionalisActivebooleanoptionalvalidFromanyoptionalvalidToanyoptionalminOrderValuenumberoptionalmaxOrderValuenumberoptionalrateIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.updateServiceUpdate Service
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidoptionalnamestringoptionalcodestringoptionaltypeenumoptionaldescriptionstringoptionalestimatedDaysMinintegeroptionalestimatedDaysMaxintegeroptionaltrackingIncludedbooleanoptionalinsuranceIncludedbooleanoptionalsignatureRequiredbooleanoptionalisActivebooleanoptionalavailableZonesstring[]optionalpickupPointServicebooleanoptionalappointmentRequiredbooleanoptionalserviceIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.updateShippingCarrierUpdate Shipping Carrier
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringoptionalcodestringoptionaldescriptionstringoptionallogoUrlstring · urioptionalwebsiteUrlstring · urioptionalstatusenumoptionalpriorityintegeroptionalapiEndpointstring · urioptionalapiKeystringoptionalapiSecretstringoptionaltestModebooleanoptionalcountryCodestringoptionaleuCoveragebooleanoptionalinternationalCoveragebooleanoptionalpickupPointsSupportedbooleanoptionaltrackingSupportedbooleanoptionallabelGenerationSupportedbooleanoptionalcorsicaSupportedbooleanoptionaldomTomSupportedbooleanoptionalappointmentDeliverybooleanoptionalmaxWeightnumberoptionalmaxLengthnumberoptionalmaxWidthnumberoptionalmaxHeightnumberoptionalcarrierIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/shipping.updateZoneUpdate Zone
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringoptionalcodestringoptionaltypeenumoptionaldescriptionstringoptionalcountriesstring[]optionalregionsstring[]optionalpostalCodeRangesobjectoptionalincludesCorsicabooleanoptionalincludesDomTombooleanoptionalruralDeliveryHandlingbooleanoptionalisActivebooleanoptionalpriorityintegeroptionalfreeShippingThresholdnumberoptionalmaxWeightnumberoptionalmaxDimensionsobjectoptionalzoneIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.validateAddressValidate Address
Authentication: Bearer JWT required
Request body
jsonobjectrequiredaddressobjectrequiredstreetstringrequiredcitystringrequiredpostalCodestringrequiredcountrystringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/shipping.validateCarrierAPIValidate Carrier API
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcarrierIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
subscriptions 2
GET/api/trpc/subscriptions.cancelCancel
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsubscriptionIdstring · uuidrequirednewAmountnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/subscriptions.createCreate
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
tiers 29
GET/api/trpc/tiers.checkTiersExistenceCheck Tiers Existence
Authentication: Bearer JWT required
Request body
jsonobjectrequiredcriteriaobjectrequiredsiretstringoptionalsirenstringoptionalemailstring · emailoptionalnamestringoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
existsbooleanoptionaltiersanyoptionalmatchesany[]optionalInput (JSON)
POST/api/trpc/tiers.createActivityCreate Activity
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidrequiredtypeenumrequiredsubjectstringrequireddescriptionstringoptionalscheduledAtanyoptionalcontactIdstring · uuidoptionalopportunityIdstring · uuidoptionaleventIdstring · uuidoptionalpriorityenumrequiredmetadataobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.createAddressCreate Address
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidrequiredtypeenumrequirednamestringoptionalstreetstringrequiredstreet2stringoptionalcitystringrequiredpostalCodestringrequiredcountrystringrequiredregionstringoptionallatitudenumberoptionallongitudenumberoptionalisDefaultbooleanrequiredisActivebooleanrequiredmetadataobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.createContactCreate Contact
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidrequiredfirstNamestringrequiredlastNamestringrequiredemailstring · emailoptionalphonestringoptionalmobilestringoptionalrolestringoptionaltitlestringoptionaldepartmentstringoptionalisPrimarybooleanrequiredtagsstring[]optionalmetadataobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.createCustomFieldCreate Custom Field
Authentication: Bearer JWT required
Request body
jsonobjectrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.createOpportunityCreate Opportunity
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidrequirednamestringrequireddescriptionstringoptionalstatusenumoptionalsourceenumoptionalstagestringoptionalvaluenumberoptionalprobabilitynumberrequiredexpectedCloseDateanyoptionalprimaryContactIdstring · uuidoptionalassignedToIdstring · uuidrequiredlostReasonstringoptionalcompetitorInfostringoptionalnextActionstringoptionalnextActionDateanyoptionalmetadataobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.createTiersCreate Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequirednamestringrequiredemailstring · emailoptionalphonestringoptionalsiretstringoptionalsirenstringoptionaltvastringoptionaltypeenumrequiredstatusenumrequiredindustrystringoptionalcompanySizestringoptionalannualRevenuestringoptionalwebsitestring · urioptionaldescriptionstringoptionalcreditLimitnumberoptionalcreditUsednumberoptionalpaymentTermsstringoptionalpreferredCurrencyenumrequiredtaxExemptbooleanrequiredcreditScorenumberoptionalriskLevelenumoptionaltagsstring[]optionalmetadataobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.deleteTiersDelete Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getActivitiesGet Activities
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidoptionalcontactIdstring · uuidoptionaltypestring[]optionalstatusstring[]optionalprioritystring[]optionaldateFromanyoptionaldateToanyoptionalassignedToIdstring · uuidoptionalpagenumberrequiredlimitnumberrequiredsortByenumrequiredsortOrderenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getAllTiersGet All Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionaltypeenumoptionalstatusenumoptionalsortByenumrequiredsortOrderenumrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
tiersobject[]optionalidstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretanyoptionalnumTvaanyoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementanyoptionalmainActivityanyoptionalpaymentConditionIdanyoptionaldeliveryCommentsanyoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalgeocodeanyoptionaladdressL1anyoptionaladdressL2anyoptionaladdressCPanyoptionaladdressCommuneanyoptionaladdressDepartementanyoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalcontactsany[]optionalfinancialany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalInput (JSON)
GET/api/trpc/tiers.getFinancialsByTiersExternalIdsGet Financials By Tiers External Ids
Authentication: Bearer JWT required
Request body
jsonobjectrequiredexternalIdsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getOpportunitiesGet Opportunities
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidoptionalstatusstring[]optionalstagestring[]optionalassignedToIdstring · uuidoptionalvalueMinnumberoptionalvalueMaxnumberoptionalprobabilityMinnumberoptionalprobabilityMaxnumberoptionalexpectedCloseFromanyoptionalexpectedCloseToanyoptionalpagenumberrequiredlimitnumberrequiredsortByenumrequiredsortOrderenumrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
opportunitiesany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalsummaryanyoptionalInput (JSON)
GET/api/trpc/tiers.getTiersActivitiesByIdGet Tiers Activities By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredpagenumberrequiredlimitnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getTiersByIdGet Tiers By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getTiersByIdsGet Tiers By Ids
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidsstring[]requiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
tiersany[]optionaltotalintegeroptionalInput (JSON)
GET/api/trpc/tiers.getTiersByRefGet Tiers By Ref
Authentication: Bearer JWT required
Request body
jsonobjectrequiredrefstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretstringoptionalnumTvastringoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementstringoptionalmainActivitystringoptionalpaymentConditionIdanyoptionaldeliveryCommentsstringoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalemailstringoptionaloptinbooleanoptionalactivebooleanoptionalid_langintegeroptionalid_shopintegeroptionaldate_addstringoptionaldate_updstringoptionallastSyncstringoptionallastnamestringoptionaladdressesobject[]optionalcitystringoptionalphonestringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionalpostcodestringoptionalphone_mobilestringoptionalfirstnamestringoptionalnewsletterbooleanoptionalid_customerintegeroptionalid_shop_groupintegeroptionalgeocodeanyoptionaladdressL1stringoptionaladdressL2stringoptionaladdressCPstringoptionaladdressCommunestringoptionaladdressDepartementstringoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalcontactsany[]optionalActivitiesany[]optionalOpportunitiesany[]optionalfinancialany[]optionalDocumentsany[]optionalInput (JSON)
GET/api/trpc/tiers.getTiersBySiretGet Tiers By Siret
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsiretstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretstringoptionalnumTvastringoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementstringoptionalmainActivitystringoptionalpaymentConditionIdanyoptionaldeliveryCommentsstringoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalemailstringoptionaloptinbooleanoptionalactivebooleanoptionalid_langintegeroptionalid_shopintegeroptionaldate_addstringoptionaldate_updstringoptionallastSyncstringoptionallastnamestringoptionaladdressesobject[]optionalcitystringoptionalphonestringoptionaladdressstringoptionalcountrystringoptionaladdress2stringoptionalpostcodestringoptionalphone_mobilestringoptionalfirstnamestringoptionalnewsletterbooleanoptionalid_customerintegeroptionalid_shop_groupintegeroptionalgeocodeanyoptionaladdressL1stringoptionaladdressL2stringoptionaladdressCPstringoptionaladdressCommunestringoptionaladdressDepartementstringoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalInput (JSON)
GET/api/trpc/tiers.getTiersContactsByIdGet Tiers Contacts By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getTiersEnhancedGet Tiers Enhanced
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredincludeContactsbooleanrequiredincludeAddressesbooleanrequiredincludeActivitiesbooleanrequiredincludeOpportunitiesbooleanrequiredincludeFinancialsbooleanrequiredincludeFilesbooleanrequiredactivityLimitnumberrequiredopportunityLimitnumberrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getTiersFilesByIdGet Tiers Files By Id
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.getTiersGet Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredlimitnumberrequiredsearchstringoptionalfiltersobjectoptionaltypestring[]optionalstatusstring[]optionalindustrystring[]optionaltagsstring[]optionalhasCreditbooleanoptionalcreditRiskenumoptionalsortByenumrequiredsortOrderenumrequiredincludeContactsbooleanrequiredincludeFinancialsbooleanrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
tiersobject[]optionalidstringoptionalnamestringoptionalupdatedAtstringoptionalcreatedAtstringoptionalsyncedAtstringoptionalsuperiorIdanyoptionalrefstringoptionalexternalIdstringoptionalexternalRefstringoptionalexternalRefComptableanyoptionaldescriptionstringoptionalnumSirenanyoptionalnumSiretanyoptionalnumTvaanyoptionalcodeNafanyoptionalcommercialanyoptionalstatutstringoptionalsourcestringoptionalecheanceanyoptionalmodeDePaiementanyoptionalmainActivityanyoptionalpaymentConditionIdanyoptionaldeliveryCommentsanyoptionaldate_creationstringoptionaldate_dernier_appelTeleproanyoptionaldate_dernier_appelCommercialanyoptionaldate_dernier_rdvanyoptionaldate_prochain_rdvanyoptionalrdvPrisanyoptionalribanyoptionalextraDataobjectoptionalgeocodeanyoptionaladdressL1anyoptionaladdressL2anyoptionaladdressCPanyoptionaladdressCommuneanyoptionaladdressDepartementanyoptionallatitudeanyoptionallongitudeanyoptionaluserIdstringoptionalcreatedByIdstringoptionalassignedToIdanyoptionaltenantIdstringoptionalsiteIdstringoptionallastSyncedAtanyoptionalaccountManagerIdanyoptionalannualRevenueanyoptionalaverageOrderValuestringoptionalcompanySizeanyoptionalcreditCheckDateanyoptionalcreditLimitanyoptionalcreditScoreanyoptionalcreditUsedstringoptionalfirstOrderDateanyoptionalindustryanyoptionallanguagestringoptionallastOrderDateanyoptionallastQualificationDateanyoptionalleadScoreintegeroptionallifetimeValuestringoptionaloutstandingBalancestringoptionalparentCompanyIdanyoptionalpartnerTypeanyoptionalpaymentTermsanyoptionalpreferredContactMethodstringoptionalpreferredCurrencystringoptionalqualificationNotesanyoptionalqualificationStatusanyoptionalsocialMediaUrlsanyoptionaltaxExemptbooleanoptionaltimezoneanyoptionaltotalRevenuestringoptionalwebsiteanyoptionalcontactsany[]optionalfinancialany[]optionaltotalintegeroptionalpageintegeroptionallimitintegeroptionalhasMorebooleanoptionalsummaryanyoptionalInput (JSON)
POST/api/trpc/tiers.linkContactLink Contact
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidrequiredcontactIdstring · uuidrequiredrolestringoptionalisPrimarybooleanrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/tiers.searchAndExportTiersSearch And Export Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsearchstringoptionalfiltersobjectoptionaltypestring[]optionalstatusstring[]optionalindustrystring[]optionaltagsstring[]optionalcreditScoreMinnumberoptionalcreditScoreMaxnumberoptionalcreatedFromanyoptionalcreatedToanyoptionalsortByenumrequiredsortOrderenumrequiredpagenumberrequiredlimitnumberrequiredexportbooleanrequiredexportFormatenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.toggleTiersStatusToggle Tiers Status
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredstatusenumrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.unlinkContactUnlink Contact
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidrequiredcontactIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.updateActivityUpdate Activity
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidoptionaltypeenumoptionalsubjectstringoptionaldescriptionstringoptionalscheduledAtanyoptionalcontactIdstring · uuidoptionalopportunityIdstring · uuidoptionaleventIdstring · uuidoptionalpriorityenumoptionalmetadataobjectoptionalidstring · uuidoptionalstatusenumoptionaloutcomestringoptionalnotesstringoptionalcompletedAtanyoptionaldurationnumberoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.updateFinancialInfoUpdate Financial Info
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidrequiredfinancialDataobjectrequiredtotalRevenuenumberoptionaloutstandingBalancenumberoptionalaverageOrderValuenumberoptionallifetimeValuenumberoptionalcreditLimitnumberoptionalcreditUsednumberoptionalpaymentTermsstringoptionalcreditScorenumberoptionalriskLevelenumoptionallastPaymentDateanyoptionalfirstOrderDateanyoptionallastOrderDateanyoptionalpaymentConditionanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.updateOpportunityUpdate Opportunity
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtiersIdstring · uuidoptionalnamestringoptionaldescriptionstringoptionalstatusenumoptionalsourceenumoptionalstagestringoptionalvaluenumberoptionalprobabilitynumberoptionalexpectedCloseDateanyoptionalprimaryContactIdstring · uuidoptionalassignedToIdstring · uuidoptionallostReasonstringoptionalcompetitorInfostringoptionalnextActionstringoptionalnextActionDateanyoptionalmetadataobjectoptionalidstring · uuidoptionalactualCloseDateanyoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/tiers.updateTiersUpdate Tiers
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstring · uuidrequiredupdatesobjectrequirednamestringoptionalemailstring · emailoptionalphonestringoptionalsiretstringoptionalsirenstringoptionaltvastringoptionaltypeenumoptionalstatusenumoptionalindustrystringoptionalcompanySizestringoptionalannualRevenuestringoptionalwebsitestring · urioptionaldescriptionstringoptionalcreditLimitnumberoptionalcreditUsednumberoptionalpaymentTermsstringoptionalpreferredCurrencyenumoptionaltaxExemptbooleanoptionalcreditScorenumberoptionalriskLevelenumoptionaltagsstring[]optionalmetadataobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
users 20
GET/api/trpc/users.checkUserSiteAccessCheck User Site Access
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsiteIdstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
hasAccessbooleanoptionaluserSiteIdstringoptionalrequestedSiteIdstringoptionalisSuperAdminbooleanoptionalInput (JSON)
POST/api/trpc/users.createUserForSiteCreate User For Site
Authentication: Bearer JWT required
Request body
jsonobjectrequiredfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredrolesstring[]requiredphonestringoptionaltitlestringoptionaltenantIdstringoptionalsiteIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/users.createUserCreate User
Authentication: Bearer JWT required
Request body
jsonobjectrequiredfirstNamestringrequiredlastNamestringrequiredemailstring · emailrequiredrolesstring[]requiredphonestringoptionaltitlestringoptionaltenantIdstringoptionalsiteIdstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/users.deleteUserDelete User
Authentication: Bearer JWT required
Request body
jsonobjectrequireduserIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/users.deleteUsersDelete Users
Authentication: Bearer JWT required
Request body
jsonobjectrequireduserIdsstring[]requiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/users.forgotPasswordForgot Password
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/users.getAnonymousMeilisearchCredentialsGet Anonymous Meilisearch Credentials
Authentication: Bearer JWT required
Responses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
GET/api/trpc/users.getAuthoredArticlesGet Authored Articles
Authentication: Bearer JWT required
Request body
jsonobjectrequireduserIdstring · uuidrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/users.getServerUsersGet Server Users
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtenantIdstringoptionalsiteIdstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/users.getUserDetailsGet User Details
Authentication: Bearer JWT required
Request body
jsonobjectrequireduserIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/users.getUserGet User
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequiredResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNameanyoptionallastNameanyoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalmenuAllowliststring[]optionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionalInput (JSON)
GET/api/trpc/users.getUserProfileGet User Profile
Authentication: Bearer JWT required
Request body
jsonobjectrequireduserIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/users.getUserRolesGet User Roles
Authentication: Bearer JWT required
Request body
jsonobjectrequireduserIdstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
GET/api/trpc/users.getUsersGet Users
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequiredadvancedFiltersobjectoptionalfiltersobjectoptionalhidden_columnsstring[]optionaltenantIdstringoptionalsiteIdstringoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNamestringoptionallastNamestringoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionaltenantobjectoptionalsiteobjectoptionalrolesobject[]optionalfullNamestringoptionalroleNamesstringoptionalstatusstringoptionalisAdminbooleanoptionalprimaryRolestringoptionalpaginationobjectoptionalpageintegeroptionalper_pageintegeroptionaltotalintegeroptionaltotal_pagesintegeroptionalInput (JSON)
GET/api/trpc/users.listList
Authentication: Bearer JWT required
Request body
jsonobjectrequiredsearchstringoptionallimitnumberrequiredtenantIdstringoptionalsiteIdstringoptionalonlyAuthorsbooleanoptionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
idstringoptionalnamestringoptionalemailstringoptionalimageanyoptionalInput (JSON)
GET/api/trpc/users.listMyUsersList My Users
Authentication: Bearer JWT required
Request body
jsonobjectrequiredpagenumberrequiredper_pagenumberrequiredsearchstringoptionalsortstringoptionaladvancedSortsobject[]optionalfieldstringrequireddirectionenumrequiredadvancedFiltersobjectoptionalfiltersobjectoptionalhidden_columnsstring[]optionalResponses
200 Successful response — the `json` result (superjson-wrapped). Schema derived from a real response.
dataobject[]optionalidstringoptionalupdatedAtstringoptionalcreatedAtstringoptionalemailVerifiedstringoptionalblockedbooleanoptionalnamestringoptionalemailstringoptionalfirstNamestringoptionallastNamestringoptionaltitleanyoptionalpasswordstringoptionalphoneanyoptionalimageanyoptionaldataobjectoptionalresetTokenanyoptionalresetTokenExpiryanyoptionalemailVerificationTokenanyoptionalemailVerificationTokenExpiryanyoptionalsuperiorIdanyoptionalsiteIdstringoptionaltenantIdstringoptionalcanAccessReportsbooleanoptionalcanManageCashbooleanoptionalcanSupervisorOverridebooleanoptionalcanVoidTransactionsbooleanoptionalcurrentShiftStartanyoptionalemployeeNumberanyoptionalisClockedInbooleanoptionalmaxDiscountPercentintegeroptionalposPermissionsanyoptionalposPinanyoptionalposRolestringoptionaltenantobjectoptionalsiteobjectoptionalrolesobject[]optionalfullNamestringoptionalroleNamesstringoptionalstatusstringoptionalisAdminbooleanoptionalprimaryRolestringoptionalpaginationobjectoptionalpageintegeroptionalper_pageintegeroptionaltotalintegeroptionaltotal_pagesintegeroptionalInput (JSON)
POST/api/trpc/users.resetPasswordWithTokenReset Password With Token
Authentication: Bearer JWT required
Request body
jsonobjectrequiredtokenstringrequiredpasswordstringrequiredResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/users.sendPasswordResetEmailSend Password Reset Email
Authentication: Bearer JWT required
Request body
jsonobjectrequiredemailstring · emailrequiredtenantIdstring · uuidoptionalsiteIdstring · uuidoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/users.updateUserUpdate User
Authentication: Bearer JWT required
Request body
jsonobjectrequiredidstringrequirednamestringoptionalfirstNamestringoptionallastNamestringoptionalemailstring · emailoptionaltitlestringoptionalphonestringoptionalimagestringoptionalblockedbooleanoptionalemailVerifiedanyoptionalroleIdsstring[]optionaldataobjectoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)
POST/api/trpc/users.updateUserProfileUpdate User Profile
Authentication: Bearer JWT required
Request body
jsonobjectrequiredfirstNamestringrequiredlastNamestringrequiredphonestringoptionalemailstring · emailrequiredcompanyNamestringoptionaladdressstringoptionalbiostringoptionaltwitterUrlstringoptionallinkedinUrlstringoptionalwebsitestringoptionaluserIdstringoptionalResponses
200 Successful response (superjson-wrapped as { result: { data: { json: … } } }).
Input (JSON)